Uses of Class
org.forgerock.opendj.ldap.SearchScope

Packages that use SearchScope

Package	Description
org.forgerock.opendj.ldap	Classes and interfaces for core types including connections, entries, and attributes.
org.forgerock.opendj.ldap.messages	Classes and interfaces for core LDAP requests/responses.
org.forgerock.opendj.rest2ldap.authz	This package contains Filter to authenticate and authorize LDAP connections.
org.opends.server.core	Contains various classes that comprise the core of the Directory Server codebase.
org.opends.server.types	Contains implementations for a number of Directory Server data types.
org.opends.server.types.operation	Contains a number of interfaces that are implemented by the various types of Directory Server operations.

Uses of SearchScope in org.forgerock.opendj.ldap

Fields in org.forgerock.opendj.ldap declared as SearchScope

Modifier and Type	Field	Description
static final SearchScope	SearchScope.BASE_OBJECT	The scope is constrained to the search base entry.
static final SearchScope	SearchScope.SINGLE_LEVEL	The scope is constrained to the immediate subordinates of the search base entry.
static final SearchScope	SearchScope.SUBORDINATES	The scope is constrained to all the subordinates of the search base entry, but does not include the search base entry itself (as wholeSubtree does).
static final SearchScope	SearchScope.WHOLE_SUBTREE	The scope is constrained to the search base entry and to all its subordinates.

Methods in org.forgerock.opendj.ldap that return SearchScope

Modifier and Type	Method	Description
SearchScope	LdapUrl.getScope()	Returns the search scope associated with this LDAP URL.
static SearchScope	SearchScope.valueOf(int intValue)	Returns the search scope having the specified integer value as defined in RFC 4511 section 4.5.1.2.
static SearchScope	SearchScope.valueOf(String name)	Returns the search scope having the specified name as defined in RFC 4511 section 4.5.1.2.

Methods in org.forgerock.opendj.ldap that return types with arguments of type SearchScope

Modifier and Type	Method	Description
static List<SearchScope>	SearchScope.values()	Returns an unmodifiable list containing the set of available search scopes indexed on their integer value as defined in RFC 4511 section 4.5.1.2.

Methods in org.forgerock.opendj.ldap with parameters of type SearchScope

Modifier and Type	Method	Description
boolean	Dn.isInScopeOf(String dn, SearchScope scope)	Returns true if this DN matches the provided base DN and search scope.
boolean	Dn.isInScopeOf(Dn dn, SearchScope scope)	Returns true if this DN matches the provided base DN and search scope.
ConnectionEntryReader	AbstractConnection.search(String baseObject, SearchScope scope, String filter, String... attributeDescriptions)
ConnectionEntryReader	AbstractConnectionWrapper.search(String baseObject, SearchScope scope, String filter, String... attributeDescriptions)	Searches the Directory Server using the provided search parameters.
ConnectionEntryReader	Connection.search(String baseObject, SearchScope scope, String filter, String... attributeDescriptions)	Searches the Directory Server using the provided search parameters.
SearchResultEntry	AbstractConnection.searchSingleEntry(String baseObject, SearchScope scope, String filter, String... attributeDescriptions)
SearchResultEntry	AbstractConnectionWrapper.searchSingleEntry(String baseObject, SearchScope scope, String filter, String... attributeDescriptions)	Searches the Directory Server for a single entry using the provided search parameters.
SearchResultEntry	Connection.searchSingleEntry(String baseObject, SearchScope scope, String filter, String... attributeDescriptions)	Searches the Directory Server for a single entry using the provided search parameters.

Constructors in org.forgerock.opendj.ldap with parameters of type SearchScope

Modifier	Constructor	Description
	LdapUrl(boolean isSecured, String host, Integer port, Dn name, SearchScope scope, Filter filter, String... attributes)	Creates a new LDAP URL including the full set of parameters for a search request.

Uses of SearchScope in org.forgerock.opendj.ldap.messages

Methods in org.forgerock.opendj.ldap.messages that return SearchScope

Modifier and Type	Method	Description
SearchScope	SearchRequest.scope()	Returns the value of the scope record component.

Methods in org.forgerock.opendj.ldap.messages with parameters of type SearchScope

