Uses of Interface
org.forgerock.util.Function

Packages that use Function

Package	Description
org.forgerock.api.models	ForgeRock API Descriptor models.
org.forgerock.config.util	Contains utility classes for commons config.
org.forgerock.json	Provides an API for the traversal and manipulation of JSON object model structures in Java.
org.forgerock.json.resource	Classes and interfaces for core types including connections, request handlers, resources, and their exceptions.
org.forgerock.opendj.ldap	Classes and interfaces for core types including connections, entries, and attributes.
org.forgerock.opendj.ldap.schema	Classes and interfaces for constructing and querying LDAP schemas.
org.forgerock.opendj.rest2ldap	APIs for implementing REST to LDAP gateways.
org.forgerock.opendj.rest2ldap.authz	This package contains Filter to authenticate and authorize LDAP connections.
org.forgerock.opendj.setup.model	Contains code of the opendj setup model.
org.forgerock.util	Provides common interfaces and classes.
org.forgerock.util.promise	An implementation of the Promise API in Java.
org.opends.server.core	Contains various classes that comprise the core of the Directory Server codebase.

Uses of Function in org.forgerock.api.models

Classes in org.forgerock.api.models that implement Function

Modifier and Type	Class and Description
class	TranslateJsonSchema Iterates over each JsonValue node in the JsonValue structure and if it's a String marked for translation, It replaces the String with a LocalizableString.

Uses of Function in org.forgerock.config.util

Methods in org.forgerock.config.util with parameters of type Function

Modifier and Type	Method and Description
JsonValuePropertyEvaluator.CoercionFunctionSpec	JsonValuePropertyEvaluator.CoercionFunctionSpecBuilder.using(Function<JsonValue,Object,JsonValueException> function) Specify the function that will convert the matched JSON into an object.

Uses of Function in org.forgerock.json

Classes in org.forgerock.json that implement Function

Modifier and Type	Class and Description
class	JsonValueTraverseFunction An implementation of Function that recursively traverses the JsonValue and applies some transformation if needed.

Methods in org.forgerock.json that return Function

Modifier and Type	Method and Description
static Function<JsonValue,Charset,JsonValueException>	JsonValueFunctions.charset() Returns the JSON string value as a character set used for byte encoding/decoding.
static Function<JsonValue,JsonValue,JsonValueException>	JsonValueFunctions.deepTransformBy(Function<JsonValue,?,JsonValueException> function) Returns the JSON value as the result of a deep JsonValue object-traversal, applying the provided transform function to each element.
static Function<JsonValue,Duration,JsonValueException>	JsonValueFunctions.duration() Returns the JSON string value as a Duration.
static <T extends Enum<T>> Function<JsonValue,T,JsonValueException>	JsonValueFunctions.enumConstant(Class<T> type) Returns the JSON string value as an enum constant of the specified enum type.
static Function<JsonValue,File,JsonValueException>	JsonValueFunctions.file() Returns the JSON string value as a File object.
static Function<JsonValue,JsonValue,JsonValueException>	JsonValueFunctions.identity() Returns an identity function that will copy the input JsonValue.
static Function<JsonValue,Instant,JsonValueException>	JsonValueFunctions.instant() Returns a Function to transform a JsonValue representing a UTC format datetime to an Instant.
static Function<JsonValue,Integer,NumberFormatException>	JsonValueFunctions.integer() Returns an Integer by converting the JsonValue using JsonValue.asInteger(), or by parsing the JsonValue string using Integer.parseInt(String).
static <V,E extends Exception> Function<JsonValue,List<V>,E>	JsonValueFunctions.listOf(Function<JsonValue,V,E> transformFunction) Returns the JSON value as a List containing objects whose type (and value) is specified by a transformation function.
static Function<JsonValue,Boolean,NeverThrowsException>	JsonValueFunctions.parseBoolean() Returns a Boolean by converting the JsonValue using JsonValue.asLong(), or by parsing the JsonValue string using Boolean.parseBoolean(String).
static Function<JsonValue,Long,NumberFormatException>	JsonValueFunctions.parseLong() Returns a Long by converting the JsonValue using JsonValue.asLong(), or by parsing the JsonValue string using Long.parseLong(String).
static Function<JsonValue,Pattern,JsonValueException>	JsonValueFunctions.pattern() Returns the JSON string value as a regular expression pattern.
static Function<JsonValue,JsonPointer,JsonValueException>	JsonValueFunctions.pointer() Returns the JSON string value as a JSON pointer.
static <V> Function<JsonValue,Set<V>,JsonValueException>	JsonValueFunctions.setOf(Class<V> type) Returns the JSON value as a Set containing objects whose type (and value) is specified by the parameter type.
static <V,E extends Exception> Function<JsonValue,Set<V>,E>	JsonValueFunctions.setOf(Function<JsonValue,V,E> transformFunction) Returns the JSON value as a Set containing objects whose type (and value) is specified by a transformation function.
static Function<JsonValue,URI,JsonValueException>	JsonValueFunctions.uri() Returns the JSON string value as a uniform resource identifier.
static Function<JsonValue,URL,JsonValueException>	JsonValueFunctions.url() Returns the JSON string value as a uniform resource locator.
static Function<JsonValue,UUID,JsonValueException>	JsonValueFunctions.uuid() Returns the JSON string value as a universally unique identifier (UUID).

