|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<Command>
tigase.server.Command
public enum Command
Helper enum to make it easier to operate on packets with ad-hoc commands. It allows to create a packet with command, add and retrieve command data field values, set actions and so on. It contains predefined set of commands used internally by the Tigase server and also 'OTHER' command which refers all other not predefined commands. Most of the implementation details, constants and parameters is based on the XEP-0050 for ad-hoc commands protocol. Please refer to the XEP for more details. Created: Thu Feb 9 20:52:02 2006
Nested Class Summary | |
---|---|
static class |
Command.Action
Ad-hoc command actions ad defined in the XEP-0050. |
static class |
Command.DataType
Data form-types as defined in the XEP-0050. |
static class |
Command.Status
Ad-hoc command statuses as defined in the XEP-0050. |
Enum Constant Summary | |
---|---|
BROADCAST_TO_ALL
Command used to set a broadcast message to all registered local users. |
|
BROADCAST_TO_ONLINE
Command used to set a broadcast message to all online users. |
|
CHECK_USER_CONNECTION
Sends a command from SM to the connection holder to confirm whether the connection is still active. |
|
CLOSE
Command sent from the session manager to a client manager to close the client connection. |
|
GETDISCO
This is deprecated command sent between components in the Tigase server for service discovery handling. |
|
GETFEATURES
Command sent between a connection manager and the session manager to retrieve stream features. |
|
GETSTATS
Command used by the StatisticsCollector to provide server statistics through ad-hoc command. |
|
OTHER
Identifies all other, not predefined commands. |
|
REDIRECT
Command used to redirect packets from a connection manager to other than default session manager. |
|
STARTTLS
Command sent from the session manager to a connection manager to start TLS handshaking over the client connection. |
|
STARTZLIB
Command sent from the session manager to a connection manager to start zlib compression on the connection stream. |
|
STREAM_CLOSED
Command sent from a connection manager to the session manager when a connection or stream has been closed. |
|
STREAM_CLOSED_UPDATE
|
|
STREAM_OPENED
Command sent from a connection manager to the session manager when a new stream from the client has been opened. |
|
USER_STATUS
Command sent to the session manager from an external entity to activate a user session with the connection end-point at the given address. |
|
VHOSTS_RELOAD
Command sent to the VHostManager to reload virtual hosts from the database. |
|
VHOSTS_REMOVE
Command sent to the VHostManager to remove existing virtual host. |
|
VHOSTS_UPDATE
Command sent to the VHostManager to add or update existing virtual host. |
Field Summary | |
---|---|
static String |
COMMAND_EL
|
static String |
XMLNS
|
Method Summary | |
---|---|
static void |
addAction(Packet packet,
Command.Action action)
|
static void |
addCheckBoxField(Packet packet,
String f_name,
boolean f_value)
|
static void |
addFieldMultiValue(Packet packet,
String f_name,
List<String> f_value)
A simple method for adding a multi-line (text-multi) data field to the command data form. |
static void |
addFieldValue(Packet packet,
String f_name,
String f_value)
Simple method for adding a new field to the command data form. |
static void |
addFieldValue(Packet packet,
String f_name,
String[] f_values,
String label,
String[] labels,
String[] options)
This method allows to add a new multi-option-select-many data field to the command data form. |
static void |
addFieldValue(Packet packet,
String f_name,
String f_value,
String type)
|
static void |
addFieldValue(Packet packet,
String f_name,
String f_value,
String type,
String label)
|
static void |
addFieldValue(Packet packet,
String f_name,
String f_value,
String label,
String[] labels,
String[] options)
This method allows to add a new multi-option-select-one data field to the command data form. |
static void |
addFieldValue(Packet packet,
String f_name,
String f_value,
String label,
String[] labels,
String[] options,
String type)
|
static void |
addHiddenField(Packet packet,
String f_name,
String f_value)
|
static void |
addInstructions(Packet packet,
String instructions)
|
static void |
addNote(Packet packet,
String note)
|
static void |
addTextField(Packet packet,
String f_name,
String f_value)
|
static void |
addTitle(Packet packet,
String title)
|
static tigase.xml.Element |
createIqCommand(tigase.xmpp.JID from,
tigase.xmpp.JID to,
StanzaType type,
String id,
String node,
Command.DataType data_type)
|
static Command.Action |
getAction(Packet packet)
|
static boolean |
getCheckBoxFieldValue(Packet packet,
String f_name)
|
static List<tigase.xml.Element> |
getData(Packet packet)
|
static tigase.xml.Element |
getData(Packet packet,
String el_name,
String xmlns)
|
static String |
getFieldValue(Packet packet,
String f_name)
|
static String |
getFieldValue(Packet packet,
String f_name,
boolean debug)
|
static String[] |
getFieldValues(Packet packet,
String f_name)
|
Packet |
getPacket(tigase.xmpp.JID from,
tigase.xmpp.JID to,
StanzaType type,
String id)
|
Packet |
getPacket(tigase.xmpp.JID from,
tigase.xmpp.JID to,
StanzaType type,
String id,
Command.DataType data_type)
|
static boolean |
removeFieldValue(Packet packet,
String f_name)
|
static void |
setData(Packet packet,
tigase.xml.Element data)
|
static void |
setData(Packet packet,
List<tigase.xml.Element> data)
|
static void |
setStatus(Packet packet,
Command.Status status)
|
static Command |
valueof(String cmd)
|
static Command |
valueOf(String name)
Returns the enum constant of this type with the specified name. |
static Command[] |
values()
Returns an array containing the constants of this enum type, in the order they are declared. |
Methods inherited from class java.lang.Enum |
---|
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Enum Constant Detail |
---|
public static final Command STREAM_OPENED
public static final Command STREAM_CLOSED
public static final Command STREAM_CLOSED_UPDATE
public static final Command CHECK_USER_CONNECTION
public static final Command STARTTLS
public static final Command STARTZLIB
public static final Command GETFEATURES
public static final Command GETDISCO
public static final Command CLOSE
public static final Command GETSTATS
public static final Command USER_STATUS
public static final Command BROADCAST_TO_ONLINE
public static final Command BROADCAST_TO_ALL
public static final Command REDIRECT
public static final Command VHOSTS_RELOAD
public static final Command VHOSTS_UPDATE
public static final Command VHOSTS_REMOVE
public static final Command OTHER
Field Detail |
---|
public static final String XMLNS
public static final String COMMAND_EL
Method Detail |
---|
public static Command[] values()
for (Command c : Command.values()) System.out.println(c);
public static Command valueOf(String name)
name
- the name of the enum constant to be returned.
IllegalArgumentException
- if this enum type has no constant
with the specified name
NullPointerException
- if the argument is nullpublic static Command valueof(String cmd)
public Packet getPacket(tigase.xmpp.JID from, tigase.xmpp.JID to, StanzaType type, String id)
public Packet getPacket(tigase.xmpp.JID from, tigase.xmpp.JID to, StanzaType type, String id, Command.DataType data_type)
public static tigase.xml.Element createIqCommand(tigase.xmpp.JID from, tigase.xmpp.JID to, StanzaType type, String id, String node, Command.DataType data_type)
public static void setStatus(Packet packet, Command.Status status)
public static void addAction(Packet packet, Command.Action action)
public static Command.Action getAction(Packet packet)
public static void addNote(Packet packet, String note)
public static void addTitle(Packet packet, String title)
public static void addInstructions(Packet packet, String instructions)
public static void addFieldValue(Packet packet, String f_name, String f_value)
packet
- is a Packet
instance of the ad-hoc command
request to be modified.f_name
- is a String
instance with the field name.
In ad-hoc command terms this is a variable name. This field name (variable
name) will be also displayed as the field label.f_value
- is a String
instance with the field default
value.public static void addFieldMultiValue(Packet packet, String f_name, List<String> f_value)
packet
- is a Packet
instance of the ad-hoc command
request to be modified.f_name
- is a String
instance with the field name.
In ad-hoc command terms this is a variable name. This field name (variable
name) will be also displayed as the field label.f_value
- is a list with lines of text to be displayed as a
multi-line field content.public static void addFieldValue(Packet packet, String f_name, String f_value, String label, String[] labels, String[] options)
packet
- is a Packet
instance of the ad-hoc command
request to be modified.f_name
- is a String
instance with the field name.
In ad-hoc command terms this is a variable name.f_value
- is a String
instance with the field default
value. It must match one of the options vaulues provided as a list in
'options' parameter.label
- is a String
instance with the field label.
This time a label set here is displayed to the user instead of the field
name (variable name). This is useful if the variable name is not suitable
or clear enough to the end-user.labels
- is an array with options labels which are displayed to the
end-user upon presenting the selection options.options
- is an array with options values to be selected by the
end-user. Normally these values are not displayed to the end-user. Only
options labels are.public static void addFieldValue(Packet packet, String f_name, String[] f_values, String label, String[] labels, String[] options)
packet
- is a Packet
instance of the ad-hoc command
request to be modified.f_name
- is a String
instance with the field name.
In ad-hoc command terms this is a variable name.f_values
- is an array of default values which are presented to the
end user as preselected options. They must match options vaulues provided
as a list in 'options' parameter.label
- is a String
instance with the field label.
This time a label set here is displayed to the user instead of the field
name (variable name). This is useful if the variable name is not suitable
or clear enough to the end-user.labels
- is an array with options labels which are displayed to the
end-user upon presenting the selection options.options
- is an array with options values to be selected by the
end-user. Normally these values are not displayed to the end-user. Only
options labels are.public static void addFieldValue(Packet packet, String f_name, String f_value, String label, String[] labels, String[] options, String type)
public static void addTextField(Packet packet, String f_name, String f_value)
public static void addCheckBoxField(Packet packet, String f_name, boolean f_value)
public static void addHiddenField(Packet packet, String f_name, String f_value)
public static void addFieldValue(Packet packet, String f_name, String f_value, String type)
public static void addFieldValue(Packet packet, String f_name, String f_value, String type, String label)
public static void setData(Packet packet, tigase.xml.Element data)
public static void setData(Packet packet, List<tigase.xml.Element> data)
public static String getFieldValue(Packet packet, String f_name)
public static boolean getCheckBoxFieldValue(Packet packet, String f_name)
public static String[] getFieldValues(Packet packet, String f_name)
public static boolean removeFieldValue(Packet packet, String f_name)
public static String getFieldValue(Packet packet, String f_name, boolean debug)
public static List<tigase.xml.Element> getData(Packet packet)
public static tigase.xml.Element getData(Packet packet, String el_name, String xmlns)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |