Package org.ametys.core.util.ldap

Class ScopeEnumerator

java.lang.Object

org.ametys.core.util.ldap.ScopeEnumerator

All Implemented Interfaces:

Enumerator<String>

public class ScopeEnumerator
extends Object
implements Enumerator<String>

Enumerator for listing scopes supported in a LDAP query.

Constructor Summary

Constructors

Constructor	Description
ScopeEnumerator()

Method Summary

Modifier and Type	Method	Description
I18nizableText	getEntry(String value)	Retrieves a single label from a value.
Map<String,I18nizableText>	getTypedEntries()	Provides the enumerated values with their optional label.
static int	parseScope(String scope)	Parses a scope config parameter into a int for using it as SearchControls.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.runtime.model.Enumerator

getConfiguration

Constructor Details

ScopeEnumerator

public ScopeEnumerator()

Method Details

parseScope

public static int parseScope(String scope)
                      throws IllegalArgumentException

Parses a scope config parameter into a int for using it as SearchControls.

Parameters:

scope - the scope string representation.

Returns:

the scope as a SearchControls.*_SCOPE.

Throws:

IllegalArgumentException - if the given scope is not valid.

getEntry

public I18nizableText getEntry(String value)

Description copied from interface: Enumerator

Retrieves a single label from a value.

Specified by:

getEntry in interface Enumerator<String>

Parameters:

value - the value.

Returns:

the label or null if not found.

getTypedEntries

public Map<String,I18nizableText> getTypedEntries()

Description copied from interface: Enumerator

Provides the enumerated values with their optional label.

Specified by:

getTypedEntries in interface Enumerator<String>

Returns:

the enumerated values and their label.