|
Oracle® Fusion Middleware Java API Reference for Oracle Unified Directory 11g Release 2 (11.1.2.2.0) E38583-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public static interface RequestContext.RequestBuilder
This interface is a builder to create new Request instances.
Method Summary | |
---|---|
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 |
---|
AddRequest newAddRequest(DN name) throws java.lang.IllegalArgumentException
add
request with the specified distinguished name.name
- The distinguished name of the entry to be added.add
request with the specified distinguished name.java.lang.IllegalArgumentException
- if the name
parameter is invalid.AddRequest newAddRequest(java.lang.String name) throws PluginException
add
request with the specified distinguished name.name
- The distinguished name of the entry to be added.add
request with the specified distinguished name.PluginException
- if the name
parameter could not decoded successfully.BindRequest newBindRequest(DN name, ByteString password) throws java.lang.IllegalArgumentException
bind
request having the provided distinguished name and password suitable for name/password authentication.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.bind
request.java.lang.IllegalArgumentException
- if the name
or password
parameter is invalid.BindRequest newBindRequest(java.lang.String name, char[] password) throws PluginException
bind
request having the provided distinguished name and password suitable for name/password authentication.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.bind
request.PluginException
- if the name
could not decoded successfully.CompareRequest newCompareRequest(DN name, AttributeDescription attributeDescription, ByteString assertionValue) throws java.lang.IllegalArgumentException
compare
request using the provided distinguished name, attribute name, and assertion value.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.compare
request.java.lang.IllegalArgumentException
- if the name
, attributeDescription
or assertionValue
parameter is invalid.CompareRequest newCompareRequest(java.lang.String name, java.lang.String attributeDescription, java.lang.Object assertionValue) throws PluginException
compare
request using the provided distinguished name, attribute name, and assertion value.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.compare
request.PluginException
- if the name
, attributeDescription
or assertionValue
parameter could not decoded successfully.DeleteRequest newDeleteRequest(DN name) throws java.lang.IllegalArgumentException
delete
request with the specified distinguished name.name
- The distinguished name of the entry to be deleted.delete
request.java.lang.IllegalArgumentException
- if the name
parameter is invalid.DeleteRequest newDeleteRequest(java.lang.String name) throws PluginException
delete
request with the specified distinguished name.name
- The distinguished name of the entry to be deleted.delete
request.PluginException
- if the name
parameter could not decoded successfully.ModifyRequest newModifyRequest(DN name) throws java.lang.IllegalArgumentException
modify
request with the specified distinguished name.name
- The distinguished name of the entry to be modified.modify
request.java.lang.IllegalArgumentException
- if the name
parameter is invalid.ModifyRequest newModifyRequest(java.lang.String name) throws PluginException
modify
request with the specified distinguished name.name
- The distinguished name of the entry to be modified.modify
request.PluginException
- if the name
parameter could not decoded successfully.ModifyDNRequest newModifyDNRequest(DN name, RDN newRDN) throws java.lang.IllegalArgumentException
modify Dn
request with the specified distinguished name and new RDN.name
- The distinguished name of the entry to be renamed.newRDN
- The new RDN of the entry.modify Dn
request.java.lang.IllegalArgumentException
- if the name
or newRDN
parameter is invalid.ModifyDNRequest newModifyDNRequest(java.lang.String name, java.lang.String newRDN) throws PluginException
modify Dn
request with the specified distinguished name and new RDN.name
- The distinguished name of the entry to be renamed.newRDN
- The new RDN of the entry.modify Dn
request.PluginException
- if the name
or newRDN
could not decoded successfully.SearchRequest newSearch(DN name, SearchScope scope, Filter filter, java.lang.String... attributeDescriptions) throws java.lang.IllegalArgumentException
search
request using the provided distinguished name, scope,filter and attribute descriptions.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.search
request.java.lang.IllegalArgumentException
- if the name
or filter
parameter is invalid.SearchRequest newSearch(java.lang.String name, SearchScope scope, java.lang.String filter, java.lang.String... attributeDescriptions) throws PluginException
search
request using the provided distinguished name, scope,filter and attribute descriptions.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.search
request.PluginException
- if the name
or filter
parameter could not decoded successfully.
|
Oracle® Fusion Middleware Java API Reference for Oracle Unified Directory 11g Release 2 (11.1.2.2.0) E38583-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |