oracle.oud.requests

Class SearchRequestWrapper

java.lang.Object

oracle.oud.requests.SearchRequestWrapper

All Implemented Interfaces:

AttachmentHolder, Request, SearchRequest

public class SearchRequestWrapper
extends java.lang.Object
implements SearchRequest

This class wraps a Search request.

Constructor Summary

Constructors

Constructor and Description
SearchRequestWrapper(SearchRequest request) Creates a new SearchRequestWrapper that wraps the specified search request.

Method Summary

Modifier and Type	Method and Description
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.
<C extends Control> C	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

SearchRequestWrapper

public SearchRequestWrapper(SearchRequest request)

Creates a new SearchRequestWrapper that wraps the specified search request.

Parameters:

request - the request to wrap.

Method Detail

addAttribute

public SearchRequest addAttribute(java.lang.String... attributeDescriptions)
                           throws java.lang.UnsupportedOperationException,
                                  java.lang.NullPointerException

Description copied from interface: SearchRequest

Adds the provided attribute name(s) to 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.

Specified by:

addAttribute in interface SearchRequest

Parameters:

attributeDescriptions - The name(s) of the attribute to be included with each entry.

Returns:

This search request.

Throws:

java.lang.UnsupportedOperationException - If this search request does not permit attribute names to be added.

java.lang.NullPointerException - If attributeDescriptions was null.

addControl

public SearchRequest addControl(Control control)
                         throws java.lang.UnsupportedOperationException,
                                java.lang.NullPointerException

Description copied from interface: Request

Adds the provided control to this request.

Specified by:

addControl in interface Request

Specified by:

addControl in interface SearchRequest

Parameters:

control - The control to be added to this request.

Returns:

This request.

Throws:

java.lang.UnsupportedOperationException - If this request does not permit controls to be added.

java.lang.NullPointerException - If control was null.

getAttributes

public java.util.Set<java.lang.String> getAttributes()

Description copied from interface: SearchRequest

Returns a 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.

Specified by:

getAttributes in interface SearchRequest

Returns:

A List containing the list of attributes.

getDereferenceAliasesPolicy

public DereferenceAliasesPolicy getDereferenceAliasesPolicy()

Description copied from interface: SearchRequest

Returns an indication as to whether or not alias entries are to be dereferenced during the search.

Specified by:

getDereferenceAliasesPolicy in interface SearchRequest

Returns:

The alias dereferencing policy.

getFilter

public Filter getFilter()

Description copied from interface: SearchRequest

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

Specified by:

getFilter in interface SearchRequest

Returns:

The search filter.

getName

public DN getName()

Description copied from interface: SearchRequest

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

Specified by:

getName in interface SearchRequest

Returns:

The distinguished name of the base entry.

getScope

public SearchScope getScope()

Description copied from interface: SearchRequest

Returns the scope of the search.

Specified by:

getScope in interface SearchRequest

Returns:

The search scope.

getSizeLimit

public int getSizeLimit()

Description copied from interface: SearchRequest

Returns the size limit that should be used in order to restrict the maximum number of entries returned by the search.

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.

Specified by:

getSizeLimit in interface SearchRequest

Returns:

The size limit that should be used in order to restrict the maximum number of entries returned by the search.

getTimeLimit

public int getTimeLimit()

Description copied from interface: SearchRequest

Returns the time limit that should be used in order to restrict the maximum time (in seconds) allowed for the search.

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.

Specified by:

getTimeLimit in interface SearchRequest

Returns:

The time limit that should be used in order to restrict the maximum time (in seconds) allowed for the search.

isTypesOnly

public boolean isTypesOnly()

Description copied from interface: SearchRequest

Indicates whether search results are to contain both attribute descriptions and values, or just attribute descriptions.

Specified by:

isTypesOnly in interface SearchRequest

Returns:

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.

setDereferenceAliasesPolicy

public SearchRequest setDereferenceAliasesPolicy(DereferenceAliasesPolicy policy)
                                          throws java.lang.UnsupportedOperationException,
                                                 java.lang.NullPointerException

Description copied from interface: SearchRequest

Sets the alias dereferencing policy to be used during the search.

Specified by:

setDereferenceAliasesPolicy in interface SearchRequest

Parameters:

policy - The alias dereferencing policy to be used during the search.

Returns:

This search request.

Throws:

java.lang.UnsupportedOperationException - If this search request does not permit the alias dereferencing policy to be set.

java.lang.NullPointerException - If policy was null.

setFilter

public SearchRequest setFilter(Filter filter)
                        throws java.lang.UnsupportedOperationException,
                               java.lang.NullPointerException

Description copied from interface: SearchRequest

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

Specified by:

setFilter in interface SearchRequest

Parameters:

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

Returns:

This search request.

Throws:

java.lang.UnsupportedOperationException - If this search request does not permit the filter to be set.

java.lang.NullPointerException - If filter was null.

setFilter

public SearchRequest setFilter(java.lang.String filter)
                        throws java.lang.UnsupportedOperationException,
                               PluginException,
                               java.lang.NullPointerException

Description copied from interface: SearchRequest

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

Specified by:

setFilter in interface SearchRequest

Parameters:

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

Returns:

This search request.

Throws:

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.

setName

public SearchRequest setName(DN dn)
                      throws java.lang.UnsupportedOperationException,
                             java.lang.NullPointerException

Description copied from interface: SearchRequest

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

Specified by:

setName in interface SearchRequest

Parameters:

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

