Package com.uc4.communication.requests
Class SynchronizeLDAP
java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.SynchronizeLDAP
This request synchronizes the data of an UC4 User with LDAP.
-
Constructor Summary
ConstructorsConstructorDescriptionSynchronizeLDAP
(UserListItem userItem) Creates a newSynchronizeLDAP
request in another client.SynchronizeLDAP
(UC4UserName user) Creates a newSynchronizeLDAP
request.SynchronizeLDAP
(String userID) Creates a newSynchronizeLDAP
request in another client. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
createRequest
(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo) Creates the XML Document for the request.Returns the distinguished name of the user.getEmail()
Returns the email address of the user ornull
if this request has not been sent.Returns the first name of the user ornull
if this request has not been sent.Returns the last name of the user ornull
if this request has not been sent.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.boolean
isActive()
Returnstrue
if the user is active, false if inactive.protected boolean
This method is used internally.boolean
isLocked()
Returnstrue
if the user is locked.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 Details
-
SynchronizeLDAP
Creates a newSynchronizeLDAP
request.- Parameters:
user
- Name of the UC4 user
-
SynchronizeLDAP
Creates a newSynchronizeLDAP
request in another client.- Parameters:
userItem
- Item of the user list which is created by the UserList request
-
SynchronizeLDAP
Creates a newSynchronizeLDAP
request in another client.- Parameters:
userID
- id of the user from UserListRowItem- See Also:
-
com.uc4.ecc.backends.dataservice.userlist.IUserListRowItem#getId()
-
-
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
-
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
-
isActive
public boolean isActive()Returnstrue
if the user is active, false if inactive. Active means that the user can log on to the UC4 system.- Returns:
- Is active?
-
isLocked
public boolean isLocked()Returnstrue
if the user is locked. The repeated indication of a wrong password has the effect that a user is locked.- Returns:
- Is locked?
-
getFirstName
Returns the first name of the user ornull
if this request has not been sent.- Returns:
- First name
-
getLastName
Returns the last name of the user ornull
if this request has not been sent.- Returns:
- Last name
-
getEmail
Returns the email address of the user ornull
if this request has not been sent.- Returns:
-
getDistinguishedName
Returns the distinguished name of the user.- Returns:
- Distinguished name
-