Package com.uc4.communication.requests
Class SystemWorkload
java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.SystemWorkload
- All Implemented Interfaces:
Iterable<WorkloadItem>
Gets the Server workload.
-
Constructor Summary
ConstructorsConstructorDescriptionReturns the data which is shown in the system overview as "Usage".SystemWorkload
(ServerListItem server) Returns the usage for the specified server. -
Method Summary
Modifier and TypeMethodDescriptionprotected 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.Returns aWorkloadItem
which represents the total system workload.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
This method is used internally.iterator()
Returns an Iterator which can be used to step through theWorkloadItem
.int
size()
Returns the total number of clients in the workload list.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
-
SystemWorkload
public SystemWorkload()Returns the data which is shown in the system overview as "Usage". -
SystemWorkload
Returns the usage for the specified server.- Parameters:
server
- ServerListItem which was returned in the ServerList request.
-
-
Method Details
-
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, 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
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
Returns an Iterator which can be used to step through theWorkloadItem
. If this class does not contain a workload list this method returnsnull
- Specified by:
iterator
in interfaceIterable<WorkloadItem>
- Returns:
- Iterator containing
WorkloadItem
ornull
in case of an error
-
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
-
getTotalWorkload
Returns aWorkloadItem
which represents the total system workload.- Returns:
WorkloadItem
of all clients
-
size
public int size()Returns the total number of clients in the workload list.- Returns:
- number of
WorkloadItem
-