Returns:

This search request.

Throws:

java.lang.UnsupportedOperationException - If this search request does not permit the distinguished name to be set.

java.lang.NullPointerException - If dn was null.

setName

public SearchRequest setName(java.lang.String dn)
                      throws PluginException,
                             java.lang.UnsupportedOperationException,
                             java.lang.NullPointerException

Description copied from interface: SearchRequest

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

Specified by:

setName in interface SearchRequest

Parameters:

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

Returns:

This search request.

Throws:

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.

setScope

public SearchRequest setScope(SearchScope scope)
                       throws java.lang.UnsupportedOperationException,
                              java.lang.NullPointerException

Description copied from interface: SearchRequest

Sets the scope of the search.

Specified by:

setScope in interface SearchRequest

Parameters:

scope - The scope of the search.

Returns:

This search request.

Throws:

java.lang.UnsupportedOperationException - If this search request does not permit the scope to be set.

java.lang.NullPointerException - If scope was null.

setSizeLimit

public SearchRequest setSizeLimit(int limit)
                           throws java.lang.UnsupportedOperationException,
                                  PluginException

Description copied from interface: SearchRequest

Sets the size limit that should be used in order to restrict the maximum number of entries returned by the search.

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.

Specified by:

setSizeLimit in interface SearchRequest

Parameters:

limit - The size limit that should be used in order to restrict the maximum number of entries returned by the search.

Returns:

This search request.

Throws:

java.lang.UnsupportedOperationException - If this search request does not permit the size limit to be set.

PluginException - If limit was negative.

setTimeLimit

public SearchRequest setTimeLimit(int limit)
                           throws java.lang.UnsupportedOperationException,
                                  PluginException

Description copied from interface: SearchRequest

Sets the time limit that should be used in order to restrict the maximum time (in seconds) allowed for the search.

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.

Specified by:

setTimeLimit in interface SearchRequest

Parameters:

limit - The time limit that should be used in order to restrict the maximum time (in seconds) allowed for the search.

Returns:

This search request.

Throws:

java.lang.UnsupportedOperationException - If this search request does not permit the time limit to be set.

PluginException - If limit was negative.

setTypesOnly

public SearchRequest setTypesOnly(boolean typesOnly)
                           throws java.lang.UnsupportedOperationException

Description copied from interface: SearchRequest

Specifies whether search results are to contain both attribute descriptions and values, or just attribute descriptions.

Specified by:

setTypesOnly in interface SearchRequest

Parameters:

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.

Returns:

This search request.

Throws:

java.lang.UnsupportedOperationException - If this search request does not permit the types-only parameter to be set.

getControl

public <C extends Control> C getControl(ControlDecoder<C> decoder)
                                 throws java.lang.NullPointerException,
                                        PluginException

Description copied from interface: Request

Decodes and returns the first control in this request having an OID corresponding to the provided control decoder.

Specified by:

getControl in interface Request

Type Parameters:

C - The type of control to be decoded and returned.

Parameters:

decoder - The control decoder.

Returns:

The decoded control, or null if the control is not included with this request.

Throws:

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).

getControls

public java.util.List<Control> getControls()

Description copied from interface: Request

Returns a List containing the controls included with this request. The returned List is immutable.

Specified by:

getControls in interface Request

Returns:

A List containing the controls.

removeControl

public Request removeControl(Control control)
                      throws java.lang.UnsupportedOperationException,
                             java.lang.NullPointerException

Description copied from interface: Request

Removes the provided control from this request.

Specified by:

removeControl in interface Request

Parameters:

control - The control to be removed from this request.

Returns:

This request.

Throws:

java.lang.UnsupportedOperationException - If this request does not permit controls to be removed.

java.lang.NullPointerException - If control was null.

removeAttachment

public java.lang.Object removeAttachment(java.lang.String name)

Description copied from interface: AttachmentHolder

Removes the attachment with the specified name.

Specified by:

removeAttachment in interface AttachmentHolder

Parameters:

name - The name for the attachment to remove. It will be treated in a case-sensitive manner.

Returns:

The attachment that was removed, or null if it does not exist.

setAttachment

public java.lang.Object setAttachment(java.lang.String name,
                                      java.lang.Object value)

Description copied from interface: AttachmentHolder

Sets the value of the specified attachment. If an attachment already exists with the same name, it will be replaced. Otherwise, a new attachment will be added.

Specified by:

setAttachment in interface AttachmentHolder

Parameters:

name - The name to use for the attachment.

value - The value to use for the attachment.

Returns:

The former value held by the attachment with the given name, or null if there was previously no such attachment.

getAttachment

public java.lang.Object getAttachment(java.lang.String name)

Description copied from interface: AttachmentHolder

Retrieves the attachment with the specified name.

Specified by:

getAttachment in interface AttachmentHolder

Parameters:

name - The name for the attachment to retrieve. It will be treated in a case-sensitive manner.

Returns:

The requested attachment object, or null if it does not exist.

getAttachmentNames

public java.util.Set<java.lang.String> getAttachmentNames()

Description copied from interface: AttachmentHolder

Retrieves the set of attachment names defined for this holder, as a mapping between the attachment name and the associated object.

Specified by:

getAttachmentNames in interface AttachmentHolder

Returns:

The set of attachments defined for this request.

isInternal

public boolean isInternal()

Description copied from interface: Request

Returns 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, ...

Specified by:

isInternal in interface Request

Returns:

true if this request is flagged as internal; false otherwise.