Package org.jivesoftware.openfire.commands.admin

Class GetListOnlineUsers

java.lang.Object

org.jivesoftware.openfire.commands.AdHocCommand

org.jivesoftware.openfire.commands.admin.GetListOnlineUsers

public class GetListOnlineUsers
extends AdHocCommand

Command that allows to retrieve the number of registered users who are online at any one moment. By "online user" is meant any user or account that currently has an IM session that may or may not be available.

Author:

Guus der Kinderen, guus@goodbytes.nl

See Also:

XEP-0133 Service Administration: Get List of Online Users

Nested Class Summary

Nested classes/interfaces inherited from class org.jivesoftware.openfire.commands.AdHocCommand

AdHocCommand.Action, AdHocCommand.Status

Constructor Summary

Constructors

Constructor	Description
GetListOnlineUsers()

Method Summary

Modifier and Type	Method	Description
protected void	addStageInformation(SessionData data, org.dom4j.Element command)	Adds to the command element the data form or notes required by the current stage.
void	execute(SessionData data, org.dom4j.Element command)	Executes the command with the specified session data.
protected List<AdHocCommand.Action>	getActions(SessionData data)	Returns a collection with the allowed actions based on the current stage as defined in the SessionData.
String	getCode()	Returns the unique identifier for this command for the containing JID.
String	getDefaultLabel()	Returns the default label used for describing this command.
protected AdHocCommand.Action	getExecuteAction(SessionData data)	Returns which of the actions available for the current stage is considered the equivalent to "execute".
int	getMaxStages(SessionData data)	Returns the max number of stages for this command.

Methods inherited from class org.jivesoftware.openfire.commands.AdHocCommand

addNextStageInformation, addPreviousStageInformation, addStageActions, get, getLabel, hasPermission, setLabel

Methods inherited from class java.lang.Object

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

Constructor Detail

GetListOnlineUsers

public GetListOnlineUsers()

Method Detail

addStageInformation

protected void addStageInformation(@Nonnull
                                   SessionData data,
                                   org.dom4j.Element command)

Description copied from class: AdHocCommand

Adds to the command element the data form or notes required by the current stage. The current stage is specified in the SessionData. This method will never be invoked for commands that have no stages.

Specified by:

addStageInformation in class AdHocCommand

Parameters:

data - metadata and the gathered data through the command stages.

command - the command element to be sent to the command requester.

execute

public void execute(@Nonnull
                    SessionData data,
                    org.dom4j.Element command)

Description copied from class: AdHocCommand

Executes the command with the specified session data.

Specified by:

execute in class AdHocCommand

Parameters:

data - metadata and the gathered data through the command stages.

command - the command element to be sent to the command requester with a reported data result or note element with the answer of the execution.

getCode

public String getCode()

Description copied from class: AdHocCommand

Returns the unique identifier for this command for the containing JID. The code will be used as the node in the disco#items or the node when executing the command.

Specified by:

getCode in class AdHocCommand

Returns:

the unique identifier for this command for the containing JID.

getDefaultLabel

public String getDefaultLabel()

Description copied from class: AdHocCommand

Returns the default label used for describing this command. This information is usually used when returning commands as disco#items. Admins can later use AdHocCommand.setLabel(String) to set a new label and reset to the default value at any time.

Specified by:

getDefaultLabel in class AdHocCommand

Returns:

the default label used for describing this command.

getActions

protected List<AdHocCommand.Action> getActions(@Nonnull
                                               SessionData data)

Description copied from class: AdHocCommand

Returns a collection with the allowed actions based on the current stage as defined in the SessionData. Possible actions are: prev, next and complete. This method will never be invoked for commands that have no stages.

Specified by:

getActions in class AdHocCommand

Parameters:

data - metadata and the gathered data through the command stages.

Returns:

a collection with the allowed actions based on the current stage as defined in the SessionData.

getExecuteAction

protected AdHocCommand.Action getExecuteAction(@Nonnull
                                               SessionData data)

Description copied from class: AdHocCommand

Returns which of the actions available for the current stage is considered the equivalent to "execute". When the requester sends his reply, if no action was defined in the command then the action will be assumed "execute" thus assuming the action returned by this method. This method will never be invoked for commands that have no stages.

Specified by:

getExecuteAction in class AdHocCommand

Parameters:

data - metadata and the gathered data through the command stages.

Returns:

which of the actions available for the current stage is considered the equivalent to "execute".

getMaxStages

public int getMaxStages(@Nonnull
                        SessionData data)

Description copied from class: AdHocCommand

Returns the max number of stages for this command. The number of stages may vary according to the collected data in previous stages. Therefore, a SessionData object is passed as a parameter. When the max number of stages has been reached then the command is ready to be executed.

Specified by:

getMaxStages in class AdHocCommand

Parameters:

data - metadata and the gathered data through the command stages.

Returns:

the max number of stages for this command.