oracle.oud.plugin

Interface PluginContext.ControlBuilder

Enclosing class:

PluginContext

public static interface PluginContext.ControlBuilder

This interface is a builder to create new Control instances.

Method Summary

Modifier and Type	Method and Description
AssertionRequestControl	newAssertionRequestControl(boolean isCritical, Filter filter) Creates a new assertion using the provided criticality and assertion filter.
AuthorizationIdentityRequestControl	newAuthorizationIdentityRequestControl(boolean isCritical) Creates a new authorization identity request control having the provided criticality.
AuthorizationIdentityResponseControl	newAuthorizationIdentityResponseControl(java.lang.String authorizationID) Creates a new authorization identity response control using the provided authorization ID.
Control	newControl(java.lang.String oid, boolean isCritical, java.lang.Object value) Creates a new control having the provided OID, criticality, and value.
EntryChangeNotificationResponseControl	newEntryChangeNotificationResponseControl(PersistentSearchChangeType type, DN previousName, long changeNumber) Creates a new entry change notification response control with the provided change type and optional previous distinguished name and change number.
GetEffectiveRightsRequestControl	newGetEffectiveRightsRequestControl(boolean isCritical, DN authorizationName, java.util.Collection<AttributeType> attributes) Creates a new get effective rights request control with the provided criticality, optional authorization name and attribute list.
ManageDsaITRequestControl	newManageDsaITRequestControl(boolean isCritical) Creates a new ManageDsaIT request control having the provided criticality.
MatchedValuesRequestControl	newMatchedValuesRequestControl(boolean isCritical, java.util.Collection<Filter> filters) Creates a new matched values request control with the provided criticality and list of filters.
PasswordExpiredResponseControl	newPasswordExpiredResponseControl() Creates a new Netscape password expired response control.
PasswordExpiringResponseControl	newPasswordExpiringResponseControl(int secondsUntilExpiration) Creates a new Netscape password expiring response control with the provided amount of time until expiration.
PasswordPolicyRequestControl	newPasswordPolicyRequestControl(boolean isCritical) Creates a new password policy request control having the provided criticality.
PasswordPolicyResponseControl	newPasswordPolicyResponseControl(PasswordPolicyWarningType warningType, int warningValue, PasswordPolicyErrorType errorType) Creates a new password policy response control with the provided warning and error.
PermissiveModifyRequestControl	newPermissiveModifyRequestControl(boolean isCritical) Creates a new permissive modify request control having the provided criticality.
PersistentSearchRequestControl	newPersistentSearchRequestControl(boolean isCritical, boolean changesOnly, boolean returnECs, java.util.Collection<PersistentSearchChangeType> changeTypes) Creates a new persistent search request control.
PostReadRequestControl	newPostReadRequestControl(boolean isCritical, java.util.Collection<java.lang.String> attributes) Creates a new post-read request control.
PostReadResponseControl	newPostReadResponseControl(Entry entry) Creates a new post-read response control.
PreReadRequestControl	newPreReadRequestControl(boolean isCritical, java.util.Collection<java.lang.String> attributes) Creates a new pre-read request control.
PreReadResponseControl	newPreReadResponseControl(Entry entry) Creates a new pre-read response control.
ProxiedAuthV1RequestControl	newProxiedAuthV1RequestControl(DN authorizationName) Creates a new proxy authorization v1 request control with the provided authorization name.
ProxiedAuthV2RequestControl	newProxiedAuthV2RequestControl(java.lang.String authorizationID) Creates a new proxy authorization v2 request control with the provided authorization ID.
ServerSideSortRequestControl	newServerSideSortRequestControl(boolean isCritical, java.util.Collection<SortKey> keys) Creates a new server side sort request control with the provided criticality and list of sort keys.
ServerSideSortResponseControl	newServerSideSortResponseControl(ResultCode result, AttributeDescription attributeDescription) Creates a new server-side response control with the provided sort result and attribute description.
SimplePagedResultsControl	newSimplePagedResultsControl(boolean isCritical, int size, ByteString cookie) Creates a new simple paged results control with the provided criticality, size, and cookie.
SubentriesRequestControl	newSubentriesRequestControl(boolean isCritical) Creates a new sub-entries request control having the provided criticality.
SubtreeDeleteRequestControl	newSubtreeDeleteRequestControl(boolean isCritical) Creates a new tree delete request control having the provided criticality.
VirtualListViewRequestControl	newVirtualListViewRequestControl(boolean isCritical, ByteString assertionValue, int beforeCount, int afterCount, ByteString contextID) Creates a new virtual list view request control that will identify the target entry by an assertion value.
VirtualListViewRequestControl	newVirtualListViewRequestControl(boolean isCritical, int offset, int contentCount, int beforeCount, int afterCount, ByteString contextID) Creates a new virtual list view request control that will identify the target entry by a positional offset within the complete result set.
VirtualListViewResponseControl	newVirtualListViewResponseControl(int targetPosition, int contentCount, ResultCode result, ByteString contextID) Creates a new virtual list view response control.

