Package tigase.server
Class Iq
java.lang.Object
tigase.server.Packet
tigase.server.Iq
Created: Dec 31, 2009 8:43:21 PM
- Author:
- Artur Hefczyc
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final String[]static final String[]static final String[]static final String[]static final String[]static final String[]static final String[]static final StringFields inherited from class tigase.server.Packet
CLIENT_XMLNS, elem, ERROR_NS, FROM_ATT, FULL_DEBUG, ID_ATT, PERM_ATT, PRIORITY_ATT, TO_ATT, TYPE_ATT, XMLNS_ATT -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncommandResult(Command.DataType cmd_type) static PacketcommandResultForm(Iq packet) static PacketcommandResultResult(Iq packet) static IqcreateRosterPacket(String iq_type, String iq_id, JID from, JID to, JID item_jid, String item_name, String[] item_groups, String subscription, String item_type) Method creates a newPacketinstance orIqinstance more specificly with a roster entry content.The method always returns NULL.protected String[]A convenience method to provide XML path asString[]to error element.booleanThe method checks whether the stanza enclosed by thisPacketinstance is an ad-hoc command.booleanA convenience method which checks whether the enclosed stanza is a service discovery query.Methods inherited from class tigase.server.Packet
copyElementOnly, debug, elemToString, elemToStringSecure, errorResult, getAttributeStaticStr, getAttributeStaticStr, getElemCData, getElemCDataStaticStr, getElemChild, getElemChild, getElemChildrenStaticStr, getElement, getElemName, getErrorCondition, getFrom, getPacketFrom, getPacketTo, getPermissions, getPriority, getProcessorsIds, getServerAuthorisedStanzaFrom, getSkippedProcessorsIds, getStableId, getStanzaFrom, getStanzaId, getStanzaTo, getTo, getType, getXMLNS, initVars, initVars, isElement, isRouted, isXMLNSStaticStr, notProcessedBy, okResult, okResult, packetInstance, packetInstance, packetInstance, packRouted, processedBy, setPacketFrom, setPacketTo, setPermissions, setPriority, setServerAuthorisedStanzaFrom, setStableId, setXMLNS, swapFromTo, swapFromTo, swapStanzaFromTo, swapStanzaFromTo, toString, toString, toStringFull, toStringSecure, unpackRouted, wasProcessed, wasProcessedBy, wasSkipped
-
Field Details
-
ELEM_NAME
- See Also:
-
QUERY_NAME
- See Also:
-
IQ_QUERY_PATH
-
IQ_PUBSUB_PATH
-
IQ_ERROR_PATH
-
IQ_COMMAND_PATH
-
IQ_CHAT_PATH
-
IQ_BIND_RESOURCE_PATH
-
IQ_BIND_PATH
-
-
Constructor Details
-
Iq
- Throws:
TigaseStringprepException
-
Iq
-
-
Method Details
-
commandResultForm
- Throws:
TigaseStringprepException
-
commandResultResult
- Throws:
TigaseStringprepException
-
createRosterPacket
public static Iq createRosterPacket(String iq_type, String iq_id, JID from, JID to, JID item_jid, String item_name, String[] item_groups, String subscription, String item_type) Method creates a newPacketinstance orIqinstance more specificly with a roster entry content. TODO: Remove dependency on RosterAbstract class, possibly move the method again to more proper location but it needs to be accessible from all parts of the application.- Parameters:
iq_type- is aStringvalue with the stanza type: 'set', 'get', 'result'.iq_id- is aStringvalue with the stanza unique id.from- is aJIDinstance with the packet source address.to- is aJIDinstance with the packet destination address.item_jid- is aJIDinstance with the roster item JID, note in most cases the jid should not have a resource part, but this method does not cut it off. This is because there are cases when we want to have a resource part in the roster item.item_name- is aStringvakue with the roster item name.item_groups- is aString[]array with all groups the item belongs to.subscription- is aStringinstance with the item subscription state.item_type- is aStringof the user item type. This isnullin most cases as this is not part of the XMPP RFC. Some deployments needs some extra information about the roster item type though.- Returns:
- a new
Packetinstance orIqinstance more specificly with a roster entry content.
-
commandResult
-
getCommand
Description copied from class:PacketThe method always returns NULL. It is overwritten in theIqclass where it returns a command identifier if theiqstanza represents an ad-hoc command. It is provided here is a convenience so the developer does not have to cast the packet to IQ before retrieving the command id.- Overrides:
getCommandin classPacket- Returns:
- the method always returns a NULL.
-
getIQChildName
-
getIQXMLNS
-
getStrCommand
-
isCommand
public boolean isCommand()Description copied from class:PacketThe method checks whether the stanza enclosed by thisPacketinstance is an ad-hoc command. This is a generic method which in fact always returnsfalse. It is overwritten in theIqclass where the real checking is performed. This class has been provided as a convenience method to perform the check without a need for casting thePacketinstance to theIqclass. -
isServiceDisco
public boolean isServiceDisco()Description copied from class:PacketA convenience method which checks whether the enclosed stanza is a service discovery query. This is a generic method which in fact always returnsfalse. It is overwritten in theIqclass where the real checking is performed. This class has been provided as a convenience method to perform the check without a need for casting thePacketinstance to theIqclass.- Overrides:
isServiceDiscoin classPacket- Returns:
- a
booleanvaluetrueif the stanza is a a service discovery query andfalseotherwise.
-
getElNameErrorPath
Description copied from class:PacketA convenience method to provide XML path asString[]to error element. This method should be override by all classes extending this class.- Overrides:
getElNameErrorPathin classPacket- Returns:
- XML path to error element.
-