Package tigase.xmpp.impl

Class MIXProcessor

java.lang.Object

tigase.xmpp.XMPPProcessor

tigase.xmpp.impl.annotation.AnnotatedXMPPProcessor

tigase.xmpp.impl.MIXProcessor

All Implemented Interfaces:

Comparable<XMPPImplIfc>, XMPPImplIfc, XMPPProcessorConcurrencyAwareIfc, XMPPProcessorIfc

@Bean(name="urn:xmpp:mix:pam:2",
      parent=SessionManager.class,
      active=true)
public class MIXProcessor
extends AnnotatedXMPPProcessor
implements XMPPProcessorIfc

Field Summary

Fields

Modifier and Type	Field	Description
static final 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
MIXProcessor()

Method Summary

Modifier and Type	Method	Description
Authorization	canHandle(Packet packet, XMPPResourceConnection conn)	By default the method uses XMPPImplIfc.supElementNamePaths() and XMPPImplIfc.supTypes() method results to determine whether the plugin would process given packet.
protected String	generateId(BareJID channel, String packetID)
void	process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings)
protected void	sendToChannel(BareJID userJID, BareJID channel, String id, Element actionEl, Consumer<Packet> writer)
protected void	sendToUser(BareJID userJID, String resource, JID connectionJID, StanzaType stanzaType, String id, Element actionEl, Element errorEl, Consumer<Packet> writer)

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

id, supDiscoFeatures, supElementNamePaths, supNamespaces, supStreamFeatures, supTypes

Methods inherited from class tigase.xmpp.XMPPProcessor

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

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

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

Constructor Details

MIXProcessor

public MIXProcessor()

Method Details

canHandle

public Authorization canHandle(Packet packet,
 XMPPResourceConnection conn)

Description copied from interface: XMPPImplIfc

By default the method uses XMPPImplIfc.supElementNamePaths() and XMPPImplIfc.supTypes() method results to determine whether the plugin would process given packet. However, a plugin can implement own logic to determine packet processing capabilities or conditions. Please note, this method must be very fast and efficient. No I/O processing is recommended as it may impact performance of the whole system.

Specified by:

canHandle in interface XMPPImplIfc

Overrides:

canHandle in class XMPPProcessor

Parameters:

packet - is a Packet for processing.

conn - is a user session object or null.

Returns:

returns Authorization enum value or null. Null means the plugin is simply not processing the packet. Authorization.AUTHORIZED means the plugin can process the packet, any other Authorization enum value means an error which has to be returned to the sender.

process

public void process(Packet packet,
 XMPPResourceConnection session,
 NonAuthUserRepository repo,
 Queue<Packet> results,
 Map<String,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

sendToChannel

protected void sendToChannel(BareJID userJID,
 BareJID channel,
 String id,
 Element actionEl,
 Consumer<Packet> writer)

sendToUser

protected void sendToUser(BareJID userJID,
 String resource,
 JID connectionJID,
 StanzaType stanzaType,
 String id,
 Element actionEl,
 Element errorEl,
 Consumer<Packet> writer)

generateId

protected String generateId(BareJID channel,
 String packetID)
                     throws XMPPProcessorException

Throws:

XMPPProcessorException