tigase.server.sreceiver
Class AbstractReceiverTask

java.lang.Object
  tigase.server.sreceiver.AbstractReceiverTask

All Implemented Interfaces:

ReceiverTaskIfc

Direct Known Subclasses:

RepoRosterTask, TesterTask

public abstract class AbstractReceiverTask
extends java.lang.Object
implements ReceiverTaskIfc

Describe class AbstractReceiverTask here. Created: Fri May 11 08:34:04 2007

Version:

$Rev: 1292 $

Author:

Artur Hefczyc

Constructor Summary

AbstractReceiverTask()

Method Summary

void	addNewSubscribers(java.util.Queue<Packet> results, java.lang.String... new_subscr) Describe addNewSubscribers method here.
protected boolean	addOutPacket(Packet packet)
void	addToRoster(RosterItem ri)
RosterItem	addToRoster(java.lang.String jid)
void	destroy(java.util.Queue<Packet> results) destroy method is called when the task is being permanently deleted.
java.util.Map<java.lang.String,PropertyItem>	getDefaultParams() getDefaultParams method return task instance default configuration parameters.
java.lang.String	getDescription() Describe getDescription method here.
ReceiverTaskIfc	getInstance() Describe getInstance method here.
java.lang.String	getJID() Describe getJID method here.
java.util.Map<java.lang.String,PropertyItem>	getParams() Describe getParams method here.
java.util.Map<java.lang.String,RosterItem>	getRoster() getRoster returns roster that is a collection with all users subscribed to this task.
RosterItem	getRosterItem(java.lang.String jid)
java.util.List<StatRecord>	getStats() getStats method retorns list of statistics records.
void	init(java.util.Queue<Packet> results) init method initializes task.
boolean	isAdmin(java.lang.String jid) isAdmin method checks whether user given as parameter is one of defined admins.
boolean	isAllowedToPost(java.lang.String buddy)
boolean	isAllowedToSubscribe(java.lang.String buddy)
protected void	processMessage(Packet packet, java.util.Queue<Packet> results)
void	processPacket(Packet packet, java.util.Queue<Packet> results) Describe processPacket method here.
RosterItem	removeFromRoster(java.lang.String jid)
void	removeSubscribers(java.util.Queue<Packet> results, java.lang.String... subscr)
void	setJID(java.lang.String jid) Describe setJID method here.
void	setParams(java.util.Map<java.lang.String,java.lang.Object> map) Describe setParams method here.
void	setRosterItemAdmin(RosterItem ri, boolean admin)
void	setRosterItemModerationAccepted(RosterItem ri, boolean accepted)
void	setRosterItemOnline(RosterItem ri, boolean online)
void	setRosterItemOwner(RosterItem ri, boolean owner)
void	setRosterItemSubscribed(RosterItem ri, boolean subscribed)
void	setStanzaReceiver(StanzaReceiverIfc srecv)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface tigase.server.sreceiver.ReceiverTaskIfc

getHelp, getType

Constructor Detail

AbstractReceiverTask

public AbstractReceiverTask()

Method Detail

setStanzaReceiver

public void setStanzaReceiver(StanzaReceiverIfc srecv)

Specified by:

setStanzaReceiver in interface ReceiverTaskIfc

addOutPacket

protected boolean addOutPacket(Packet packet)

getInstance

public ReceiverTaskIfc getInstance()

Describe getInstance method here.

Specified by:

getInstance in interface ReceiverTaskIfc

Returns:

a ReceiverTaskIfc value

setJID

public void setJID(java.lang.String jid)

Describe setJID method here.

Specified by:

setJID in interface ReceiverTaskIfc

Parameters:

jid - a String value

getJID

public java.lang.String getJID()

Describe getJID method here.

Specified by:

getJID in interface ReceiverTaskIfc

Returns:

a String value

See Also:

ReceiverTaskIfc.setJID(String)

getDescription

public java.lang.String getDescription()

Describe getDescription method here.

Specified by:

getDescription in interface ReceiverTaskIfc

Returns:

a String value

See Also:

#DESCRIPTION_PROP_KEY

isAllowedToSubscribe

public boolean isAllowedToSubscribe(java.lang.String buddy)

isAllowedToPost

public boolean isAllowedToPost(java.lang.String buddy)

addToRoster

public void addToRoster(RosterItem ri)

addToRoster

public RosterItem addToRoster(java.lang.String jid)