Methods in org.forgerock.json with parameters of type Function

Modifier and Type	Method and Description
<V,E extends Exception> V	JsonValue.as(Function<JsonValue,V,E> transformFunction) Returns the JSON value as an object whose type (and value) is specified by a transformation function.
static Function<JsonValue,JsonValue,JsonValueException>	JsonValueFunctions.deepTransformBy(Function<JsonValue,?,JsonValueException> function) Returns the JSON value as the result of a deep JsonValue object-traversal, applying the provided transform function to each element.
static <V,E extends Exception> Function<JsonValue,List<V>,E>	JsonValueFunctions.listOf(Function<JsonValue,V,E> transformFunction) Returns the JSON value as a List containing objects whose type (and value) is specified by a transformation function.
static <V,E extends Exception> Function<JsonValue,Set<V>,E>	JsonValueFunctions.setOf(Function<JsonValue,V,E> transformFunction) Returns the JSON value as a Set containing objects whose type (and value) is specified by a transformation function.

Constructors in org.forgerock.json with parameters of type Function

Constructor and Description
JsonValueTraverseFunction(Function<JsonValue,?,JsonValueException> transform) Construct the traversal function with a transformation function to apply to each array element nested object attribute value element, or primitive element.

Uses of Function in org.forgerock.json.resource

Methods in org.forgerock.json.resource that return Function

Modifier and Type	Method and Description
static Function<JsonValue,ResourcePath,JsonValueException>	JsonValueFunctions.resourcePath() Returns the JSON string value as a ResourcePath.

Uses of Function in org.forgerock.opendj.ldap

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

Modifier and Type	Method and Description
static Function<ByteString,Boolean,LocalizedIllegalArgumentException>	Functions.byteStringToBoolean() Returns a function which parses Boolean values.
static Function<ByteString,Dn,LocalizedIllegalArgumentException>	Functions.byteStringToDn() Returns a function which parses DNs using the default schema.
static Function<ByteString,Dn,LocalizedIllegalArgumentException>	Functions.byteStringToDn(Schema schema) Returns a function which parses DNs using the provided schema.
static Function<ByteString,GeneralizedTime,LocalizedIllegalArgumentException>	Functions.byteStringToGeneralizedTime() Returns a function which parses generalized time strings.
static Function<ByteString,Integer,LocalizedIllegalArgumentException>	Functions.byteStringToInteger() Returns a function which parses Integer string values.
static Function<ByteString,Long,LocalizedIllegalArgumentException>	Functions.byteStringToLong() Returns a function which parses Long string values.
static <M,N> Function<M,N,NeverThrowsException>	Functions.constant(N constant) Creates a function that returns constant value for any input.

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

Modifier and Type	Method and Description
<T,E extends Exception> T	AttributeParser.as(Function<ByteString,? extends T,E> f) Returns the first value decoded as a T using the provided Function, or null if the attribute does not contain any values.
<T,E extends Exception> T	AttributeParser.as(Function<ByteString,? extends T,E> f, T defaultValue) Returns the first value decoded as a T using the provided Function, or defaultValue if the attribute does not contain any values.
<T,E extends Exception> Set<T>	AttributeParser.asSetOf(Function<ByteString,? extends T,E> f, Collection<? extends T> defaultValues) Returns the values decoded as a set of Ts using the provided Function, or defaultValues if the attribute does not contain any values.
<T,E extends Exception> Set<T>	AttributeParser.asSetOf(Function<ByteString,? extends T,E> f, T... defaultValues) Returns the values decoded as a set of Ts using the provided Function, or defaultValues if the attribute does not contain any values.
<VOUT> LdapPromise<VOUT>	LdapPromise.then(Function<? super S,VOUT,LdapException> onResult)

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

