Package com.uc4.communication.requests

Class ServerList

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.ServerList

All Implemented Interfaces:

Iterable<ServerListItem>

public class ServerList
extends XMLRequest
implements Iterable<ServerListItem>

Reads a list of UC4 Servers independent of their states (running or not running).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServerList.Filter	Filter in the Servers list.

Constructor Summary

Constructors

Constructor	Description
ServerList()	Default constructor
ServerList(ServerList.Filter filter)	Constructor with filter

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.
protected String	getSrc()	Returns the request source.
protected void	handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)	Sub classes extract the values from the XML document and provide public getter methods.
protected boolean	isAllowedInClientZero()	This method is used internally.
Iterator<ServerListItem>	iterator()	Returns an Iterator which can be used to step through the ServerListItem.
int	size()	Returns the total number of items in the server list (active and inactive).

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, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

ServerList

public ServerList(ServerList.Filter filter)

Constructor with filter

Parameters:

filter - The filter is optional and can be null

ServerList

public ServerList()

Default constructor

Method Details

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

handleContent

protected void handleContent(com.uc4.util.XMLDocument doc,
 ConnectionAttributes session)

Description copied from class: XMLRequest

Sub classes extract the values from the XML document and provide public getter methods.

Overrides:

handleContent in class XMLRequest

Parameters:

doc - XML Document

session - Info about the user session

iterator

public Iterator<ServerListItem> iterator()

Returns an Iterator which can be used to step through the ServerListItem. If this class does not contain a server list this method returns null

Specified by:

iterator in interface Iterable<ServerListItem>

Returns:

Iterator containing ServerListItem or null in case of an error

size

public int size()

Returns the total number of items in the server list (active and inactive).

Returns:

number of ServerListItem

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