Package com.uc4.communication.requests
Class UserList
- java.lang.Object
-
- com.uc4.communication.requests.XMLRequest
-
- com.uc4.communication.requests.UserList
-
- All Implemented Interfaces:
java.lang.Iterable<UserListItem>
public class UserList extends XMLRequest implements java.lang.Iterable<UserListItem>
Lists all users in a client. All the users of the UC4 system may be viewed in system client "0000".
-
-
Constructor Summary
Constructors Constructor Description UserList()
-
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.boolean
includeInactiveUsers()
Returnstrue
if inactive users should also be returned by this request.protected boolean
isAllowedInClientZero()
This method is used internally.boolean
isLDAPEnabledSystem()
Returnstrue
if LDAP is enabled for the systemjava.util.Iterator<UserListItem>
iterator()
Returns an Iterator which can be used to step through theUserListItem
.void
setIncludeInactiveUsers(boolean inactive)
Ifinactive
istrue
also inactive users are returned.int
size()
Returns the total number of items in the user 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
-
-
-
-
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
-
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
-
iterator
public java.util.Iterator<UserListItem> iterator()
Returns an Iterator which can be used to step through theUserListItem
. If this class does not contain a user list this method returnsnull
- Specified by:
iterator
in interfacejava.lang.Iterable<UserListItem>
- Returns:
- Iterator containing
UserListItem
ornull
in case of an error
-
size
public int size()
Returns the total number of items in the user list (active and inactive).- Returns:
- number of
UserListItem
-
includeInactiveUsers
public boolean includeInactiveUsers()
Returnstrue
if inactive users should also be returned by this request.- Returns:
- True if the selection includes inactive users
-
setIncludeInactiveUsers
public void setIncludeInactiveUsers(boolean inactive)
Ifinactive
istrue
also inactive users are returned.- Parameters:
inactive
- True if the selection should include inactive users
-
isLDAPEnabledSystem
public boolean isLDAPEnabledSystem()
Returnstrue
if LDAP is enabled for the system- Returns:
- ldap enabled
-
-