oracle.oud.plugin

Interface RequestContext.RequestBuilder

Enclosing class:

RequestContext

public static interface RequestContext.RequestBuilder

This interface is a builder to create new Request instances.

Method Summary

Modifier and Type	Method and Description
AddRequest	newAddRequest(DN name) Creates a new add request with the specified distinguished name.
AddRequest	newAddRequest(java.lang.String name) Creates a new add request with the specified distinguished name.
BindRequest	newBindRequest(DN name, ByteString password) Creates a new simple bind request having the provided distinguished name and password suitable for name/password authentication.
BindRequest	newBindRequest(java.lang.String name, char[] password) Creates a new simple bind request having the provided distinguished name and password suitable for name/password authentication.
CompareRequest	newCompareRequest(DN name, AttributeDescription attributeDescription, ByteString assertionValue) Creates a new compare request using the provided distinguished name, attribute name, and assertion value.
CompareRequest	newCompareRequest(java.lang.String name, java.lang.String attributeDescription, java.lang.Object assertionValue) Creates a new compare request using the provided distinguished name, attribute name, and assertion value.
DeleteRequest	newDeleteRequest(DN name) Creates a new delete request with the specified distinguished name.
DeleteRequest	newDeleteRequest(java.lang.String name) Creates a new delete request with the specified distinguished name.
ModifyDNRequest	newModifyDNRequest(DN name, RDN newRDN) Creates a new modify Dn request with the specified distinguished name and new RDN.
ModifyDNRequest	newModifyDNRequest(java.lang.String name, java.lang.String newRDN) Creates a new modify Dn request with the specified distinguished name and new RDN.
ModifyRequest	newModifyRequest(DN name) Creates a new modify request with the specified distinguished name.
ModifyRequest	newModifyRequest(java.lang.String name) Creates a new modify request with the specified distinguished name.
SearchRequest	newSearch(DN name, SearchScope scope, Filter filter, java.lang.String... attributeDescriptions) Creates a new search request using the provided distinguished name, scope,filter and attribute descriptions.
SearchRequest	newSearch(java.lang.String name, SearchScope scope, java.lang.String filter, java.lang.String... attributeDescriptions) Creates a new search request using the provided distinguished name, scope,filter and attribute descriptions.

Method Detail

newAddRequest

AddRequest newAddRequest(DN name)
                  throws java.lang.IllegalArgumentException

Creates a new add request with the specified distinguished name.

Parameters:

name - The distinguished name of the entry to be added.

Returns:

The new add request with the specified distinguished name.

Throws:

java.lang.IllegalArgumentException - if the name parameter is invalid.

newAddRequest

AddRequest newAddRequest(java.lang.String name)
                  throws PluginException

Creates a new add request with the specified distinguished name.

Parameters:

name - The distinguished name of the entry to be added.

Returns:

The new add request with the specified distinguished name.

Throws:

PluginException - if the name parameter could not decoded successfully.

newBindRequest

BindRequest newBindRequest(DN name,
                           ByteString password)
                    throws java.lang.IllegalArgumentException

Creates a new simple bind request having the provided distinguished name and password suitable for name/password authentication.

Parameters:

name - The name of the Directory object that the client wishes to bind as, which may be empty.

password - The password of the Directory object that the client wishes to bind as, which may be empty indicating that an unauthenticated bind is to be performed.

Returns:

The new simple bind request.

Throws:

java.lang.IllegalArgumentException - if the name or password parameter is invalid.

newBindRequest

BindRequest newBindRequest(java.lang.String name,
                           char[] password)
                    throws PluginException

Creates a new simple bind request having the provided distinguished name and password suitable for name/password authentication.

Parameters:

name - The name of the Directory object that the client wishes to bind as, which may be empty.

password - The password of the Directory object that the client wishes to bind as, which may be empty indicating that an unauthenticated bind is to be performed.

Returns:

The new simple bind request.

Throws:

PluginException - if the name could not decoded successfully.

newCompareRequest

CompareRequest newCompareRequest(DN name,
                                 AttributeDescription attributeDescription,
                                 ByteString assertionValue)
                          throws java.lang.IllegalArgumentException

Creates a new compare request using the provided distinguished name, attribute name, and assertion value.

Parameters:

name - The distinguished name of the entry to be compared.

