Package tigase.xmpp.impl

Class MotdProcessor

java.lang.Object

tigase.xmpp.XMPPProcessor

tigase.xmpp.impl.annotation.AnnotatedXMPPProcessor

tigase.xmpp.impl.MotdProcessor

All Implemented Interfaces:

java.lang.Comparable<XMPPImplIfc>, Initializable, UnregisterAware, XMPPImplIfc, XMPPProcessorConcurrencyAwareIfc, XMPPProcessorIfc

@Bean(name="motd",
      parent=SessionManager.class,
      active=false)
public class MotdProcessor
extends AnnotatedXMPPProcessor
implements XMPPProcessorIfc, Initializable, UnregisterAware

Created by andrzej on 10.12.2016.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MotdProcessor.MotdUpdatedEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	ID

Fields inherited from class tigase.xmpp.XMPPProcessor

ALL_NAMES, ALL_PATHS, cmpInfo

Fields inherited from interface tigase.xmpp.XMPPImplIfc

CLIENT_XMLNS

Constructor Summary

Constructors

Constructor	Description
MotdProcessor()

Method Summary

Modifier and Type	Method	Description
void	beforeUnregister()	Method called before bean unregister.
java.lang.String	getMotd()
void	initialize()	Method will be called, when bean will be created, configured and ready to use.
void	onMotdChanged(MotdProcessor.MotdUpdatedEvent event)
void	process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, java.util.Queue<Packet> results, java.util.Map<java.lang.String,java.lang.Object> settings)
void	setMotd(java.lang.String motd)

Methods inherited from class tigase.xmpp.impl.annotation.AnnotatedXMPPProcessor

id, supDiscoFeatures, supElementNamePaths, supNamespaces, supStreamFeatures, supTypes

Methods inherited from class tigase.xmpp.XMPPProcessor

canHandle, compareTo, concurrentQueuesNo, getComponentInfo, getInstance, getQueueSize, getStatistics, getThreadsNo, init, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface tigase.xmpp.XMPPImplIfc

canHandle, concurrentQueuesNo, getComponentInfo, getStatistics, id, init, supDiscoFeatures, supElementNamePaths, supNamespaces, supStreamFeatures, supTypes

Field Detail

ID

protected static final java.lang.String ID

See Also:

Constant Field Values

Constructor Detail

MotdProcessor

public MotdProcessor()

Method Detail

beforeUnregister

public void beforeUnregister()

Description copied from interface: UnregisterAware

Method called before bean unregister.

Specified by:

beforeUnregister in interface UnregisterAware

initialize

public void initialize()

Description copied from interface: Initializable

Method will be called, when bean will be created, configured and ready to use.

Specified by:

initialize in interface Initializable

process

public void process(Packet packet,
                    XMPPResourceConnection session,
                    NonAuthUserRepository repo,
                    java.util.Queue<Packet> results,
                    java.util.Map<java.lang.String,java.lang.Object> settings)
             throws XMPPException

Specified by:

process in interface XMPPProcessorIfc

Parameters:

packet - packet is which being processed. This parameter may never be null. Even though this is not immutable object it mustn't be altered. None of it's fields or attributes can be changed during processing.

session - user session which keeps all the user session data and also gives an access to the user's repository data. It allows for storing information in a permanent storage or in memory only during the live of the online session. This parameter can be null if there is no online user session at the time of the packet processing.

repo - this is a user data storage which is normally used when the user session (parameter above) is null. This is repository allows for a very restricted access only. It allows for storing some user private data (doesn't allow overwriting existing data) like messages for offline users and it also allows for reading user public data like VCard.

results - this a collection with packets which have been generated as input packet processing results. Regardless a response to a user request is sent or the packet is forwarded to it's destination it is always required that a copy of the input packet is created and stored in the results queue.

settings - this map keeps plugin specific settings loaded from the Tigase server configuration. In most cases it is unused, however if the plugin needs to access an external database that this is a way to pass database connection string to the plugin.

Throws:

XMPPException

onMotdChanged

@HandleEvent
public void onMotdChanged(MotdProcessor.MotdUpdatedEvent event)

getMotd

public java.lang.String getMotd()

setMotd

public void setMotd(java.lang.String motd)
             throws TigaseDBException

Throws:

TigaseDBException