Constructor and Description
ConsistentHashMap(Function<Object,Integer,NeverThrowsException> hashFunction) Creates a new consistent hash map which will hash keys using the provided hash function.

Uses of Function in org.forgerock.opendj.ldap.schema

Methods in org.forgerock.opendj.ldap.schema that return Function

Modifier and Type	Method and Description
Function<Dn,Entry,LdapException>	SchemaValidationPolicy.checkDitStructureRulesParentEntryResolver() Returns the parent entry resolver which should be used for retrieving the parent entry during DIT structure rule validation.

Methods in org.forgerock.opendj.ldap.schema with parameters of type Function

Modifier and Type	Method and Description
SchemaValidationPolicy	SchemaValidationPolicy.checkDitStructureRules(SchemaValidationPolicy.Action policy, Function<Dn,Entry,LdapException> parentEntryResolver) Specifies the policy for validating entries against structure rules defined in the schema.

Uses of Function in org.forgerock.opendj.rest2ldap

Methods in org.forgerock.opendj.rest2ldap with parameters of type Function

Modifier and Type	Method and Description
SimplePropertyMapper	SimplePropertyMapper.decoder(Function<ByteString,?,? extends Exception> f) Sets the decoder which will be used for converting LDAP attribute values to JSON values.
SimplePropertyMapper	SimplePropertyMapper.encoder(Function<Object,ByteString,? extends Exception> f) Sets the encoder which will be used for converting JSON values to LDAP attribute values.
protected ConditionalFilters.ConditionalFilter	Rest2LdapHttpApplication.newBasicAuthenticationFilter(AuthenticationStrategy authenticationStrategy, Function<org.forgerock.http.protocol.Headers,Pair<String,String>,NeverThrowsException> credentialsExtractor) Gets a Filter in charge of performing the HTTP-Basic Authentication.

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

Methods in org.forgerock.opendj.rest2ldap.authz that return Function

Modifier and Type	Method and Description
static Function<org.forgerock.http.protocol.Headers,Pair<String,String>,NeverThrowsException>	CredentialExtractors.httpBasicExtractor() Creates a function which extracts the user's credentials from the standard HTTP Basic header.
static Function<org.forgerock.http.protocol.Headers,Pair<String,String>,NeverThrowsException>	CredentialExtractors.newCustomHeaderExtractor(String customHeaderUsername, String customHeaderPassword) Creates a function which extracts the user's credentials from custom HTTP header in addition of the standard HTTP Basic one.

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

Modifier and Type	Method and Description
static ConditionalFilters.ConditionalFilter	Authorization.newConditionalHttpBasicAuthenticationFilter(AuthenticationStrategy authenticationStrategy, Function<org.forgerock.http.protocol.Headers,Pair<String,String>,NeverThrowsException> credentialsExtractor) Creates a new ConditionalFilters.ConditionalFilter performing authentication.

Uses of Function in org.forgerock.opendj.setup.model

Methods in org.forgerock.opendj.setup.model with parameters of type Function

Modifier and Type	Method and Description
static <T2> Profile.ParameterType<T2>	Profile.ParameterType.of(String name, Function<String,T2,com.forgerock.opendj.cli.ArgumentException> parse) Creates and returns a new parameter type object associated to provided class.

Uses of Function in org.forgerock.util

Classes in org.forgerock.util that implement Function

Modifier and Type	Class and Description
class	CloseSilentlyFunction<VIN extends Closeable,VOUT,E extends Exception> Function that silently closes an input-parameter after a delegate-function's apply(Object) is invoked.

Methods in org.forgerock.util that return Function

Modifier and Type	Method and Description
static <IN extends Closeable,OUT,EX extends Exception> Function<IN,OUT,EX>	CloseSilentlyFunction.closeSilently(Function<IN,OUT,EX> delegate) Wraps a delegate function in a CloseSilentlyFunction.

Methods in org.forgerock.util with parameters of type Function

Modifier and Type	Method and Description
static <IN extends Closeable,OUT,EX extends Exception> Function<IN,OUT,EX>	CloseSilentlyFunction.closeSilently(Function<IN,OUT,EX> delegate) Wraps a delegate function in a CloseSilentlyFunction.
static <T,R,E extends Exception> Function<T,R>	LambdaExceptionUtils.rethrowFunction(Function<T,R,E> function) Wrap a throwing Function to comply with Function's no checked exception signature.

Constructors in org.forgerock.util with parameters of type Function

Constructor and Description
CloseSilentlyFunction(Function<VIN,VOUT,E> delegate) Creates a new CloseSilentlyFunction instance.

Uses of Function in org.forgerock.util.promise

Methods in org.forgerock.util.promise with parameters of type Function

