public enum Command extends Enum<Command>
Modifier and Type | Class and Description |
---|---|
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 and 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.
|
CLIENT_AUTH
Command sent from connection manager to the session manager after TLS handshake if
client sent certificate.
|
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_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.
|
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.
|
Modifier and Type | Field and Description |
---|---|
static String |
COMMAND_EL
Field description
|
static String |
FIELD_EL
Field description
|
protected static String[] |
FIELD_VALUE_PATH
Field description
|
static String |
VALUE_EL
Field description
|
static String |
XMLNS
Field description
|
Modifier and Type | Method and Description |
---|---|
static void |
addAction(Packet packet,
Command.Action action)
Method description
|
static void |
addCheckBoxField(Packet packet,
String f_name,
boolean f_value)
Method description
|
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 |
addFieldMultiValue(Packet packet,
String f_name,
Throwable ex)
Method description
|
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)
Method description
|
static void |
addFieldValue(Packet packet,
String f_name,
String f_value,
String type,
String label)
Method description
|
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)
Method description
|
static void |
addHiddenField(Packet packet,
String f_name,
String f_value)
Method description
|
static void |
addInstructions(Packet packet,
String instructions)
Method description
|
static void |
addNote(Packet packet,
String note)
Method description
|
static void |
addTextField(Packet packet,
String f_name,
String f_value)
Method description
|
static void |
addTitle(Packet packet,
String title)
Method description
|
static tigase.xml.Element |
createIqCommand(tigase.xmpp.JID from,
tigase.xmpp.JID to,
StanzaType type,
String id,
String node,
Command.DataType data_type)
Method description
|
static Command.Action |
getAction(Packet packet)
Method description
|
static boolean |
getCheckBoxFieldValue(Packet packet,
String f_name)
Method description
|
static List<tigase.xml.Element> |
getData(Packet packet)
Method description
|
static tigase.xml.Element |
getData(Packet packet,
String el_name,
String xmlns)
Method description
|
static String |
getFieldKeyStartingWith(Packet packet,
String f_name)
Method description
|
static String |
getFieldValue(Packet packet,
String f_name)
Method description
|
static String |
getFieldValue(Packet packet,
String f_name,
boolean debug)
Method description
|
static String[] |
getFieldValues(Packet packet,
String f_name)
Method description
|
Packet |
getPacket(tigase.xmpp.JID from,
tigase.xmpp.JID to,
StanzaType type,
String id)
Method description
|
Packet |
getPacket(tigase.xmpp.JID from,
tigase.xmpp.JID to,
StanzaType type,
String id,
Command.DataType data_type)
Method description
|
static boolean |
removeFieldValue(Packet packet,
String f_name)
Method description
|
static void |
setData(Packet packet,
tigase.xml.Element data)
Method description
|
static void |
setData(Packet packet,
List<tigase.xml.Element> data)
Method description
|
static void |
setStatus(Packet packet,
Command.Status status)
Method description
|
static Command |
valueof(String cmd)
Method description
|
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.
|
public static final Command STREAM_OPENED
public static final Command CLIENT_AUTH
public static final Command USER_LOGIN
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 STREAM_MOVED
public static final Command OTHER
public static final String COMMAND_EL
public static final String FIELD_EL
public static final String VALUE_EL
public static final String XMLNS
protected static final String[] FIELD_VALUE_PATH
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 nameNullPointerException
- if the argument is nullpublic static void addAction(Packet packet, Command.Action action)
packet
- action
- public static void addCheckBoxField(Packet packet, String f_name, boolean f_value)
packet
- f_name
- f_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 addFieldMultiValue(Packet packet, String f_name, Throwable ex)
packet
- f_name
- ex
- 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 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)
packet
- f_name
- f_value
- label
- labels
- options
- type
- public static void addFieldValue(Packet packet, String f_name, String f_value, String type)
packet
- f_name
- f_value
- type
- public static void addFieldValue(Packet packet, String f_name, String f_value, String type, String label)
packet
- f_name
- f_value
- type
- label
- public static void addHiddenField(Packet packet, String f_name, String f_value)
packet
- f_name
- f_value
- public static void addInstructions(Packet packet, String instructions)
packet
- instructions
- public static void addNote(Packet packet, String note)
packet
- note
- public static void addTextField(Packet packet, String f_name, String f_value)
packet
- f_name
- f_value
- public static void addTitle(Packet packet, String title)
packet
- title
- public static tigase.xml.Element createIqCommand(tigase.xmpp.JID from, tigase.xmpp.JID to, StanzaType type, String id, String node, Command.DataType data_type)
from
- to
- type
- id
- node
- data_type
- public static Command.Action getAction(Packet packet)
packet
- public static boolean getCheckBoxFieldValue(Packet packet, String f_name)
packet
- f_name
- public static List<tigase.xml.Element> getData(Packet packet)
packet
- public static tigase.xml.Element getData(Packet packet, String el_name, String xmlns)
packet
- el_name
- xmlns
- public static String getFieldValue(Packet packet, String f_name)
packet
- f_name
- public static String getFieldValue(Packet packet, String f_name, boolean debug)
packet
- f_name
- debug
- public static String[] getFieldValues(Packet packet, String f_name)
packet
- f_name
- public static boolean removeFieldValue(Packet packet, String f_name)
packet
- f_name
- public static String getFieldKeyStartingWith(Packet packet, String f_name)
packet
- f_name
- public static void setData(Packet packet, tigase.xml.Element data)
packet
- data
- public static void setData(Packet packet, List<tigase.xml.Element> data)
packet
- data
- public static void setStatus(Packet packet, Command.Status status)
packet
- status
- public Packet getPacket(tigase.xmpp.JID from, tigase.xmpp.JID to, StanzaType type, String id)
from
- to
- type
- id
- public Packet getPacket(tigase.xmpp.JID from, tigase.xmpp.JID to, StanzaType type, String id, Command.DataType data_type)
from
- to
- type
- id
- data_type
- Copyright © 2014 "Tigase, Inc.". All rights reserved.