Method Detail

newAssertionRequestControl

AssertionRequestControl newAssertionRequestControl(boolean isCritical,
                                                   Filter filter)
                                            throws PluginException

Creates a new assertion using the provided criticality and assertion filter.

Parameters:

isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored.

filter - The assertion filter.

Returns:

A new assertion control.

Throws:

PluginException - if the provided filter is invalid.

newAuthorizationIdentityRequestControl

AuthorizationIdentityRequestControl newAuthorizationIdentityRequestControl(boolean isCritical)

Creates a new authorization identity request control having the provided criticality.

Parameters:

isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored.

Returns:

A new authorization identity request control.

newAuthorizationIdentityResponseControl

AuthorizationIdentityResponseControl newAuthorizationIdentityResponseControl(java.lang.String authorizationID)

Creates a new authorization identity response control using the provided authorization ID.

Parameters:

authorizationID - The authorization ID for this control.

Returns:

A new authorization identity response control.

newEntryChangeNotificationResponseControl

EntryChangeNotificationResponseControl newEntryChangeNotificationResponseControl(PersistentSearchChangeType type,
                                                                                 DN previousName,
                                                                                 long changeNumber)
                                                                          throws PluginException

Creates a new entry change notification response control with the provided change type and optional previous distinguished name and change number.

Parameters:

type - The change type for this change notification control.

previousName - The distinguished name that the entry had prior to a modify DN operation, or null if the operation was not a modify DN.

changeNumber - The change number for the associated change, or a negative value if no change number is available.

Returns:

A new entry change notification response control.

Throws:

PluginException - if the provided Dn is invalid.

newControl

Control newControl(java.lang.String oid,
                   boolean isCritical,
                   java.lang.Object value)

Creates a new control having the provided OID, criticality, and value.

If value is not an instance of ByteString then it will be converted using the ByteString.valueOf(Object) method.

Parameters:

oid - The numeric OID associated with this control.

isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored.

value - The value associated with this control, or null if there is no value. Its format is defined by the specification of this control.

Returns:

A new control.

newGetEffectiveRightsRequestControl

GetEffectiveRightsRequestControl newGetEffectiveRightsRequestControl(boolean isCritical,
                                                                     DN authorizationName,
                                                                     java.util.Collection<AttributeType> attributes)

Creates a new get effective rights request control with the provided criticality, optional authorization name and attribute list.

Parameters:

isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored.

authorizationName - The distinguished name of the user for which effective rights are to be returned, or null if the client's authentication ID is to be used.

attributes - The list of attributes for which effective rights are to be returned, which may be empty indicating that no attribute rights are to be returned.

Returns:

A new get effective rights request control.

newManageDsaITRequestControl

ManageDsaITRequestControl newManageDsaITRequestControl(boolean isCritical)

Creates a new ManageDsaIT request control having the provided criticality.

Parameters:

isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored.

Returns:

A new ManageDsaIT request control.

newMatchedValuesRequestControl

MatchedValuesRequestControl newMatchedValuesRequestControl(boolean isCritical,
                                                           java.util.Collection<Filter> filters)
                                                    throws PluginException

Creates a new matched values request control with the provided criticality and list of filters.

Parameters:

isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored.

filters - The list of filters of which at least one must match an attribute value in order for the attribute value to be returned to the client. The list must not be empty.

Returns:

A new matched values request control.

Throws:

PluginException - if one of the provided filters is invalid.

newPasswordExpiredResponseControl

PasswordExpiredResponseControl newPasswordExpiredResponseControl()

Creates a new Netscape password expired response control.

Returns:

A new Netscape password expired response control.

newPasswordExpiringResponseControl

PasswordExpiringResponseControl newPasswordExpiringResponseControl(int secondsUntilExpiration)

Creates a new Netscape password expiring response control with the provided amount of time until expiration.

Parameters:

secondsUntilExpiration - The length of time in seconds until the password actually expires.

