Uses of Interface
org.forgerock.util.Function

Packages that use Function

Package	Description
org.forgerock.api.models	ForgeRock API Descriptor models.
org.forgerock.http.protocol	Models and manages elements of the Hypertext Transfer Protocol.
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.oauth.clients.facebook	Forgerock Facebook Client Implementation.
org.forgerock.oauth.clients.oauth2	OAuth 2.0 ForgeRock Client Implementation.
org.forgerock.oauth.clients.oidc	OpenID Connect ForgeRock Client Implementation.
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.secrets	Provides a unified API for accessing secrets of various kinds.
org.forgerock.secrets.credentials	Contains secret credential related API objects.
org.forgerock.secrets.keystore	Implementations of SecretStore for accessing keys stored in Java KeyStores, such as PKCS#11 Hardware Security Modules (HSMs) and PKCS#12 file-based encrypted key stores.
org.forgerock.util	Provides common interfaces and classes.
org.forgerock.util.promise	An implementation of the Promise API in Java.

Uses of Function in org.forgerock.api.models

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

Modifier and Type	Class	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.http.protocol

Methods in org.forgerock.http.protocol that return Function

Modifier and Type	Method	Description
static <V,E extends Exception> Function<NeverThrowsException,V,E>	Responses.noopExceptionFunction()	Utility method returning an empty function, whose goal is to ease the transformation of a Promise type.
static <E extends Exception> Function<E,Response,NeverThrowsException>	Responses.onExceptionInternalServerError()	Utility function that returns a Response whose status is Status.INTERNAL_SERVER_ERROR and the exception attached to the response as the cause.

Uses of Function in org.forgerock.json

Classes in org.forgerock.json that implement Function

Modifier and Type	Class	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	Description
static Function<JsonValue,byte[],JsonValueException>	JsonValueFunctions.base64Binary()	Returns a byte[] by converting the JsonValue using JsonValue.asString() and then Base64-decoding the result.
static Function<JsonValue,byte[],JsonValueException>	JsonValueFunctions.base64urlBinary()	Returns a byte[] by converting the JsonValue using JsonValue.asString() and then Base64url-decoding the result.
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,Instant,JsonValueException>	JsonValueFunctions.epochSecondsInstant()	Returns a Instant by converting the JsonValue into a number and interpreting that as the number of seconds since the UTC epoch as per Instant.ofEpochSecond(long).
static Function<JsonValue,File,JsonValueException>	JsonValueFunctions.file()	Returns the JSON string value as a File object.
static Function<JsonValue,JsonValue,JsonValueException>	JsonValueFunctions.identity()	Deprecated. use JsonValue::copy directly instead
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,Optional<JsonValue>,JsonValueException>	JsonValueFunctions.optional()	Return an Optional if the given JsonValue has a value, or Optional.empty() if the JsonValue contains a null value.
static <T> Function<JsonValue,Optional<T>,JsonValueException>	JsonValueFunctions.optionalOf(Function<JsonValue,T,JsonValueException> mappingFunction)	Return an Optional of a new type if the given JsonValue has a value, or Optional.empty() if the JsonValue contains a null value.
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,List<String>,JsonValueException>	JsonValueFunctions.stringOrListOfStrings()	Return a list of string values from the given JsonValue.
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	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 <T> Function<JsonValue,Optional<T>,JsonValueException>	JsonValueFunctions.optionalOf(Function<JsonValue,T,JsonValueException> mappingFunction)	Return an Optional of a new type if the given JsonValue has a value, or Optional.empty() if the JsonValue contains a null value.
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	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	Description
static Function<JsonValue,QueryFilter<JsonPointer>,JsonValueException>	JsonValueFunctions.queryFilter()	Parses and returns the JSON string value as a QueryFilter.
static Function<JsonValue,ResourcePath,JsonValueException>	JsonValueFunctions.resourcePath()	Returns the JSON string value as a ResourcePath.

Uses of Function in org.forgerock.oauth.clients.facebook

Methods in org.forgerock.oauth.clients.facebook that return Function

Modifier and Type	Method	Description
protected Function<JsonValue,JsonValue,OAuthException>	FacebookClient.validateClientId(DataStore dataStore, JsonValue storedData, String inputToken)

Uses of Function in org.forgerock.oauth.clients.oauth2

Fields in org.forgerock.oauth.clients.oauth2 declared as Function

Modifier and Type	Field	Description
protected Function<JsonValue,JsonValue,OAuthException>	OAuth2Client.addExpireTime	Adds the actual time the token expires.

Methods in org.forgerock.oauth.clients.oauth2 that return Function

Modifier and Type	Method	Description
protected Function<Void,JsonValue,OAuthException>	OAuth2Client.createPostAuthResponse(JsonValue storedData)	Creates the post auth response.
protected Function<JsonValue,UserInfo,OAuthException>	OAuth2Client.mapToUserInfo()	Creates a OAuth2UserInfo using a users raw profile.
protected Function<JsonValue,Void,OAuthException>	OAuth2Client.storeResponse(DataStore dataStore)	Stores all the information received from an authentication or authorization server.
protected static <T> Function<NoSuchSecretException,T,OAuthException>	OAuth2Client.throwIfNoClientSecret()	Handles a missing client secret.
protected Function<JsonValue,JsonValue,OAuthException>	OAuth2Client.validateClientId(DataStore dataStore, JsonValue storedData, String inputToken)	Compare client_id from access token associated data with configured client_id.

Uses of Function in org.forgerock.oauth.clients.oidc

Methods in org.forgerock.oauth.clients.oidc that return Function

