Package com.uc4.communication.requests

Class DisconnectUser

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.DisconnectUser

public class DisconnectUser
extends XMLRequest

Disconnects a user.

Constructor Summary

Constructors

Constructor	Description
DisconnectUser(int sessionId)	Creates a new DisconnectUser request from a session ID.
DisconnectUser(CheckILMPartitionItem item)	Creates a new DisconnectUser request.
DisconnectUser(UserListItem user)	Creates a new DisconnectUser request.
DisconnectUser(List<UserListItem> users)	Creates a new DisconnectUser group request.

Method Summary

Modifier and Type	Method	Description
protected void	createRequest(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo)	Creates the XML Document for the request.
static DisconnectUser	fromSessionIds(List<Integer> sessionIds)	Creates a new DisconnectUser group request from session IDs.
protected String	getSrc()	Returns the request source.
protected boolean	isAllowedInClientZero()	This method is used internally.

Methods inherited from class com.uc4.communication.requests.XMLRequest

assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleContent, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification

Methods inherited from class java.lang.Object

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

Constructor Details

DisconnectUser

public DisconnectUser(UserListItem user)

Creates a new DisconnectUser request.

Parameters:

user - User object which is returned in the UserList

DisconnectUser

public DisconnectUser(List<UserListItem> users)

Creates a new DisconnectUser group request.

Parameters:

users - List of User objects which are returned in the UserList

DisconnectUser

public DisconnectUser(int sessionId)

Creates a new DisconnectUser request from a session ID.

Parameters:

sessionId - Session ID to disconnect

DisconnectUser

public DisconnectUser(CheckILMPartitionItem item)

Creates a new DisconnectUser request.

Parameters:

item - Row in the ILM check partition table

Method Details

fromSessionIds

public static DisconnectUser fromSessionIds(List<Integer> sessionIds)

Creates a new DisconnectUser group request from session IDs.

Parameters:

sessionIds - List of session IDs to disconnect

getSrc

protected String getSrc()

Description copied from class: XMLRequest

Returns the request source. This method is used internally.

Specified by:

getSrc in class XMLRequest

Returns:

Source

createRequest

protected void createRequest(com.uc4.util.XMLDocument doc,
 Element request,
 ConnectionAttributes sessionInfo)

Description copied from class: XMLRequest

Creates the XML Document for the request. This method is used internally.

Specified by:

createRequest in class XMLRequest

Parameters:

doc - Document, used to create new Elements

request - Request Element - classes append information to this request element

sessionInfo - Information about the session

isAllowedInClientZero

protected boolean isAllowedInClientZero()

Description copied from class: XMLRequest

This method is used internally. Tests if this XMLRequest is allowed in client 0. The default implementation returns false, subclasses may override.

Overrides:

isAllowedInClientZero in class XMLRequest

Returns:

true if this request is allowed in client 0, false otherwise