Modifier and Type	Method and Description
<VOUT> Promise<VOUT,E>	PromiseImpl.then(Function<? super V,VOUT,E> onResult)
<VOUT> Promise<VOUT,E>	Promise.then(Function<? super V,VOUT,E> onResult) Submits the provided function for execution once this Promise has completed with a result, and returns a new Promise representing the outcome of the function.
<VOUT,EOUT extends Exception> Promise<VOUT,EOUT>	PromiseImpl.then(Function<? super V,VOUT,EOUT> onResult, Function<? super E,VOUT,EOUT> onException)
<VOUT,EOUT extends Exception> Promise<VOUT,EOUT>	PromiseImpl.then(Function<? super V,VOUT,EOUT> onResult, Function<? super E,VOUT,EOUT> onException)
<VOUT,EOUT extends Exception> Promise<VOUT,EOUT>	Promise.then(Function<? super V,VOUT,EOUT> onResult, Function<? super E,VOUT,EOUT> onException) Submits the provided functions for execution once this Promise has completed (with a result or an exception), and returns a new Promise representing the outcome of the invoked function.
<VOUT,EOUT extends Exception> Promise<VOUT,EOUT>	Promise.then(Function<? super V,VOUT,EOUT> onResult, Function<? super E,VOUT,EOUT> onException) Submits the provided functions for execution once this Promise has completed (with a result or an exception), and returns a new Promise representing the outcome of the invoked function.
<VOUT,EOUT extends Exception> Promise<VOUT,EOUT>	PromiseImpl.then(Function<? super V,VOUT,EOUT> onResult, Function<? super E,VOUT,EOUT> onException, Function<? super RuntimeException,VOUT,EOUT> onRuntimeException)
<VOUT,EOUT extends Exception> Promise<VOUT,EOUT>	PromiseImpl.then(Function<? super V,VOUT,EOUT> onResult, Function<? super E,VOUT,EOUT> onException, Function<? super RuntimeException,VOUT,EOUT> onRuntimeException)
<VOUT,EOUT extends Exception> Promise<VOUT,EOUT>	PromiseImpl.then(Function<? super V,VOUT,EOUT> onResult, Function<? super E,VOUT,EOUT> onException, Function<? super RuntimeException,VOUT,EOUT> onRuntimeException)
<VOUT,EOUT extends Exception> Promise<VOUT,EOUT>	Promise.then(Function<? super V,VOUT,EOUT> onResult, Function<? super E,VOUT,EOUT> onException, Function<? super RuntimeException,VOUT,EOUT> onRuntimeException) Submits the provided functions for execution once this Promise has completed (with a result or an exception or a RuntimeException), and returns a new Promise representing the outcome of the invoked function.
<VOUT,EOUT extends Exception> Promise<VOUT,EOUT>	Promise.then(Function<? super V,VOUT,EOUT> onResult, Function<? super E,VOUT,EOUT> onException, Function<? super RuntimeException,VOUT,EOUT> onRuntimeException) Submits the provided functions for execution once this Promise has completed (with a result or an exception or a RuntimeException), and returns a new Promise representing the outcome of the invoked function.
<VOUT,EOUT extends Exception> Promise<VOUT,EOUT>	Promise.then(Function<? super V,VOUT,EOUT> onResult, Function<? super E,VOUT,EOUT> onException, Function<? super RuntimeException,VOUT,EOUT> onRuntimeException) Submits the provided functions for execution once this Promise has completed (with a result or an exception or a RuntimeException), and returns a new Promise representing the outcome of the invoked function.
<EOUT extends Exception> Promise<V,EOUT>	PromiseImpl.thenCatch(Function<? super E,V,EOUT> onException)
<EOUT extends Exception> Promise<V,EOUT>	Promise.thenCatch(Function<? super E,V,EOUT> onException) Submits the provided function for execution once this Promise has not completed with a result (has completed with an exception), and returns a new Promise representing the outcome of the function.
Promise<V,E>	PromiseImpl.thenCatchRuntimeException(Function<? super RuntimeException,V,E> onRuntimeException)
Promise<V,E>	Promise.thenCatchRuntimeException(Function<? super RuntimeException,V,E> onRuntimeException) Submits the provided function for execution once this Promise has not completed with a result nor with an exception but with a RuntimeException, and returns a new Promise representing the outcome of the function.

Uses of Function in org.opends.server.core

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

Modifier and Type	Method and Description
<R,E extends Exception> R	GroupManager.doWithSharedLock(Function<Void,R,E> function) Executes the provided function after acquiring this group manager's read lock.