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 newSynchronizeLDAPrequest in another client.SynchronizeLDAP(UC4UserName user) Creates a newSynchronizeLDAPrequest.SynchronizeLDAP(String userID) Creates a newSynchronizeLDAPrequest in another client. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidcreateRequest(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 ornullif this request has not been sent.Returns the first name of the user ornullif this request has not been sent.Returns the last name of the user ornullif this request has not been sent.protected StringgetSrc()Returns the request source.protected voidhandleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session) Sub classes extract the values from the XML document and provide public getter methods.booleanisActive()Returnstrueif the user is active, false if inactive.protected booleanThis method is used internally.booleanisLocked()Returnstrueif 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 newSynchronizeLDAPrequest.- Parameters:
user- Name of the UC4 user
-
SynchronizeLDAP
Creates a newSynchronizeLDAPrequest in another client.- Parameters:
userItem- Item of the user list which is created by the UserList request
-
SynchronizeLDAP
Creates a newSynchronizeLDAPrequest 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:XMLRequestReturns the request source. This method is used internally.- Specified by:
getSrcin classXMLRequest- Returns:
- Source
-
createRequest
protected void createRequest(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo) Description copied from class:XMLRequestCreates the XML Document for the request. This method is used internally.- Specified by:
createRequestin 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:XMLRequestSub classes extract the values from the XML document and provide public getter methods.- Overrides:
handleContentin classXMLRequest- Parameters:
doc- XML Documentsession- Info about the user session
-
isAllowedInClientZero
protected boolean isAllowedInClientZero()Description copied from class:XMLRequestThis method is used internally. Tests if thisXMLRequestis allowed in client 0. The default implementation returnsfalse, subclasses may override.- Overrides:
isAllowedInClientZeroin classXMLRequest- Returns:
trueif this request is allowed in client 0,falseotherwise
-
isActive
public boolean isActive()Returnstrueif 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()Returnstrueif 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 ornullif this request has not been sent.- Returns:
- First name
-
getLastName
Returns the last name of the user ornullif this request has not been sent.- Returns:
- Last name
-
getEmail
Returns the email address of the user ornullif this request has not been sent.- Returns:
-
getDistinguishedName
Returns the distinguished name of the user.- Returns:
- Distinguished name
-