tigase.server.sreceiver.sysmon
Class SystemMonitorTask

java.lang.Object
  tigase.server.sreceiver.AbstractReceiverTask
      tigase.server.sreceiver.RepoRosterTask
          tigase.server.sreceiver.sysmon.SystemMonitorTask

All Implemented Interfaces:

ReceiverTaskIfc

public class SystemMonitorTask
extends RepoRosterTask

Created: Dec 6, 2008 8:12:41 PM

Version:

$Rev: 1300 $

Author:

Artur Hefczyc

Constructor Summary

SystemMonitorTask()

Method Summary

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	getHelp() getHelp method returns task help information.
java.util.Map<java.lang.String,PropertyItem>	getParams() Describe getParams method here.
java.lang.String	getType() getType method returns the task type name.
void	init(java.util.Queue<Packet> results) init method initializes task.
protected void	processMessage(Packet packet, java.util.Queue<Packet> results)
protected void	sendPacketOut(Packet input)
protected void	sendPacketsOut(java.util.Queue<Packet> input)
void	setParams(java.util.Map<java.lang.String,java.lang.Object> map) Describe setParams method here.

Methods inherited from class tigase.server.sreceiver.RepoRosterTask

addToRoster, loadRoster, removeFromRoster, setRosterItemAdmin, setRosterItemModerationAccepted, setRosterItemOwner, setRosterItemSubscribed

Methods inherited from class tigase.server.sreceiver.AbstractReceiverTask

addNewSubscribers, addOutPacket, addToRoster, getDescription, getInstance, getJID, getRoster, getRosterItem, getStats, isAdmin, isAllowedToPost, isAllowedToSubscribe, processPacket, removeSubscribers, setJID, setRosterItemOnline, setStanzaReceiver

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemMonitorTask

public SystemMonitorTask()

Method Detail

sendPacketsOut

protected void sendPacketsOut(java.util.Queue<Packet> input)

sendPacketOut

protected void sendPacketOut(Packet input)

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

Overrides:

init in class AbstractReceiverTask

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

Overrides:

destroy in class RepoRosterTask

Parameters:

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

getType

public java.lang.String getType()

Description copied from interface: ReceiverTaskIfc

getType method returns the task type name. This name is displayed on the list of all tasks available for creation. This is not a nick name of created task this is something more like "Drupal forums connector" or "Interest group". Like a Java class name is unique in JVM the task name must be also inique for StanzaReceiver. Look at task nick name for more details.

Returns:

a String value of the task name.

getHelp

public java.lang.String getHelp()

Description copied from interface: ReceiverTaskIfc

getHelp method returns task help information. This general information about tasks abilties so when the user selects task for creation he might know what the task is about. This is more like class description rather then instance description.

Returns:

a String value of task class help information.

setParams

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

Description copied from class: AbstractReceiverTask

Describe setParams method here.

Specified by:

setParams in interface ReceiverTaskIfc

Overrides:

setParams in class RepoRosterTask

Parameters:

map - a Map value

getParams

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

Description copied from class: AbstractReceiverTask

Describe getParams method here.

Specified by:

getParams in interface ReceiverTaskIfc

Overrides:

getParams in class AbstractReceiverTask

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

Overrides:

getDefaultParams in class AbstractReceiverTask

Returns:

a Map value with task instance configuration parameters.

See Also:

ReceiverTaskIfc.setParams(Map)

processMessage

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

Overrides:

processMessage in class AbstractReceiverTask