removeFromRoster

public RosterItem removeFromRoster(java.lang.String jid)

getRosterItem

public RosterItem getRosterItem(java.lang.String jid)

setRosterItemOnline

public void setRosterItemOnline(RosterItem ri,
                                boolean online)

setRosterItemAdmin

public void setRosterItemAdmin(RosterItem ri,
                               boolean admin)

setRosterItemOwner

public void setRosterItemOwner(RosterItem ri,
                               boolean owner)

setRosterItemSubscribed

public void setRosterItemSubscribed(RosterItem ri,
                                    boolean subscribed)

setRosterItemModerationAccepted

public void setRosterItemModerationAccepted(RosterItem ri,
                                            boolean accepted)

Specified by:

setRosterItemModerationAccepted in interface ReceiverTaskIfc

addNewSubscribers

public void addNewSubscribers(java.util.Queue<Packet> results,
                              java.lang.String... new_subscr)

Describe addNewSubscribers method here.

Parameters:

new_subscr - a String[] value

removeSubscribers

public void removeSubscribers(java.util.Queue<Packet> results,
                              java.lang.String... subscr)

Specified by:

removeSubscribers in interface ReceiverTaskIfc

setParams

public void setParams(java.util.Map<java.lang.String,java.lang.Object> map)

Describe setParams method here.

Specified by:

setParams in interface ReceiverTaskIfc

Parameters:

map - a Map value

getParams

public java.util.Map<java.lang.String,PropertyItem> getParams()

Describe getParams method here.

Specified by:

getParams in interface ReceiverTaskIfc

Returns:

a Map value

See Also:

ReceiverTaskIfc.setParams(Map)

getDefaultParams

public java.util.Map<java.lang.String,PropertyItem> getDefaultParams()

Description copied from interface: ReceiverTaskIfc

getDefaultParams method return task instance default configuration parameters. The map should contains all possible parameters accepted by the task in setParams method. Values may be empty but may not be null. All of parameters should be converted to String type to make it possible to display them in ad-hoc command x-form. Parameters then should be converted back to whatever format is needed when passed back in setParams method. For more detailed information about configuration parameters please refer to setParams method.

Specified by:

getDefaultParams in interface ReceiverTaskIfc

Returns:

a Map value with task instance configuration parameters.

See Also:

ReceiverTaskIfc.setParams(Map)

init

public void init(java.util.Queue<Packet> results)

Description copied from interface: ReceiverTaskIfc

init method initializes task. It allows also for a task to send initial stanzas to user like available presence or any other stanza which does make sense to send at startup time.

Specified by:

init in interface ReceiverTaskIfc

Parameters:

results - a Queue is a collection of result packets to send out.

destroy

public void destroy(java.util.Queue<Packet> results)

Description copied from interface: ReceiverTaskIfc

destroy method is called when the task is being permanently deleted. The method should take care of sending notification to all subscribed users that the task is being deleted and should also clear databases from all task data.

Specified by:

destroy in interface ReceiverTaskIfc

Parameters:

results - a Queue value with all packets needed to send upon task deletion.

processPacket

public void processPacket(Packet packet,
                          java.util.Queue<Packet> results)

Describe processPacket method here.

Specified by:

processPacket in interface ReceiverTaskIfc

Parameters:

packet - a Packet value

results - a Queue value

processMessage

protected void processMessage(Packet packet,
                              java.util.Queue<Packet> results)

getStats

public java.util.List<StatRecord> getStats()

Description copied from interface: ReceiverTaskIfc

getStats method retorns list of statistics records. Have a look at StatRecord description for more details.

Specified by:

getStats in interface ReceiverTaskIfc

Returns:

a List of statistics records.

See Also:

StatRecord

isAdmin

public boolean isAdmin(java.lang.String jid)

Description copied from interface: ReceiverTaskIfc

isAdmin method checks whether user given as parameter is one of defined admins. If user is the task owner it is also considered to be task administrator.

Specified by:

isAdmin in interface ReceiverTaskIfc

Parameters:

jid - a String value of user JID.

Returns:

a boolean value true if given user is either task admin or task owner.

getRoster

public java.util.Map<java.lang.String,RosterItem> getRoster()

Description copied from interface: ReceiverTaskIfc

getRoster returns roster that is a collection with all users subscribed to this task.

Specified by:

getRoster in interface ReceiverTaskIfc

Returns:

a Map value with all user subscribed to this task.