Returns:

A new Netscape password expiring response control.

newPasswordPolicyRequestControl

PasswordPolicyRequestControl newPasswordPolicyRequestControl(boolean isCritical)

Creates a new password policy request control having the provided criticality.

Parameters:

isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored.

Returns:

A new password policy request control.

newPasswordPolicyResponseControl

PasswordPolicyResponseControl newPasswordPolicyResponseControl(PasswordPolicyWarningType warningType,
                                                               int warningValue,
                                                               PasswordPolicyErrorType errorType)

Creates a new password policy response control with the provided warning and error.

Parameters:

warningType - The password policy warning type.

warningValue - The password policy warning value.

errorType - The password policy error type.

Returns:

A new password policy response control.

newPermissiveModifyRequestControl

PermissiveModifyRequestControl newPermissiveModifyRequestControl(boolean isCritical)

Creates a new permissive modify request control having the provided criticality.

Parameters:

isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored.

Returns:

A new permissive modify request control.

newPersistentSearchRequestControl

PersistentSearchRequestControl newPersistentSearchRequestControl(boolean isCritical,
                                                                 boolean changesOnly,
                                                                 boolean returnECs,
                                                                 java.util.Collection<PersistentSearchChangeType> changeTypes)

Creates a new persistent search request control.

Parameters:

isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored

changesOnly - Indicates whether or not only updated entries should be returned (added, modified, deleted, or subject to a modifyDN operation). If this parameter is false then the search will initially return all the existing entries which match the filter.

returnECs - Indicates whether or not the entry change notification control should be included in updated entries that match the associated search criteria.

changeTypes - The types of update operation for which change notifications should be returned.

Returns:

A new persistent search request control.

newPostReadRequestControl

PostReadRequestControl newPostReadRequestControl(boolean isCritical,
                                                 java.util.Collection<java.lang.String> attributes)

Creates a new post-read request control.

Parameters:

isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored

attributes - The list of attributes to be included with the response control. Attributes that are sub-types of listed attributes are implicitly included. The list may be empty, indicating that all user attributes should be returned.

Returns:

A new post-read request control.

newPostReadResponseControl

PostReadResponseControl newPostReadResponseControl(Entry entry)
                                            throws PluginException

Creates a new post-read response control.

Parameters:

entry - The entry whose contents reflect the state of the updated entry immediately after the update operation was performed.

Returns:

A new post-read response control.

Throws:

PluginException - if the provided entry is invalid.

newPreReadRequestControl

PreReadRequestControl newPreReadRequestControl(boolean isCritical,
                                               java.util.Collection<java.lang.String> attributes)

Creates a new pre-read request control.

Parameters:

isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored

attributes - The list of attributes to be included with the response control. Attributes that are sub-types of listed attributes are implicitly included. The list may be empty, indicating that all user attributes should be returned.

Returns:

A new pre-read request control.

newPreReadResponseControl

PreReadResponseControl newPreReadResponseControl(Entry entry)
                                          throws PluginException

Creates a new pre-read response control.

Parameters:

entry - The entry whose contents reflect the state of the updated entry immediately before the update operation was performed.

Returns:

A new pre-read response control.

Throws:

PluginException - if the provided entry is invalid.

newProxiedAuthV1RequestControl

ProxiedAuthV1RequestControl newProxiedAuthV1RequestControl(DN authorizationName)
                                                    throws PluginException

Creates a new proxy authorization v1 request control with the provided authorization name.

Parameters:

authorizationName - The distinguished name of the user whose authorization is to be used when performing the operation.

Returns:

A new proxy authorization v1 request control.

Throws:

PluginException - if the provided Dn is invalid.

newProxiedAuthV2RequestControl

ProxiedAuthV2RequestControl newProxiedAuthV2RequestControl(java.lang.String authorizationID)

Creates a new proxy authorization v2 request control with the provided authorization ID. The authorization ID usually has the form "dn:" immediately followed by the distinguished name of the user, or "u:" followed by a user ID string, but other forms are permitted.

Parameters:

authorizationID - The authorization ID of the user whose authorization is to be used when performing the operation.

Returns:

A new proxy authorization v2 request control.

newServerSideSortRequestControl

ServerSideSortRequestControl newServerSideSortRequestControl(boolean isCritical,
                                                             java.util.Collection<SortKey> keys)
                                                      throws PluginException

Creates a new server side sort request control with the provided criticality and list of sort keys.

