org.opends.server.protocols.internal

Class Requests

java.lang.Object

org.opends.server.protocols.internal.Requests

public final class Requests
extends Object

This class contains various methods for creating and manipulating requests.

All copy constructors of the form copyOfXXXRequest perform deep copies of their request parameter. More specifically, any controls, modifications, and attributes contained within the response will be duplicated.

Similarly, all unmodifiable views of request returned by methods of the form unmodifiableXXXRequest return deep unmodifiable views of their request parameter. More specifically, any controls, modifications, and attributes contained within the returned request will be unmodifiable.

See Also:

Requests

Method Summary

Methods

Modifier and Type	Method and Description
static SearchRequest	newSearchRequest(DN name, org.forgerock.opendj.ldap.SearchScope scope) Return a new search request object.
static SearchRequest	newSearchRequest(DN name, org.forgerock.opendj.ldap.SearchScope scope, SearchFilter filter, String... attributeDescriptions) Creates a new search request using the provided distinguished name, scope, and filter.
static SearchRequest	newSearchRequest(DN name, org.forgerock.opendj.ldap.SearchScope scope, String filter) Return a new search request object.
static SearchRequest	newSearchRequest(String name, org.forgerock.opendj.ldap.SearchScope scope, String filter) Return a new search request object.
static SearchRequest	newSearchRequest(String name, org.forgerock.opendj.ldap.SearchScope scope, String filter, String... attributeDescriptions) Creates a new search request using the provided distinguished name, scope, and filter, decoded using the default schema.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newSearchRequest

public static SearchRequest newSearchRequest(DN name,
                             org.forgerock.opendj.ldap.SearchScope scope,
                             SearchFilter filter,
                             String... attributeDescriptions)
                                      throws NullPointerException

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

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:

NullPointerException - If the name, scope, or filter were null.

newSearchRequest

public static SearchRequest newSearchRequest(String name,
                             org.forgerock.opendj.ldap.SearchScope scope,
                             String filter,
                             String... attributeDescriptions)
                                      throws NullPointerException,
                                             LocalizedIllegalArgumentException,
                                             DirectoryException

Creates a new search request using the provided distinguished name, scope, and filter, decoded using the default schema.

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:

DirectoryException - If a problem occurs while decoding the provided string as a search filter.

LocalizedIllegalArgumentException - If name could not be decoded using the default schema, or if filter is not a valid LDAP string representation of a filter.

NullPointerException - If the name, scope, or filter were null.

newSearchRequest

public static SearchRequest newSearchRequest(String name,
                             org.forgerock.opendj.ldap.SearchScope scope,
                             String filter)
                                      throws DirectoryException

Return a new search request object.

Parameters:

name - the dn

scope - the search scope

filter - the search filter

Returns:

a new search request object

Throws:

DirectoryException - if a problem occurs

See Also:

newSearchRequest(DN, SearchScope, SearchFilter, String...)

newSearchRequest

public static SearchRequest newSearchRequest(DN name,
                             org.forgerock.opendj.ldap.SearchScope scope,
                             String filter)
                                      throws DirectoryException

Return a new search request object.

Parameters:

name - the dn

scope - the search scope

filter - the search filter

Returns:

a new search request object

Throws:

DirectoryException - if a problem occurs

See Also:

newSearchRequest(DN, SearchScope, SearchFilter, String...)

newSearchRequest

public static SearchRequest newSearchRequest(DN name,
                             org.forgerock.opendj.ldap.SearchScope scope)

Return a new search request object.

Parameters:

name - the dn

scope - the search scope

Returns:

a new search request object

See Also:

newSearchRequest(DN, SearchScope, SearchFilter, String...)