Package tigase.component.modules.impl

Class AdHocCommandModule

java.lang.Object

tigase.component.modules.AbstractModule

tigase.component.modules.impl.AdHocCommandModule

All Implemented Interfaces:

Module, Initializable

Direct Known Subclasses:

AdHocCommandMonitorModule

@Bean(name="commands",
      active=true)
public class AdHocCommandModule
extends AbstractModule
implements Initializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AdHocCommandModule.ScriptCommandProcessor

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String[]	COMMAND_PATH
protected AdHocCommandManager	commandsManager
protected static final Criteria	CRIT
static final String	ID
protected AdHocCommandModule.ScriptCommandProcessor	scriptProcessor
static final String	XMLNS

Fields inherited from class tigase.component.modules.AbstractModule

eventBus, log, writer

Fields inherited from interface tigase.component.modules.Module

EMPTY_FEATURES

Constructor Summary

Constructors

Constructor	Description
AdHocCommandModule()

Method Summary

Modifier and Type	Method	Description
void	addCommandListItemsElements(String node, JID stanzaTo, JID stanzaFrom, Consumer<tigase.xml.Element> collector)
List<tigase.xml.Element>	getCommandListItems(JID senderJid, JID toJid)
AdHocCommandManager	getCommandsManager()
String[]	getFeatures()	Returns XMPP features offered by module.
Criteria	getModuleCriteria()	Returns critera used by Component to select module to handle incoming stanza.
List<tigase.xml.Element>	getScriptItems(String node, JID stanzaTo, JID stanzaFrom)
AdHocCommandModule.ScriptCommandProcessor	getScriptProcessor()
void	initialize()	Method will be called, when bean will be created, configured and ready to use.
void	process(Packet packet)	Process incoming stanza.
protected void	processScriptAdHoc(Packet packet)
void	register(AdHocCommand command)
void	setCommandsManager(AdHocCommandManager commandsManager)
void	setScriptProcessor(AdHocCommandModule.ScriptCommandProcessor scriptProcessor)

Methods inherited from class tigase.component.modules.AbstractModule

fireEvent, getEventBus, getWriter, setEventBus, setWriter, write, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface tigase.component.modules.Module

canHandle

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

XMLNS

public static final String XMLNS

See Also:

• Constant Field Values

COMMAND_PATH

protected static final String[] COMMAND_PATH

CRIT

protected static final Criteria CRIT

commandsManager

@Inject(nullAllowed=false)
protected AdHocCommandManager commandsManager

scriptProcessor

@Inject(nullAllowed=false)
protected AdHocCommandModule.ScriptCommandProcessor scriptProcessor

Constructor Details

AdHocCommandModule

public AdHocCommandModule()

Method Details

getCommandListItems

public List<tigase.xml.Element> getCommandListItems(JID senderJid,
 JID toJid)

getCommandsManager

public AdHocCommandManager getCommandsManager()

setCommandsManager

public void setCommandsManager(AdHocCommandManager commandsManager)

getFeatures

public String[] getFeatures()

Description copied from interface: Module

Returns XMPP features offered by module. Features will be returned by Service Discovery.

Specified by:

getFeatures in interface Module

Returns:

array of features or null.

getModuleCriteria

public Criteria getModuleCriteria()

Description copied from interface: Module

Returns critera used by Component to select module to handle incoming stanza.

Specified by:

getModuleCriteria in interface Module

Returns:

criteria of selecting module.

getScriptItems

public List<tigase.xml.Element> getScriptItems(String node,
 JID stanzaTo,
 JID stanzaFrom)

addCommandListItemsElements

public void addCommandListItemsElements(String node,
 JID stanzaTo,
 JID stanzaFrom,
 Consumer<tigase.xml.Element> collector)

getScriptProcessor

public AdHocCommandModule.ScriptCommandProcessor getScriptProcessor()

setScriptProcessor

public void setScriptProcessor(AdHocCommandModule.ScriptCommandProcessor scriptProcessor)

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)
             throws ComponentException

Description copied from interface: Module

Process incoming stanza.

Specified by:

process in interface Module

Parameters:

packet - received stanza.

Throws:

ComponentException - if stanza can't be processed correctly. ComponentException is converted to error stanza and returned to stanza sender.

register

public void register(AdHocCommand command)

processScriptAdHoc

protected void processScriptAdHoc(Packet packet)