Package tigase.server

Enum Command

java.lang.Object

java.lang.Enum<Command>

tigase.server.Command

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Command>

public enum Command
extends java.lang.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

Author:

Artur Hefczyc

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Command.Action	Ad-hoc command actions ad defined in the XEP-0050.
static class	Command.Builder
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

Enum Constants

Enum Constant	Description
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 depreciated 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_FINISHED	Command sent from a connection manager to the session manager after last packet from closed connection stream has been sent.
STREAM_MOVED	Command sent to SessionManager to change connectionId of existing session.
STREAM_OPENED	Command sent from a connection manager to the session manager when a new stream from the client has been opened.
TLS_HANDSHAKE_COMPLETE	Command sent from connection manager to the session manager after TLS handshake if client sent certificate.
USER_LOGIN	Command sent from session manager to the connection manager after successful user login.
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

Fields

Modifier and Type	Field	Description
static java.lang.String	COMMAND_EL
static java.lang.String	XMLNS

Method Summary

Modifier and Type	Method	Description
static void	addAction(Packet packet, Command.Action action)
static void	addCheckBoxField(Packet packet, java.lang.String f_name, boolean f_value)
static void	addFieldMultiValue(Packet packet, java.lang.String f_name, java.lang.Throwable ex)
static void	addFieldMultiValue(Packet packet, java.lang.String f_name, java.util.List<java.lang.String> f_value)	A simple method for adding a multi-line (text-multi) data field to the command data form.
static void	addFieldMultiValue(Packet packet, java.lang.String f_name, java.util.List<java.lang.String> f_value, java.lang.String label)
static void	addFieldValue(Packet packet, java.lang.String f_name, java.lang.String f_value)	Simple method for adding a new field to the command data form.
static void	addFieldValue(Packet packet, java.lang.String f_name, java.lang.String[] f_values, java.lang.String label, java.lang.String[] labels, java.lang.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, java.lang.String f_name, java.lang.String f_value, java.lang.String type)
static void	addFieldValue(Packet packet, java.lang.String f_name, java.lang.String f_value, java.lang.String type, java.lang.String label)
static void	addFieldValue(Packet packet, java.lang.String f_name, java.lang.String f_value, java.lang.String label, java.lang.String[] labels, java.lang.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, java.lang.String f_name, java.lang.String f_value, java.lang.String label, java.lang.String[] labels, java.lang.String[] options, java.lang.String type)
static void	addHiddenField(Packet packet, java.lang.String f_name, java.lang.String f_value)
static void	addInstructions(Packet packet, java.lang.String instructions)
static void	addNote(Packet packet, java.lang.String note)
static void	addTextField(Packet packet, java.lang.String f_name, java.lang.String f_value)
static void	addTitle(Packet packet, java.lang.String title)
protected static Element	createCommandEl(java.lang.String node, Command.DataType data_type)
static Element	createIqCommand(JID from, JID to, StanzaType type, java.lang.String id, java.lang.String node, Command.DataType data_type)
static Command.Action	getAction(Packet packet)
static boolean	getCheckBoxFieldValue(Packet packet, java.lang.String f_name)
static java.util.List<Element>	getData(Packet packet)
static Element	getData(Packet packet, java.lang.String el_name, java.lang.String xmlns)
static java.lang.String	getFieldKeyStartingWith(Packet packet, java.lang.String f_name)
static java.lang.String	getFieldValue(Packet packet, java.lang.String f_name)
static java.lang.String	getFieldValue(Packet packet, java.lang.String f_name, boolean debug)
static java.lang.String[]	getFieldValues(Packet packet, java.lang.String f_name)
Packet	getPacket(JID from, JID to, StanzaType type, java.lang.String id)	Method returns instance of a Packet with command element added.
Packet	getPacket(JID from, JID to, StanzaType type, java.lang.String id, Command.DataType data_type)	Method returns instance of a Packet with command element added.
static boolean	removeFieldValue(Packet packet, java.lang.String f_name)
static void	setData(Packet packet, java.util.List<Element> data)
static void	setData(Packet packet, Element data)
static void	setStatus(Packet packet, Command.Status status)
static Command	valueof(java.lang.String cmd)
static Command	valueOf(java.lang.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

STREAM_OPENED

public static final Command STREAM_OPENED

Command sent from a connection manager to the session manager when a new stream from the client has been opened.

TLS_HANDSHAKE_COMPLETE

public static final Command TLS_HANDSHAKE_COMPLETE

Command sent from connection manager to the session manager after TLS handshake if client sent certificate.

USER_LOGIN

public static final Command USER_LOGIN

Command sent from session manager to the connection manager after successful user login.

STREAM_CLOSED

public static final Command STREAM_CLOSED

Command sent from a connection manager to the session manager when a connection or stream has been closed.

STREAM_CLOSED_UPDATE

public static final Command STREAM_CLOSED_UPDATE

STREAM_FINISHED

public static final Command STREAM_FINISHED

Command sent from a connection manager to the session manager after last packet from closed connection stream has been sent.

CHECK_USER_CONNECTION

public static final Command CHECK_USER_CONNECTION

Sends a command from SM to the connection holder to confirm whether the connection is still active. Expects result for ok, error or timeout if the connection is no longer active.

STARTTLS

public static final Command STARTTLS

Command sent from the session manager to a connection manager to start TLS handshaking over the client connection.

STARTZLIB

public static final Command STARTZLIB

Command sent from the session manager to a connection manager to start zlib compression on the connection stream.

GETFEATURES

public static final Command GETFEATURES

Command sent between a connection manager and the session manager to retrieve stream features.

GETDISCO

public static final Command GETDISCO

This is depreciated command sent between components in the Tigase server for service discovery handling.

CLOSE

public static final Command CLOSE

Command sent from the session manager to a client manager to close the client connection.

GETSTATS

public static final Command GETSTATS

Command used by the StatisticsCollector to provide server statistics through ad-hoc command.

USER_STATUS

public static final Command 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.

BROADCAST_TO_ONLINE

public static final Command BROADCAST_TO_ONLINE

Command used to set a broadcast message to all online users.

BROADCAST_TO_ALL

public static final Command BROADCAST_TO_ALL

Command used to set a broadcast message to all registered local users.

REDIRECT

public static final Command REDIRECT

Command used to redirect packets from a connection manager to other than default session manager. (Mostly used in the clustering.)

VHOSTS_RELOAD

public static final Command VHOSTS_RELOAD

Command sent to the VHostManager to reload virtual hosts from the database.

VHOSTS_UPDATE

public static final Command VHOSTS_UPDATE

Command sent to the VHostManager to add or update existing virtual host.

VHOSTS_REMOVE

public static final Command VHOSTS_REMOVE

Command sent to the VHostManager to remove existing virtual host.

STREAM_MOVED

public static final Command STREAM_MOVED

Command sent to SessionManager to change connectionId of existing session.

OTHER

public static final Command OTHER

Identifies all other, not predefined commands.

Field Detail

COMMAND_EL

public static final java.lang.String COMMAND_EL

See Also:

Constant Field Values

XMLNS

public static final java.lang.String XMLNS

See Also:

Constant Field Values

Method Detail

values

public static Command[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Command c : Command.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Command valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

addAction

public static void addAction(Packet packet,
                             Command.Action action)

addCheckBoxField

public static void addCheckBoxField(Packet packet,
                                    java.lang.String f_name,
                                    boolean f_value)

addFieldMultiValue

public static void addFieldMultiValue(Packet packet,
                                      java.lang.String f_name,
                                      java.util.List<java.lang.String> f_value)

A simple method for adding a multi-line (text-multi) data field to the command data form. Only field name (variable name) and field default value can be set.

Parameters:

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.

addFieldMultiValue

public static void addFieldMultiValue(Packet packet,
                                      java.lang.String f_name,
                                      java.util.List<java.lang.String> f_value,
                                      java.lang.String label)

addFieldMultiValue

public static void addFieldMultiValue(Packet packet,
                                      java.lang.String f_name,
                                      java.lang.Throwable ex)

addFieldValue

public static void addFieldValue(Packet packet,
                                 java.lang.String f_name,
                                 java.lang.String f_value)

Simple method for adding a new field to the command data form. Only field name (variable name) and field default value can be set.

Parameters:

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.

addFieldValue

public static void addFieldValue(Packet packet,
                                 java.lang.String f_name,
                                 java.lang.String f_value,
                                 java.lang.String label,
                                 java.lang.String[] labels,
                                 java.lang.String[] options)

This method allows to add a new multi-option-select-one data field to the command data form. This is much more complex implementation allowing to set a field label and labels for all provided field options. It allows the end-user to select a single option from a given list.

Parameters:

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.

addFieldValue

public static void addFieldValue(Packet packet,
                                 java.lang.String f_name,
                                 java.lang.String[] f_values,
                                 java.lang.String label,
                                 java.lang.String[] labels,
                                 java.lang.String[] options)

This method allows to add a new multi-option-select-many data field to the command data form. This is much more complex implementation allowing to set a field label and labels for all provided field options. It allows the end-user to select many options from the given list.

Parameters:

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.

addFieldValue

public static void addFieldValue(Packet packet,
                                 java.lang.String f_name,
                                 java.lang.String f_value,
                                 java.lang.String label,
                                 java.lang.String[] labels,
                                 java.lang.String[] options,
                                 java.lang.String type)

addFieldValue

public static void addFieldValue(Packet packet,
                                 java.lang.String f_name,
                                 java.lang.String f_value,
                                 java.lang.String type)

addFieldValue

public static void addFieldValue(Packet packet,
                                 java.lang.String f_name,
                                 java.lang.String f_value,
                                 java.lang.String type,
                                 java.lang.String label)

addHiddenField

public static void addHiddenField(Packet packet,
                                  java.lang.String f_name,
                                  java.lang.String f_value)

addInstructions

public static void addInstructions(Packet packet,
                                   java.lang.String instructions)

addNote

public static void addNote(Packet packet,
                           java.lang.String note)

addTextField

public static void addTextField(Packet packet,
                                java.lang.String f_name,
                                java.lang.String f_value)

addTitle

public static void addTitle(Packet packet,
                            java.lang.String title)

createCommandEl

protected static Element createCommandEl(java.lang.String node,
                                         Command.DataType data_type)

createIqCommand

public static Element createIqCommand(JID from,
                                      JID to,
                                      StanzaType type,
                                      java.lang.String id,
                                      java.lang.String node,
                                      Command.DataType data_type)

getAction

public static Command.Action getAction(Packet packet)

getCheckBoxFieldValue

public static boolean getCheckBoxFieldValue(Packet packet,
                                            java.lang.String f_name)

getData

public static java.util.List<Element> getData(Packet packet)

getData

public static Element getData(Packet packet,
                              java.lang.String el_name,
                              java.lang.String xmlns)

getFieldKeyStartingWith

public static java.lang.String getFieldKeyStartingWith(Packet packet,
                                                       java.lang.String f_name)

getFieldValue

public static java.lang.String getFieldValue(Packet packet,
                                             java.lang.String f_name)

getFieldValue

public static java.lang.String getFieldValue(Packet packet,
                                             java.lang.String f_name,
                                             boolean debug)

getFieldValues

public static java.lang.String[] getFieldValues(Packet packet,
                                                java.lang.String f_name)

removeFieldValue

public static boolean removeFieldValue(Packet packet,
                                       java.lang.String f_name)

setData

public static void setData(Packet packet,
                           Element data)

setData

public static void setData(Packet packet,
                           java.util.List<Element> data)

setStatus

public static void setStatus(Packet packet,
                             Command.Status status)

valueof

public static Command valueof(java.lang.String cmd)

getPacket

public Packet getPacket(JID from,
                        JID to,
                        StanzaType type,
                        java.lang.String id)

Method returns instance of a Packet with command element added. WARNING: Returned packet will not have any XMLNS set!

getPacket

public Packet getPacket(JID from,
                        JID to,
                        StanzaType type,
                        java.lang.String id,
                        Command.DataType data_type)

Method returns instance of a Packet with command element added. WARNING: Returned packet will not have any XMLNS set!