Modifier and Type	Method	Description
protected Function<JsonValue,UserInfo,OAuthException>	OpenIDConnectClient.mapToUserInfo(JwtClaimsSet jwtClaims)	Maps a retrieved raw profile from the user info endpoint to an OpenIDConnectUserInfo object.
protected Function<JsonValue,JsonValue,OAuthException>	OpenIDConnectClient.validateSub(DataStore dataStore)	Validates the sub Claim in the UserInfo Response is an exact match to the sub Claim in the ID Token.

Uses of Function in org.forgerock.opendj.ldap

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

Modifier and Type	Method	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 Function<ByteString,Path,LocalizedIllegalArgumentException>	Functions.byteStringToPath()	Returns a function which parses Path 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	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.
<T,E extends Exception> Set<T>	AttributeParser.asSetOfString(Function<String,? extends T,E> f, Collection<? extends T> defaultValues)	Returns the values decoded as a set of Ts from their string representations using the provided Function, or defaultValues if the attribute does not contain any values.
<T,E extends Exception> Set<T>	AttributeParser.asSetOfString(Function<String,? extends T,E> f, T... defaultValues)	Returns the values decoded as a set of Ts from their string representations using the provided Function, or defaultValues if the attribute does not contain any values.
<T,E extends Exception> T	AttributeParser.asString(Function<String,? extends T,E> f)	Returns the first value decoded as a T from its string representation using the provided Function, or null if the attribute does not contain any values.
<T,E extends Exception> T	AttributeParser.asString(Function<String,? extends T,E> f, T defaultValue)	Returns the first value decoded as a T from its string representation using the provided Function, or the defaultValue 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	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	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	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.secrets

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

Modifier and Type	Method	Description
<T,E extends Exception> T	GenericSecret.reveal(Function<byte[],T,E> function)	Reveals the secret temporarily, allowing it to be used for its intended purpose.
<T,E extends Exception> T	GenericSecret.revealAsText(Charset charset, Function<char[],T,E> function)	Reveals the secret temporarily as characters in the given character set.
<T,E extends Exception> T	GenericSecret.revealAsUtf8(Function<char[],T,E> function)	Reveals the secret temporarily as characters in UTF-8.

Uses of Function in org.forgerock.secrets.credentials

Methods in org.forgerock.secrets.credentials with parameters of type Function

Modifier and Type	Method	Description
static <T extends Secret> CredentialPair<T>	CredentialPair.credentialPair(SecretReference<T> secretReference, Function<T,PrincipalAndSecret<T>,NoSuchSecretException> mapper)	Factory method to create a new instance of CredentialPair from a reference to a secret containing both the principal and secret.

Uses of Function in org.forgerock.secrets.keystore

Classes in org.forgerock.secrets.keystore that implement Function

Modifier and Type	Class	Description
class	HsmKeyStoreLoader	A loader for the KeyStoreSecretStore that knows how to load standard PKCS#11 Hardware Security Module (HSM) providers on our supported platforms.

Constructors in org.forgerock.secrets.keystore with parameters of type Function

Constructor	Description
KeyStoreSecretStore(Function<char[],KeyStore,KeyStoreException> keyStoreLoader, SecretReference<GenericSecret> keyStorePassword)	Initialises the keystore using the same password for the keystore and all keys and default configuration options.
KeyStoreSecretStore(Function<char[],KeyStore,KeyStoreException> keyStoreLoader, SecretReference<GenericSecret> keyStorePassword, SecretReference<GenericSecret> keyEntryPassword, Options options, KeyStoreSecretStore.StableIdProvider stableIdProvider)	Initialises the key store.
KeyStoreSecretStore(Function<char[],KeyStore,KeyStoreException> keyStoreLoader, SecretReference<GenericSecret> keyStorePassword, Options options)	Initialises the keystore using the same password for the keystore and all keys.

Uses of Function in org.forgerock.util

Classes in org.forgerock.util that implement Function

Modifier and Type	Class	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	Description
default <V> Function<VIN,V,E>	Function.andThen(Function<? super VOUT,? extends V,E> after)	Returns a composed function that first applies this function to its input, and then applies the after function to the result.
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.
default <V> Function<V,VOUT,E>	Function.compose(Function<? super V,? extends VIN,E> before)	Returns a composed function that first applies the before function to its input, and then applies this function to the result.
static <V,E extends Exception> Function<V,V,E>	Function.identity()	Returns an identity function that returns the input as output.

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

Modifier and Type	Method	Description
default <V> Function<VIN,V,E>	Function.andThen(Function<? super VOUT,? extends V,E> after)	Returns a composed function that first applies this function to its input, and then applies the after function to the result.
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.
default <V> Function<V,VOUT,E>	Function.compose(Function<? super V,? extends VIN,E> before)	Returns a composed function that first applies the before function to its input, and then applies this function to the result.
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	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 that return Function

Modifier and Type	Method	Description
static <V,E extends Exception> Function<NeverThrowsException,V,E>	NeverThrowsException.neverThrown()	Utility method returning an empty function, whose goal is to ease the transformation of a Promise type.

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

Modifier and Type	Method	Description
<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>	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, 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> Promise<VOUT,E>	PromiseImpl.then(Function<? super V,VOUT,E> onResult)
<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, Function<? super RuntimeException,VOUT,EOUT> onRuntimeException)
<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.
<EOUT extends Exception> Promise<V,EOUT>	PromiseImpl.thenCatch(Function<? super E,V,EOUT> onException)
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.
Promise<V,E>	PromiseImpl.thenCatchRuntimeException(Function<? super RuntimeException,V,E> onRuntimeException)