Parameters:

isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored.

keys - The list of sort keys.

Returns:

A new server side sort request control.

Throws:

PluginException - if one of the sort key is invalid.

newServerSideSortResponseControl

ServerSideSortResponseControl newServerSideSortResponseControl(ResultCode result,
                                                               AttributeDescription attributeDescription)

Creates a new server-side response control with the provided sort result and attribute description.

Parameters:

result - The result code indicating the outcome of the server-side sort request. ResultCode.SUCCESS if the search results were sorted in accordance with the keys specified in the server-side sort request control, or an error code indicating why the results could not be sorted (such as ResultCode.NO_SUCH_ATTRIBUTE or ResultCode.INAPPROPRIATE_MATCHING).

attributeDescription - The first attribute description specified in the list of sort keys that was in error, may be null.

Returns:

A new server-side response control.

newSimplePagedResultsControl

SimplePagedResultsControl newSimplePagedResultsControl(boolean isCritical,
                                                       int size,
                                                       ByteString cookie)

Creates a new simple paged results control with the provided criticality, size, and cookie.

Parameters:

isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored.

size - The requested page size when used in a request control from the client, or an estimate of the result set size when used in a response control from the server (may be 0, indicating that the server does not know).

cookie - An opaque cookie which is used by the server to track its position in the set of search results. The cookie must be empty in the initial search request sent by the client. For subsequent search requests the client must include the cookie returned with the previous search result, until the server returns an empty cookie indicating that the final page of results has been returned.

Returns:

A new simple paged results control.

newSubentriesRequestControl

SubentriesRequestControl newSubentriesRequestControl(boolean isCritical)

Creates a new sub-entries request control having the provided criticality.

Parameters:

isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored.

Returns:

A new sub-entries request control.

newSubtreeDeleteRequestControl

SubtreeDeleteRequestControl newSubtreeDeleteRequestControl(boolean isCritical)

Creates a new tree delete request control having the provided criticality.

Parameters:

isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored.

Returns:

A new tree delete request control.

newVirtualListViewRequestControl

VirtualListViewRequestControl newVirtualListViewRequestControl(boolean isCritical,
                                                               ByteString assertionValue,
                                                               int beforeCount,
                                                               int afterCount,
                                                               ByteString contextID)

Creates a new virtual list view request control that will identify the target entry by an assertion value. The assertion value is encoded according to the ORDERING matching rule for the attribute description in the sort control. The assertion value is used to determine the target entry by comparison with the values of the attribute specified as the primary sort key. The first list entry who's value is no less than (less than or equal to when the sort order is reversed) the supplied value is the target entry.

Parameters:

isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored.

assertionValue - The assertion value that will be used to locate the target entry.

beforeCount - The number of entries before the target entry to be included in the search results.

afterCount - The number of entries after the target entry to be included in the search results.

contextID - The context ID provided by the server in the last virtual list view response for the same set of criteria, or null if there was no previous virtual list view response or the server did not include a context ID in the last response.

Returns:

A new virtual list view request control.

newVirtualListViewRequestControl

VirtualListViewRequestControl newVirtualListViewRequestControl(boolean isCritical,
                                                               int offset,
                                                               int contentCount,
                                                               int beforeCount,
                                                               int afterCount,
                                                               ByteString contextID)

Creates a new virtual list view request control that will identify the target entry by a positional offset within the complete result set.

Parameters:

isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored.

offset - The positional offset of the target entry in the result set, where 1 is the first entry.

contentCount - The content count returned by the server in the last virtual list view response, or 0 if this is the first virtual list view request.

beforeCount - The number of entries before the target entry to be included in the search results.

afterCount - The number of entries after the target entry to be included in the search results.

contextID - The context ID provided by the server in the last virtual list view response for the same set of criteria, or null if there was no previous virtual list view response or the server did not include a context ID in the last response.

Returns:

A new virtual list view request control.

newVirtualListViewResponseControl

VirtualListViewResponseControl newVirtualListViewResponseControl(int targetPosition,
                                                                 int contentCount,
                                                                 ResultCode result,
                                                                 ByteString contextID)

Creates a new virtual list view response control.

Parameters:

targetPosition - The position of the target entry in the result set.

contentCount - An estimate of the total number of entries in the result set.

result - The result code indicating the outcome of the virtual list view request.

contextID - A server-defined octet string. If present, the contextID should be sent back to the server by the client in a subsequent virtual list request.

Returns:

A new virtual list view response control.