Package com.unboundid.ldap.sdk.unboundidds.controls

This package contains implementations for a number of LDAP controls which are specific to the Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 Directory Server products.

See: Description

Class Summary

Class	Description
AccessLogFieldRequestControl	This class provides a request control that can be included in any type of request to indicate that the server should include one or more fields, specified as name-value pairs, that should appear in the Ping Identity Directory Server's access log message for the operation.
AccountUsableRequestControl	This class provides an implementation of the account usable request control.
AccountUsableResponseControl	This class provides an implementation of the account usable response control, which may be returned with search result entries to provide information about the usability of the associated user accounts.
AdministrativeOperationRequestControl	This class provides an implementation of a Directory Server control that may be used to indicate that the associated operation is used for performing some administrative operation within the server rather than one that was requested by a "normal" client.
AssuredReplicationRequestControl	This class provides an implementation of an LDAP control that can be included in add, bind, modify, modify DN, and certain extended requests to indicate the level of replication assurance desired for the associated operation.
AssuredReplicationResponseControl	This class provides an implementation of an LDAP control that can be included in add, bind, modify, modify DN, and certain extended responses to provide information about the result of replication assurance processing for that operation.
AssuredReplicationServerResult	This class defines a data structure that provides information about the result of assured replication processing, either on a replication server (if that is all that is needed to satisfy the desired level of assurance) or on a directory server (if required by the desired level of assurance).
AuthenticationFailureReason	This class defines a data structure that will provide information about errors that could cause an authentication attempt to fail.
BatchedTransactionSpecificationRequestControl	This class provides an implementation of the batched transaction specification request control, which may be used to indicate that the associated add, delete, modify, modify DN, or password modify operation is part of a batched transaction.
EffectiveRightsEntry	This class provides a mechanism for extracting the effective rights information from an entry returned for a search request that included the get effective rights request control.
ExcludeBranchRequestControl	This class provides a request control which may be used to request that entries below one or more base DNs be excluded from the results returned to a client while processing a search operation.
ExtendedSchemaInfoRequestControl	This class provides an implementation of a control which can be used to request that the Directory Server include extended information when returning a subschema subentry.
GenerateAccessTokenRequestControl	This class provides a request control that can be included in a bind request to indicate that if the bind succeeds, the server should generate an access token that can be used in the OAUTHBEARERBindRequest to authenticate as the user for subsequent authentication attempts.
GenerateAccessTokenResponseControl	This class provides a response control that may be used to convey the access token (and other associated information) generated in response to a GenerateAccessTokenRequestControl for a successful bind operation.
GeneratePasswordRequestControl	This class provides a request control that can be included in an add request to indicate that the server should generate a password for the new account.
GeneratePasswordResponseControl	This class provides a response control that may be used to convey the password (and other associated information) generated in response to a GeneratePasswordRequestControl.
GetAuthorizationEntryRequestControl	This class provides an implementation of an LDAP control that can be included in a bind request to request that the Directory Server return the authentication and authorization entries for the user that authenticated.
GetAuthorizationEntryResponseControl	This class provides an implementation of an LDAP control that may be included in a bind response to provide information about the authenticated and/or authorized user.
GetBackendSetIDRequestControl	This class provides a request control which may be used to request that the Directory Proxy Server return the backend set IDs for the entry-balancing backend set(s) in which an operation was processed successfully.
GetBackendSetIDResponseControl	This class provides a response control that may be used to provide the backend set ID(s) for any relevant backend sets accessed during the course of processing an operation.
GetEffectiveRightsRequestControl	This class provides an implementation of the get effective rights request control, which may be included in a search request to indicate that matching entries should include information about the rights a given user may have when interacting with that entry.
GetPasswordPolicyStateIssuesRequestControl	This class provides an implementation of a request control that can be included in a bind request to indicate that the server should include a control in the bind response with information about any password policy state notices, warnings, and/or errors for the user.
GetPasswordPolicyStateIssuesResponseControl	This class provides an implementation of a response control that can be included in a bind response with information about any password policy state notices, warnings, and/or errors for the user.
GetRecentLoginHistoryRequestControl	This class provides an implementation of a request control that can be included in a bind request to indicate that the server should include a control int eh bind response with information about recent login attempts for the user.
GetRecentLoginHistoryResponseControl	This class provides an implementation of a response control that can be included in the response to a successful bind operation to provide information about recent successful and failed authentication attempts.
GetServerIDRequestControl	This class provides a request control which may be used to request the server ID of the server that actually processed the associated request.
GetServerIDResponseControl	This class provides a response control that may be used to provide the server ID of the Directory Server instance that processed the associated request.
GetUserResourceLimitsRequestControl	This class provides a request control which may be used to request that the server return resource limit information for the authenticated user in the response to a successful bind operation.
GetUserResourceLimitsResponseControl	This class provides a response control that may be included in the response to a successful bind operation in order to provide information about custom resource limits for the user, including size limit, time limit, idle time limit, lookthrough limit, equivalent authorization user DN, and client connection policy name.
HardDeleteRequestControl	This class provides a request control which may be included in a delete request to indicate that the server should completely remove the target entry, even if it would otherwise process the operation as a soft delete and merely hide the entry from most clients.
IgnoreNoUserModificationRequestControl	This class provides an implementation of an LDAP control that can be used to request that the Directory Server ignore the NO-USER-MODIFICATION flag for attribute types.
IntermediateClientRequestControl	This class defines an intermediate client request control, which can be used to provide a server with information about the client and any downstream clients that it may have.
IntermediateClientRequestValue	This class implements a data structure which encapsulates the value of an intermediate client request value.
IntermediateClientResponseControl	This class defines an intermediate client response control, which can be used to provide a server with information about the client and any downstream clients that it may have.
IntermediateClientResponseValue	This class implements a data structure which encapsulates the value of an intermediate client response value.
JoinBaseDN	This class provides a data structure which may be used to indicate the base DN to use for a join request.
JoinedEntry	This class provides a joined entry, which is a read-only representation of an entry that has been joined with a search result entry using the LDAP join control.
JoinRequestControl	This class provides an implementation of an LDAP control which can be included in a search request to indicate that search result entries should be returned along with related entries based on a given set of criteria, much like an SQL join in a relational database.
JoinRequestValue	This class contains a data structure which provides information about the value of an LDAP join request control, which may or may not include a nested join.
JoinResultControl	This class provides an implementation of a control that may be included in a search result entry in response to a join request control to provide a set of entries related to the search result entry.
JoinRule	This class provides an implementation of a join rule as used by the LDAP join request control.
JSONFormattedControlDecodeBehavior	This enum defines options for the behaviors that should be used when trying to decode JSON objects embedded in a JSONFormattedRequestControl or JSONFormattedResponseControl as Control objects.
JSONFormattedRequestControl	This class provides an implementation of a request control that may be used to encapsulate a set of zero or more other controls represented as JSON objects, and to indicate that the server should return any response controls in a JSONFormattedResponseControl.
JSONFormattedResponseControl	This class provides an implementation of a response control that may be used to encapsulate a set of one or more other controls represented as JSON objects.
MatchingEntryCountRequestControl	This class provides a request control which may be included in a search request to indicate that the server should provide the number of entries that match the search criteria.
MatchingEntryCountRequestControlProperties	This class provides a set of properties that can be used in conjunction with the MatchingEntryCountRequestControl.
MatchingEntryCountResponseControl	This class provides a response control that may be used to provide information about the number of entries that match a given set of search criteria.
NameWithEntryUUIDRequestControl	This class provides an implementation of the name with entryUUID request control.
NoOpRequestControl	This class provides an implementation of the LDAP no-op control as defined in draft-zeilenga-ldap-noop.
OperationPurposeRequestControl	This class provides a request control that can be used by the client to identify the purpose of the associated operation.
OverrideSearchLimitsRequestControl	This class provides an implementation of a control that may be included in a search request to override certain default limits that would normally be in place for the operation.
PasswordPolicyRequestControl	This class provides an implementation of the password policy request control as described in draft-behera-ldap-password-policy.
PasswordPolicyResponseControl	This class provides an implementation of the password policy response control as described in draft-behera-ldap-password-policy.
PasswordQualityRequirementValidationResult	This class provides a data structure that holds information about the result of attempting validation with a proposed password against a password quality requirement.
PasswordUpdateBehaviorRequestControl	This class provides an implementation of a request control that can be included in an add request, modify request, or password modify extended request to control the way the server should behave when performing a password change.
PasswordUpdateBehaviorRequestControlProperties	This class provides a set of properties that can be used in conjunction with the PasswordUpdateBehaviorRequestControl.
PasswordValidationDetailsRequestControl	This class provides an implementation for a request control that can be included in an add, modify, or password modify request.
PasswordValidationDetailsResponseControl	This class provides an implementation for a response control that can be returned by the server in the response for add, modify, and password modify requests that include the password validation details request control.
PermitUnindexedSearchRequestControl	This class provides an implementation of a request control that may be included in a search request to indicate that the server should process the search even if it cannot use its defined indexes to identify matching entries efficiently.
PurgePasswordRequestControl	This class provides a request control that can be included in a modify request or a password modify extended request in order to indicate that if the operation results in changing the password for a user, the user's former password should be purged from the entry rather than retired, and any existing retired password should also be purged.
RealAttributesOnlyRequestControl	This class provides an implementation of the real attributes only request control, which may be included in a search request to indicate that only real (i.e., non-virtual) attributes should be included in matching entries.
RecentLoginHistory	This class provides a data structure with information about recent successful and failed login attempts for a user.
RecentLoginHistoryAttempt	This class provides a data structure with information about a recent login attempt for a user.
RejectUnindexedSearchRequestControl	This class provides an implementation of a request control that may be included in a search request to indicate that the server should reject the request if the server cannot use its defined indexes to identify matching entries efficiently.
ReplicationRepairRequestControl	This class provides an implementation of a control which may be used to process an add, delete, modify, or modify DN operation in the Directory Server which will not be replicated to other servers.
RetainIdentityRequestControl	This class defines a request control that may be used to indicate that the server should process all aspects of the associated bind request (including password policy processing) but should not actually change the identity for the client connection, regardless of whether the authentication is successful.
RetirePasswordRequestControl	This class provides a request control that can be included in a modify request or a password modify extended request in order to indicate that if the operation results in changing the password for a user, the user's former password should be marked as "retired", which may allow it to remain in use for a brief period of time (as configured in the password policy governing that user) to allow for applications which may have been configured with that password can be updated to use the new password.
ReturnConflictEntriesRequestControl	This class defines a request control that may be included in a search request to indicate that the server should include replication conflict entries in the set of search result entries.
RouteToBackendSetRequestControl	This class provides a request control which may be used to request that the Directory Proxy Server forward the associated operation to a specific backend set associated with an entry-balancing request processor.
RouteToServerRequestControl	This class provides a request control which may be used to request that the associated request be routed to a specific server.
SoftDeletedEntryAccessRequestControl	This class provides a request control which may be included in a search request to indicate that soft-deleted entries may be included in the results, or it may be included in a compare or modify request to indicate that the operation should operate against the target entry even if it is a soft-deleted entry.
SoftDeleteRequestControl	This class provides a request control which may be included in a delete request to indicate that the server should perform a soft delete rather than a hard delete.
SoftDeleteResponseControl	This class provides a response control that holds information about the soft-deleted entry that results from a soft delete request, and may also be included in a search result entry which represents a soft-deleted entry.
SuppressOperationalAttributeUpdateRequestControl	This class provides an implementation of a control that can be used to indicate that the server should suppress the update to one or more operational attributes for the associated request.
SuppressReferentialIntegrityUpdatesRequestControl	This class provides a request control which may be included in a delete or modify DN request to indicate that the server should skip any referential integrity processing that would have otherwise been done for that operation.
TransactionSettingsRequestControl	This class provides a request control that can be used to specify a number of settings used for any database transaction that may be associated with the associated request.
TransactionSettingsResponseControl	This class provides a response control that may be used to provide the client with information about transaction-related information over the course of the associated operation.
UndeleteRequestControl	This class provides a request control which may be included in an add request to indicate that the contents of the resulting entry should come not from the data of the add request itself but instead from a soft-deleted entry.
UniquenessRequestControl	This class provides a request control that may be included in an add, modify, or modify DN request to ensure that the contents of that request will not result in a uniqueness conflict with any other entry in the server.
UniquenessRequestControlProperties	This class provides a data structure that holds a set of properties for use in conjunction with the UniquenessRequestControl.
UniquenessResponseControl	This class provides a response control that may be included in the response to add, modify, and modify DN requests that included the UniquenessRequestControl.
UnsolicitedCancelResponseControl	This class provides an implementation of the unsolicited cancel response control, which may be returned by the Directory Server if an operation is canceled by the server without a cancel or abandon request from the client.
VirtualAttributesOnlyRequestControl	This class provides an implementation of the virtual attributes only request control, which may be included in a search request to indicate that only virtual attributes should be included in matching entries.