attributeDescription - The name of the attribute to be compared.

assertionValue - The assertion value to be compared.

Returns:

The new compare request.

Throws:

java.lang.IllegalArgumentException - if the name, attributeDescription or assertionValue parameter is invalid.

newCompareRequest

CompareRequest newCompareRequest(java.lang.String name,
                                 java.lang.String attributeDescription,
                                 java.lang.Object assertionValue)
                          throws PluginException

Creates a new compare request using the provided distinguished name, attribute name, and assertion value.

Parameters:

name - The distinguished name of the entry to be compared.

attributeDescription - The name of the attribute to be compared.

assertionValue - The assertion value to be compared.

Returns:

The new compare request.

Throws:

PluginException - if the name, attributeDescription or assertionValue parameter could not decoded successfully.

newDeleteRequest

DeleteRequest newDeleteRequest(DN name)
                        throws java.lang.IllegalArgumentException

Creates a new delete request with the specified distinguished name.

Parameters:

name - The distinguished name of the entry to be deleted.

Returns:

The new delete request.

Throws:

java.lang.IllegalArgumentException - if the name parameter is invalid.

newDeleteRequest

DeleteRequest newDeleteRequest(java.lang.String name)
                        throws PluginException

Creates a new delete request with the specified distinguished name.

Parameters:

name - The distinguished name of the entry to be deleted.

Returns:

The new delete request.

Throws:

PluginException - if the name parameter could not decoded successfully.

newModifyRequest

ModifyRequest newModifyRequest(DN name)
                        throws java.lang.IllegalArgumentException

Creates a new modify request with the specified distinguished name.

Parameters:

name - The distinguished name of the entry to be modified.

Returns:

The new modify request.

Throws:

java.lang.IllegalArgumentException - if the name parameter is invalid.

newModifyRequest

ModifyRequest newModifyRequest(java.lang.String name)
                        throws PluginException

Creates a new modify request with the specified distinguished name.

Parameters:

name - The distinguished name of the entry to be modified.

Returns:

The new modify request.

Throws:

PluginException - if the name parameter could not decoded successfully.

newModifyDNRequest

ModifyDNRequest newModifyDNRequest(DN name,
                                   RDN newRDN)
                            throws java.lang.IllegalArgumentException

Creates a new modify Dn request with the specified distinguished name and new RDN.

Parameters:

name - The distinguished name of the entry to be renamed.

newRDN - The new RDN of the entry.

Returns:

The new modify Dn request.

Throws:

java.lang.IllegalArgumentException - if the name or newRDN parameter is invalid.

newModifyDNRequest

ModifyDNRequest newModifyDNRequest(java.lang.String name,
                                   java.lang.String newRDN)
                            throws PluginException

Creates a new modify Dn request with the specified distinguished name and new RDN.

Parameters:

name - The distinguished name of the entry to be renamed.

newRDN - The new RDN of the entry.

Returns:

The new modify Dn request.

Throws:

PluginException - if the name or newRDN could not decoded successfully.

newSearch

SearchRequest newSearch(DN name,
                        SearchScope scope,
                        Filter filter,
                        java.lang.String... attributeDescriptions)
                 throws java.lang.IllegalArgumentException

Creates a new search request using the provided distinguished name, scope,filter and attribute descriptions.

Parameters:

name - The distinguished name of the base entry relative to which the search is to be performed.

scope - The scope of the search.

filter - The filter that defines the conditions that must be fulfilled in order for an entry to be returned.

attributeDescriptions - The names of the attributes to be included with each entry.

Returns:

The new search request.

Throws:

java.lang.IllegalArgumentException - if the name or filter parameter is invalid.

newSearch

SearchRequest newSearch(java.lang.String name,
                        SearchScope scope,
                        java.lang.String filter,
                        java.lang.String... attributeDescriptions)
                 throws PluginException

Creates a new search request using the provided distinguished name, scope,filter and attribute descriptions.

Parameters:

name - The distinguished name of the base entry relative to which the search is to be performed.

scope - The scope of the search.

filter - The filter that defines the conditions that must be fulfilled in order for an entry to be returned.

attributeDescriptions - The names of the attributes to be included with each entry.

Returns:

The new search request.

Throws:

PluginException - if the name or filter parameter could not decoded successfully.