tigase.jaxmpp.core.client.xmpp.modules.adhoc

Class AdHocCommansModule

java.lang.Object

tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaModule<T>

tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaExtendableModule<tigase.jaxmpp.core.client.xmpp.stanzas.IQ>

tigase.jaxmpp.core.client.xmpp.modules.AbstractIQModule

tigase.jaxmpp.core.client.xmpp.modules.adhoc.AdHocCommansModule

All Implemented Interfaces:

tigase.jaxmpp.core.client.xmpp.modules.ContextAware, tigase.jaxmpp.core.client.xmpp.modules.extensions.ExtendableModule, tigase.jaxmpp.core.client.xmpp.modules.InitializingModule, tigase.jaxmpp.core.client.XmppModule

public class AdHocCommansModule
extends tigase.jaxmpp.core.client.xmpp.modules.AbstractIQModule

Module to handle ad-hoc commands.

Author:

bmalkow

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdHocCommansModule.AdHocCommansAsyncCallback Callback to handle result of ad-hoc command.

Field Summary

Fields

Modifier and Type	Field and Description
static tigase.jaxmpp.core.client.criteria.Criteria	CRIT

Fields inherited from class tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaModule

context, log

Constructor Summary

Constructors

Constructor and Description
AdHocCommansModule()

Method Summary

Modifier and Type	Method and Description
void	beforeRegister()
void	execute(tigase.jaxmpp.core.client.JID toJID, String node, Action action, tigase.jaxmpp.core.client.xmpp.forms.JabberDataElement data, tigase.jaxmpp.core.client.AsyncCallback asyncCallback) Calls ad-hoc command on remote resource.
protected String[]	getCommandFeatures(tigase.jaxmpp.core.client.SessionObject sessionObject, tigase.jaxmpp.core.client.xmpp.stanzas.IQ requestStanza, String commandNodeName)
protected tigase.jaxmpp.core.client.xmpp.modules.disco.DiscoveryModule.Identity	getCommandIdentity(tigase.jaxmpp.core.client.SessionObject sessionObject, tigase.jaxmpp.core.client.xmpp.stanzas.IQ requestStanza, String commandNodeName)
tigase.jaxmpp.core.client.criteria.Criteria	getCriteria()
String[]	getFeatures()
protected tigase.jaxmpp.core.client.xmpp.modules.disco.DiscoveryModule.Identity	getModuleIdentity(tigase.jaxmpp.core.client.SessionObject sessionObject, tigase.jaxmpp.core.client.xmpp.stanzas.IQ requestStanza, String node)
protected tigase.jaxmpp.core.client.xmpp.modules.disco.DiscoveryModule.Item[]	getModuleItems(tigase.jaxmpp.core.client.SessionObject sessionObject, tigase.jaxmpp.core.client.xmpp.stanzas.IQ requestStanza, String node)
protected void	processGet(tigase.jaxmpp.core.client.xmpp.stanzas.IQ element)
protected void	processSet(tigase.jaxmpp.core.client.xmpp.stanzas.IQ element)
void	register(AdHocCommand command) Registers new ad-hoc command.
void	unregister(AdHocCommand command)

Methods inherited from class tigase.jaxmpp.core.client.xmpp.modules.AbstractIQModule

process

Methods inherited from class tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaExtendableModule

addExtension, getExtensionChain, getFeaturesWithExtensions, removeExtension, write, write, write

Methods inherited from class tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaModule

afterRegister, beforeUnregister, fireEvent, getFirstChild, process, setContext

Methods inherited from class java.lang.Object

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

Field Detail

CRIT

public static final tigase.jaxmpp.core.client.criteria.Criteria CRIT

Constructor Detail

AdHocCommansModule

public AdHocCommansModule()

Method Detail

beforeRegister

public void beforeRegister()

Specified by:

beforeRegister in interface tigase.jaxmpp.core.client.xmpp.modules.InitializingModule

Overrides:

beforeRegister in class tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaModule<tigase.jaxmpp.core.client.xmpp.stanzas.IQ>

execute

public void execute(tigase.jaxmpp.core.client.JID toJID,
                    String node,
                    Action action,
                    tigase.jaxmpp.core.client.xmpp.forms.JabberDataElement data,
                    tigase.jaxmpp.core.client.AsyncCallback asyncCallback)
             throws tigase.jaxmpp.core.client.exceptions.JaxmppException

Calls ad-hoc command on remote resource.

Parameters:

toJID - remote ad-hoc command executor.

node - node

action - action

data - Data Form

asyncCallback - callback

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException

getCommandFeatures

protected String[] getCommandFeatures(tigase.jaxmpp.core.client.SessionObject sessionObject,
                                      tigase.jaxmpp.core.client.xmpp.stanzas.IQ requestStanza,
                                      String commandNodeName)
                               throws tigase.jaxmpp.core.client.exceptions.JaxmppException

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException

getCommandIdentity

protected tigase.jaxmpp.core.client.xmpp.modules.disco.DiscoveryModule.Identity getCommandIdentity(tigase.jaxmpp.core.client.SessionObject sessionObject,
                                                                                                   tigase.jaxmpp.core.client.xmpp.stanzas.IQ requestStanza,
                                                                                                   String commandNodeName)
                                                                                            throws tigase.jaxmpp.core.client.exceptions.JaxmppException

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException

getCriteria

public tigase.jaxmpp.core.client.criteria.Criteria getCriteria()

getFeatures

public String[] getFeatures()

getModuleIdentity

protected tigase.jaxmpp.core.client.xmpp.modules.disco.DiscoveryModule.Identity getModuleIdentity(tigase.jaxmpp.core.client.SessionObject sessionObject,
                                                                                                  tigase.jaxmpp.core.client.xmpp.stanzas.IQ requestStanza,
                                                                                                  String node)

getModuleItems

protected tigase.jaxmpp.core.client.xmpp.modules.disco.DiscoveryModule.Item[] getModuleItems(tigase.jaxmpp.core.client.SessionObject sessionObject,
                                                                                             tigase.jaxmpp.core.client.xmpp.stanzas.IQ requestStanza,
                                                                                             String node)
                                                                                      throws tigase.jaxmpp.core.client.xml.XMLException

Throws:

tigase.jaxmpp.core.client.xml.XMLException

processGet

protected void processGet(tigase.jaxmpp.core.client.xmpp.stanzas.IQ element)
                   throws tigase.jaxmpp.core.client.XMPPException,
                          tigase.jaxmpp.core.client.xml.XMLException,
                          tigase.jaxmpp.core.client.exceptions.JaxmppException

Specified by:

processGet in class tigase.jaxmpp.core.client.xmpp.modules.AbstractIQModule

Throws:

tigase.jaxmpp.core.client.XMPPException

tigase.jaxmpp.core.client.xml.XMLException

tigase.jaxmpp.core.client.exceptions.JaxmppException

processSet

protected void processSet(tigase.jaxmpp.core.client.xmpp.stanzas.IQ element)
                   throws tigase.jaxmpp.core.client.XMPPException,
                          tigase.jaxmpp.core.client.xml.XMLException,
                          tigase.jaxmpp.core.client.exceptions.JaxmppException

Specified by:

processSet in class tigase.jaxmpp.core.client.xmpp.modules.AbstractIQModule

Throws:

tigase.jaxmpp.core.client.XMPPException

tigase.jaxmpp.core.client.xml.XMLException

tigase.jaxmpp.core.client.exceptions.JaxmppException

register

public void register(AdHocCommand command)

Registers new ad-hoc command.

Parameters:

command - command to register

unregister

public void unregister(AdHocCommand command)