|
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 |
java.lang.Object
oracle.oud.requests.SearchRequestWrapper
public class SearchRequestWrapper
This class wraps a Search request.
Constructor Summary | |
---|---|
SearchRequestWrapper(SearchRequest request) Creates a new SearchRequestWrapper that wraps the specified search request. |
Method Summary | ||
---|---|---|
SearchRequest |
addAttribute(java.lang.String... attributeDescriptions) Adds the provided attribute name(s) to the list of attributes to be included with each entry that matches the search criteria. |
|
SearchRequest |
addControl(Control control) Adds the provided control to this request. |
|
java.lang.Object |
getAttachment(java.lang.String name) Retrieves the attachment with the specified name. |
|
java.util.Set<java.lang.String> |
getAttachmentNames() Retrieves the set of attachment names defined for this holder, as a mapping between the attachment name and the associated object. |
|
java.util.Set<java.lang.String> |
getAttributes() Returns a Set containing the list of attributes to be included with each entry that matches the search criteria. |
|
|
getControl(ControlDecoder<C> decoder) Decodes and returns the first control in this request having an OID corresponding to the provided control decoder. |
|
java.util.List<Control> |
getControls() Returns a List containing the controls included with this request. |
|
DereferenceAliasesPolicy |
getDereferenceAliasesPolicy() Returns an indication as to whether or not alias entries are to be dereferenced during the search. |
|
Filter |
getFilter() Returns the filter that defines the conditions that must be fulfilled in order for an entry to be returned. |
|
DN |
getName() Returns the distinguished name of the base entry relative to which the search is to be performed. |
|
SearchScope |
getScope() Returns the scope of the search. |
|
int |
getSizeLimit() Returns the size limit that should be used in order to restrict the maximum number of entries returned by the search. |
|
int |
getTimeLimit() Returns the time limit that should be used in order to restrict the maximum time (in seconds) allowed for the search. |
|
boolean |
isInternal() Returns true if this request is flagged as internal; false otherwise. |
|
boolean |
isTypesOnly() Indicates whether search results are to contain both attribute descriptions and values, or just attribute descriptions. |
|
java.lang.Object |
removeAttachment(java.lang.String name) Removes the attachment with the specified name. |
|
Request |
removeControl(Control control) Removes the provided control from this request. |
|
java.lang.Object |
setAttachment(java.lang.String name, java.lang.Object value) Sets the value of the specified attachment. |
|
SearchRequest |
setDereferenceAliasesPolicy(DereferenceAliasesPolicy policy) Sets the alias dereferencing policy to be used during the search. |
|
SearchRequest |
setFilter(Filter filter) Sets the filter that defines the conditions that must be fulfilled in order for an entry to be returned. |
|
SearchRequest |
setFilter(java.lang.String filter) Sets the filter that defines the conditions that must be fulfilled in order for an entry to be returned. |
|
SearchRequest |
setName(DN dn) Sets the distinguished name of the base entry relative to which the search is to be performed. |
|
SearchRequest |
setName(java.lang.String dn) Sets the distinguished name of the base entry relative to which the search is to be performed. |
|
SearchRequest |
setScope(SearchScope scope) Sets the scope of the search. |
|
SearchRequest |
setSizeLimit(int limit) Sets the size limit that should be used in order to restrict the maximum number of entries returned by the search. |
|
SearchRequest |
setTimeLimit(int limit) Sets the time limit that should be used in order to restrict the maximum time (in seconds) allowed for the search. |
|
SearchRequest |
setTypesOnly(boolean typesOnly) Specifies whether search results are to contain both attribute descriptions and values, or just attribute descriptions. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface oracle.oud.requests.Request |
---|
getControl, getControls, isInternal, removeControl |
Methods inherited from interface oracle.oud.plugin.AttachmentHolder |
---|
getAttachment, getAttachmentNames, removeAttachment, setAttachment |
Constructor Detail |
---|
public SearchRequestWrapper(SearchRequest request)
request
- the request to wrap.Method Detail |
---|
public SearchRequest addAttribute(java.lang.String... attributeDescriptions) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
SearchRequest
addAttribute
in interface SearchRequest
attributeDescriptions
- The name(s) of the attribute to be included with each entry.java.lang.UnsupportedOperationException
- If this search request does not permit attribute names to be added.java.lang.NullPointerException
- If attributeDescriptions
was null
.public SearchRequest addControl(Control control) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
Request
addControl
in interface Request
addControl
in interface SearchRequest
control
- The control to be added to this request.java.lang.UnsupportedOperationException
- If this request does not permit controls to be added.java.lang.NullPointerException
- If control
was null
.public java.util.Set<java.lang.String> getAttributes()
SearchRequest
Set
containing the list of attributes to be included with each entry that matches the search criteria. Attributes that are sub-types of listed attributes are implicitly included. The returned List
may be modified if permitted by this search request.getAttributes
in interface SearchRequest
List
containing the list of attributes.public DereferenceAliasesPolicy getDereferenceAliasesPolicy()
SearchRequest
getDereferenceAliasesPolicy
in interface SearchRequest
public Filter getFilter()
SearchRequest
getFilter
in interface SearchRequest
public DN getName()
SearchRequest
getName
in interface SearchRequest
public SearchScope getScope()
SearchRequest
getScope
in interface SearchRequest
public int getSizeLimit()
SearchRequest
A value of zero (the default) in this field indicates that no client-requested size limit restrictions are in effect. Servers may also enforce a maximum number of entries to return.
getSizeLimit
in interface SearchRequest
public int getTimeLimit()
SearchRequest
A value of zero (the default) in this field indicates that no client-requested time limit restrictions are in effect for the search. Servers may also enforce a maximum time limit for the search.
getTimeLimit
in interface SearchRequest
public boolean isTypesOnly()
SearchRequest
isTypesOnly
in interface SearchRequest
true
if only attribute descriptions (and not values) are to be returned, or false
(the default) if both attribute descriptions and values are to be returned.public SearchRequest setDereferenceAliasesPolicy(DereferenceAliasesPolicy policy) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
SearchRequest
setDereferenceAliasesPolicy
in interface SearchRequest
policy
- The alias dereferencing policy to be used during the search.java.lang.UnsupportedOperationException
- If this search request does not permit the alias dereferencing policy to be set.java.lang.NullPointerException
- If policy
was null
.public SearchRequest setFilter(Filter filter) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
SearchRequest
setFilter
in interface SearchRequest
filter
- The filter that defines the conditions that must be fulfilled in order for an entry to be returned.java.lang.UnsupportedOperationException
- If this search request does not permit the filter to be set.java.lang.NullPointerException
- If filter
was null
.public SearchRequest setFilter(java.lang.String filter) throws java.lang.UnsupportedOperationException, PluginException, java.lang.NullPointerException
SearchRequest
setFilter
in interface SearchRequest
filter
- The filter that defines the conditions that must be fulfilled in order for an entry to be returned.java.lang.UnsupportedOperationException
- If this search request does not permit the filter to be set.PluginException
- If filter
is not a valid LDAP string representation of a filter.java.lang.NullPointerException
- If filter
was null
.public SearchRequest setName(DN dn) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
SearchRequest
setName
in interface SearchRequest
dn
- The distinguished name of the base entry relative to which the search is to be performed.java.lang.UnsupportedOperationException
- If this search request does not permit the distinguished name to be set.java.lang.NullPointerException
- If dn
was null
.public SearchRequest setName(java.lang.String dn) throws PluginException, java.lang.UnsupportedOperationException, java.lang.NullPointerException
SearchRequest
setName
in interface SearchRequest
dn
- The distinguished name of the base entry relative to which the search is to be performed.PluginException
- If dn
could not be decoded.java.lang.UnsupportedOperationException
- If this search request does not permit the distinguished name to be set.java.lang.NullPointerException
- If dn
was null
.public SearchRequest setScope(SearchScope scope) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
SearchRequest
setScope
in interface SearchRequest
scope
- The scope of the search.java.lang.UnsupportedOperationException
- If this search request does not permit the scope to be set.java.lang.NullPointerException
- If scope
was null
.public SearchRequest setSizeLimit(int limit) throws java.lang.UnsupportedOperationException, PluginException
SearchRequest
A value of zero (the default) in this field indicates that no client-requested size limit restrictions are in effect. Servers may also enforce a maximum number of entries to return.
setSizeLimit
in interface SearchRequest
limit
- The size limit that should be used in order to restrict the maximum number of entries returned by the search.java.lang.UnsupportedOperationException
- If this search request does not permit the size limit to be set.PluginException
- If limit
was negative.public SearchRequest setTimeLimit(int limit) throws java.lang.UnsupportedOperationException, PluginException
SearchRequest
A value of zero (the default) in this field indicates that no client-requested time limit restrictions are in effect for the search. Servers may also enforce a maximum time limit for the search.
setTimeLimit
in interface SearchRequest
limit
- The time limit that should be used in order to restrict the maximum time (in seconds) allowed for the search.java.lang.UnsupportedOperationException
- If this search request does not permit the time limit to be set.PluginException
- If limit
was negative.public SearchRequest setTypesOnly(boolean typesOnly) throws java.lang.UnsupportedOperationException
SearchRequest
setTypesOnly
in interface SearchRequest
typesOnly
- true
if only attribute descriptions (and not values) are to be returned, or false
(the default) if both attribute descriptions and values are to be returned.java.lang.UnsupportedOperationException
- If this search request does not permit the types-only parameter to be set.public <C extends Control> C getControl(ControlDecoder<C> decoder) throws java.lang.NullPointerException, PluginException
Request
getControl
in interface Request
C
- The type of control to be decoded and returned.decoder
- The control decoder.null
if the control is not included with this request.java.lang.NullPointerException
- If decoder
was null
.PluginException
- If the control could not be decoded because it was malformed in some way (e.g. the control value was missing, or its content could not be decoded).public java.util.List<Control> getControls()
Request
List
containing the controls included with this request. The returned List
is immutable.getControls
in interface Request
List
containing the controls.public Request removeControl(Control control) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
Request
removeControl
in interface Request
control
- The control to be removed from this request.java.lang.UnsupportedOperationException
- If this request does not permit controls to be removed.java.lang.NullPointerException
- If control
was null
.public java.lang.Object removeAttachment(java.lang.String name)
AttachmentHolder
removeAttachment
in interface AttachmentHolder
name
- The name for the attachment to remove. It will be treated in a case-sensitive manner.null
if it does not exist.public java.lang.Object setAttachment(java.lang.String name, java.lang.Object value)
AttachmentHolder
setAttachment
in interface AttachmentHolder
name
- The name to use for the attachment.value
- The value to use for the attachment.null
if there was previously no such attachment.public java.lang.Object getAttachment(java.lang.String name)
AttachmentHolder
getAttachment
in interface AttachmentHolder
name
- The name for the attachment to retrieve. It will be treated in a case-sensitive manner.null
if it does not exist.public java.util.Set<java.lang.String> getAttachmentNames()
AttachmentHolder
getAttachmentNames
in interface AttachmentHolder
public boolean isInternal()
Request
true
if this request is flagged as internal; false
otherwise.
When a request is flagged internal, various components of the server may behave in a manner that is less restrictive. For example, attributes defined as NO-USER-MODIFICATION are allowed to be added, private backends are accessible, ...
isInternal
in interface Request
true
if this request is flagged as internal; false
otherwise.
|
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 |