Modifier and Type	Method	Description
static SearchRequest	Requests.newSearchRequest(String name, SearchScope scope)	Creates a new search request using the provided distinguished name and scope.
static SearchRequest	Requests.newSearchRequest(String name, SearchScope scope, String filter, String... attributeDescriptions)	Creates a new search request using the provided distinguished name, scope and filter, decoded using the default schema.
static SearchRequest	Requests.newSearchRequest(String name, SearchScope scope, DereferenceAliasesPolicy dereferenceAliasesPolicy, int sizeLimit, int timeLimit, boolean typesOnly, String filter, String... attributeDescriptions)	Creates a new search request with all parameters.
static SearchRequest	Requests.newSearchRequest(Dn name, SearchScope scope)	Creates a new search request using the provided distinguished name and scope.
static SearchRequest	Requests.newSearchRequest(Dn name, SearchScope scope, DereferenceAliasesPolicy dereferenceAliasesPolicy, int sizeLimit, int timeLimit, boolean typesOnly, Filter filter, String... attributeDescriptions)	Creates a new search request with all parameters.
static SearchRequest	Requests.newSearchRequest(Dn name, SearchScope scope, DereferenceAliasesPolicy dereferenceAliasesPolicy, int sizeLimit, int timeLimit, boolean typesOnly, Filter filter, List<String> attributeDescriptions, List<Control> controls)	Creates a new search request with all parameters.
static SearchRequest	Requests.newSearchRequest(Dn name, SearchScope scope, Filter filter, String... attributeDescriptions)	Creates a new search request using the provided distinguished name, scope and filter.
static SearchRequest	Requests.newSingleEntrySearchRequest(String name, SearchScope scope, String filter, String... attributeDescriptions)	Creates a new search request for a single entry, using the provided distinguished name, scope and filter, decoded using the default schema.
static SearchRequest	Requests.newSingleEntrySearchRequest(Dn name, SearchScope scope, Filter filter, String... attributeDescriptions)	Creates a new search request for a single entry, using the provided distinguished name, scope and filter.
SearchRequest	SearchRequest.withNameAndScope(Dn name, SearchScope scope)	Create a new SearchRequest from existing one with new distinguished name and the scope of the search.

Constructors in org.forgerock.opendj.ldap.messages with parameters of type SearchScope

Modifier	Constructor	Description
	SearchRequest(Dn name, SearchScope scope, DereferenceAliasesPolicy dereferenceAliasesPolicy, int sizeLimit, int timeLimit, boolean typesOnly, Filter filter, List<String> attributes, List<Control> controls)	Creates a new SearchRequest.

Uses of SearchScope in org.forgerock.opendj.rest2ldap.authz

Methods in org.forgerock.opendj.rest2ldap.authz with parameters of type SearchScope

Modifier and Type	Method	Description
static AuthenticationStrategy	AuthenticationStrategies.newSearchThenBindStrategy(LdapClient searchLdapClient, LdapClient bindLdapClient, Dn baseDN, SearchScope searchScope, String filterTemplate)	Creates an AuthenticationStrategy performing authentication against an LDAP server by first performing a lookup of the entry to bind with.

Uses of SearchScope in org.opends.server.core

Methods in org.opends.server.core that return SearchScope

Modifier and Type	Method	Description
final SearchScope	SearchOperation.getScope()	Retrieves the scope for this search operation.

Methods in org.opends.server.core with parameters of type SearchScope

Modifier and Type	Method	Description
Flowable<Entry>	Group.getAllMembers(Dn baseDN, SearchScope scope, Filter filter)	Retrieves an iterator that may be used to cursor through the entries of the members contained in this group, or its nested groups.
final void	SearchOperation.setScope(SearchScope scope)	Specifies the scope for this search operation.

Uses of SearchScope in org.opends.server.types

Methods in org.opends.server.types that return SearchScope

Modifier and Type	Method	Description
SearchScope	LDAPURL.getScope()	Retrieves the search scope for this LDAP URL.
SearchScope	VirtualAttributeRule.getScope()	Retrieves the scope of entries in the base DNs that are eligible to have this virtual attribute.

Constructors in org.opends.server.types with parameters of type SearchScope

Modifier	Constructor	Description
	VirtualAttributeRule(AttributeType attributeType, VirtualAttributeProvider<? extends VirtualAttributeCfg> provider, Set<Dn> baseDNs, SearchScope scope, Set<Dn> groupDNs, Set<Filter> anyFilter, VirtualAttributeCfgDefn.ConflictBehavior conflictBehavior, ServerContext serverContext)	Creates a new virtual attribute rule with the provided information.

Uses of SearchScope in org.opends.server.types.operation

Methods in org.opends.server.types.operation that return SearchScope

Modifier and Type	Method	Description
SearchScope	InProgressSearchOperation.getScope()	Retrieves the scope for this search operation.
SearchScope	PostOperationSearchOperation.getScope()	Retrieves the scope for this search operation.
SearchScope	PostResponseSearchOperation.getScope()	Retrieves the scope for this search operation.
SearchScope	PreOperationSearchOperation.getScope()	Retrieves the scope for this search operation.
SearchScope	PreParseSearchOperation.getScope()	Retrieves the scope for this search operation.

Methods in org.opends.server.types.operation with parameters of type SearchScope

Modifier and Type	Method	Description
void	PreParseSearchOperation.setScope(SearchScope scope)	Specifies the scope for this search operation.