Package com.uc4.communication.requests
Class ServerList
- java.lang.Object
-
- com.uc4.communication.requests.XMLRequest
-
- com.uc4.communication.requests.ServerList
-
- All Implemented Interfaces:
java.lang.Iterable<ServerListItem>
public class ServerList extends XMLRequest implements java.lang.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 constructorServerList(ServerList.Filter filter)
Constructor with filter
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)
Creates the XML Document for the request.protected java.lang.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.java.util.Iterator<ServerListItem>
iterator()
Returns an Iterator which can be used to step through theServerListItem
.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
-
-
-
-
Constructor Detail
-
ServerList
public ServerList(ServerList.Filter filter)
Constructor with filter- Parameters:
filter
- The filter is optional and can benull
-
ServerList
public ServerList()
Default constructor
-
-
Method Detail
-
getSrc
protected java.lang.String getSrc()
Description copied from class:XMLRequest
Returns the request source. This method is used internally.- Specified by:
getSrc
in classXMLRequest
- Returns:
- Source
-
createRequest
protected void createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.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 classXMLRequest
- Parameters:
doc
- Document, used to create new Elementsrequest
- Request Element - classes append information to this request elementsessionInfo
- 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 classXMLRequest
- Parameters:
doc
- XML Documentsession
- Info about the user session
-
iterator
public java.util.Iterator<ServerListItem> iterator()
Returns an Iterator which can be used to step through theServerListItem
. If this class does not contain a server list this method returnsnull
- Specified by:
iterator
in interfacejava.lang.Iterable<ServerListItem>
- Returns:
- Iterator containing
ServerListItem
ornull
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 thisXMLRequest
is allowed in client 0. The default implementation returnsfalse
, subclasses may override.- Overrides:
isAllowedInClientZero
in classXMLRequest
- Returns:
true
if this request is allowed in client 0,false
otherwise
-
-