Enum Summary

Enum	Description
AssuredReplicationLocalLevel	This enum defines an assurance level that may be used for servers in the same location as the server receiving the change.
AssuredReplicationRemoteLevel	This enum defines an assurance level that may be used for servers in different locations from the server receiving the change.
AssuredReplicationServerResultCode	This enum defines the set of result code values that may be included in a an assured replication server result.
AttributeRight	This enum contains the set of possible attribute-level rights that may be described for an attribute in an entry retrieved with the get effective rights control.
EntryRight	This enum contains the set of possible entry-level rights that may be described in an entry retrieved with the get effective rights control.
MatchingEntryCountType	This enum defines the set of count types that may be used in a matching entry count response control.
PasswordPolicyErrorType	This enum defines a set of error types that may be included in the password policy response control as defined in draft-behera-ldap-password-policy.
PasswordPolicyWarningType	This enum defines a set of warning types that may be included in the password policy response control as defined in draft-behera-ldap-password-policy.
PasswordValidationDetailsResponseType	This enum defines the set of response types that can be used in the password validation details response control.
RouteToBackendSetRoutingType	This enum defines the set of routing types that may be used in a route to backend set request control.
SuppressType	This enum defines the set of operational update types that may be suppressed by the suppress operational attribute update request control.
TransactionSettingsBackendLockBehavior	This enum defines the options that may be specified to indicate whether and when to acquire an exclusive lock in the target backend when processing a transaction.
TransactionSettingsCommitDurability	This enum defines the options that may be specified for the transaction commit durability when using the transaction settings request control.
UniquenessMultipleAttributeBehavior	This enum defines the set of multiple attribute behavior values that may be used in conjunction with the UniquenessRequestControl.
UniquenessValidationLevel	This enum defines the set of validation level values that may be used in conjunction with the UniquenessRequestControl.
UniquenessValidationResult	This enum defines a set of values that provide information about the result of validation processing that the server performed in response to a UniquenessRequestControl.

Package com.unboundid.ldap.sdk.unboundidds.controls Description

This package contains implementations for a number of LDAP controls which are specific to the Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 Directory Server products. In some cases, they may be based on standard controls which have not yet reached a sufficient stability level to make them available for general use against any kind of server, while in other cases they may be defined specifically for use with the Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 Directory Server.

NOTE: The classes within this package, and elsewhere within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.