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

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()	Returns true if inactive users should also be returned by this request.
protected boolean	isAllowedInClientZero()	This method is used internally.
boolean	isLDAPEnabledSystem()	Returns true if LDAP is enabled for the system
java.util.Iterator<UserListItem>	iterator()	Returns an Iterator which can be used to step through the UserListItem.
void	setIncludeInactiveUsers(boolean inactive)	If inactive is true 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

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 Detail

UserList

public UserList()

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 class XMLRequest

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 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

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

iterator

public java.util.Iterator<UserListItem> iterator()

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

Specified by:

iterator in interface java.lang.Iterable<UserListItem>

Returns:

Iterator containing UserListItem or null 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()

Returns true if inactive users should also be returned by this request.

Returns:

True if the selection includes inactive users

setIncludeInactiveUsers

public void setIncludeInactiveUsers(boolean inactive)

If inactive is true also inactive users are returned.

Parameters:

inactive - True if the selection should include inactive users

isLDAPEnabledSystem

public boolean isLDAPEnabledSystem()

Returns true if LDAP is enabled for the system

Returns:

ldap enabled