Uses of Interface
org.forgerock.util.Function
Package
Description
Models and manages elements of the Hypertext Transfer Protocol.
Provides an API for the traversal and manipulation of JSON object model structures in Java.
Classes and interfaces for core types including connections, request
handlers, resources, and their exceptions.
This package contains the OAuth2 Token validation filter that acts as an OAuth 2 Resource Server.
Collection of heaplets supporting OAuth2 client authentication Filters.
Manages collections or "heaps" of associated objects, initialized from
declarative configuration artifacts.
Provides the Common Secrets API for accessing secrets of various kinds.
This package contains classes used to perform JWT validation.
Miscellaneous utility classes.
Provides a unified API for accessing secrets of various kinds.
Contains secret credential related API objects.
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.Provides common interfaces and classes.
An implementation of the
Promise
API in Java.-
Uses of Function in org.forgerock.http.protocol
Modifier and TypeMethodDescriptionstatic <V,
E extends Exception>
Function<NeverThrowsException,V, E> Responses.noopExceptionFunction()
Utility method returning an empty function, whose goal is to ease the transformation of aPromise
type.static <E extends Exception>
Function<E,Response, NeverThrowsException> Responses.onExceptionInternalServerError()
Utility function that returns aResponse
whose status isStatus.INTERNAL_SERVER_ERROR
and the exception attached to the response as the cause. -
Uses of Function in org.forgerock.json
Modifier and TypeClassDescriptionclass
Modifier and TypeMethodDescriptionstatic Function<JsonValue,
byte[], JsonValueException> JsonValueFunctions.base64Binary()
Returns abyte[]
by converting the JsonValue usingJsonValue.asString()
and thenBase64
-decoding the result.static Function<JsonValue,
byte[], JsonValueException> JsonValueFunctions.base64urlBinary()
Returns abyte[]
by converting the JsonValue usingJsonValue.asString()
and thenBase64url
-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 transformfunction
to each element.static Function<JsonValue,
Duration, JsonValueException> JsonValueFunctions.duration()
Returns the JSON string value as aDuration
.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 aInstant
by converting the JsonValue into a number and interpreting that as the number of seconds since the UTC epoch as perInstant.ofEpochSecond(long)
.static Function<JsonValue,
File, JsonValueException> JsonValueFunctions.file()
Returns the JSON string value as aFile
object.static Function<JsonValue,
JsonValue, JsonValueException> JsonValueFunctions.identity()
Deprecated.static Function<JsonValue,
Instant, JsonValueException> JsonValueFunctions.instant()
JsonValueFunctions.integer()
Returns anInteger
by converting the JsonValue usingJsonValue.asInteger()
, or by parsing the JsonValue string usingInteger.parseInt(String)
.Returns the JSON value as aList
containing objects whose type (and value) is specified by a transformation function.static Function<JsonValue,
Optional<JsonValue>, JsonValueException> JsonValueFunctions.optional()
Return anOptional
if the given JsonValue has a value, orOptional.empty()
if the JsonValue contains a null value.static <T> Function<JsonValue,
Optional<T>, JsonValueException> JsonValueFunctions.optionalOf
(Function<JsonValue, T, JsonValueException> mappingFunction) Return anOptional
of a new type if the given JsonValue has a value, orOptional.empty()
if the JsonValue contains a null value.static Function<JsonValue,
Boolean, NeverThrowsException> JsonValueFunctions.parseBoolean()
Returns aBoolean
by converting the JsonValue usingJsonValue.asLong()
, or by parsing the JsonValue string usingBoolean.parseBoolean(String)
.static Function<JsonValue,
Long, NumberFormatException> JsonValueFunctions.parseLong()
Returns aLong
by converting the JsonValue usingJsonValue.asLong()
, or by parsing the JsonValue string usingLong.parseLong(String)
.static Function<JsonValue,
Pattern, JsonValueException> JsonValueFunctions.pattern()
Returns the JSON string value as a regular expression pattern.JsonValueFunctions.pointer()
Returns the JSON string value as a JSON pointer.static <V> Function<JsonValue,
Set<V>, JsonValueException> Returns the JSON value as aSet
containing objects whose type (and value) is specified by the parametertype
.Returns the JSON value as aSet
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).Modifier and TypeMethodDescription<V,
E extends Exception>
VReturns 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 transformfunction
to each element.Returns the JSON value as aList
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 anOptional
of a new type if the given JsonValue has a value, orOptional.empty()
if the JsonValue contains a null value.Returns the JSON value as aSet
containing objects whose type (and value) is specified by a transformation function.ModifierConstructorDescriptionJsonValueTraverseFunction
(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
Modifier and TypeMethodDescriptionJsonValueFunctions.queryFilter()
Parses and returns the JSON string value as aQueryFilter
.JsonValueFunctions.resourcePath()
Returns the JSON string value as aResourcePath
. -
Uses of Function in org.forgerock.openig.filter.oauth2
Modifier and TypeMethodDescriptionstatic Function<JsonValue,
ResourceAccess, HeapException> ResourceAccessConfigSupport.resourceAccess
(Heap heap) JsonValue
function capable of configuring an instance of aResourceAccess
subtype from suppliedscopes
configuration. -
Uses of Function in org.forgerock.openig.filter.oauth2.client.authentication
Modifier and TypeMethodDescriptionEncryptedPrivateKeyJwtClientAuthenticationFilterHeaplet.configuredBuilder
(EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder builder) Supports fulfillment of the suppliedEncryptedPrivateKeyJwtClientAuthenticationFilter.Builder
with configuration.PrivateKeyJwtClientAuthenticationFilterHeaplet.configuredBuilder
(PrivateKeyJwtClientAuthenticationFilter.Builder<?> builder) Supports fulfillment of the suppliedPrivateKeyJwtClientAuthenticationFilter.Builder
with configuration. -
Uses of Function in org.forgerock.openig.heap
Modifier and TypeMethodDescriptionGenericHeaplet.evaluatedWithHeapProperties()
Returns a function that will evaluate the expression hold by aJsonValue
using the properties defined in the heap of this Heaplet.protected <T> Function<JsonValue,
Expression<T>, JsonValueException> GenericHeaplet.expression
(Class<T> type) Returns a function that will create anExpression
from the string by theJsonValue
using the bindings defined in the heap of this Heaplet as initial bindings. -
Uses of Function in org.forgerock.openig.secrets
Modifier and TypeMethodDescriptionSecretsProviderHeaplet.secretsProvider
(Heap heap) Method supporting other client heaplets that wish to create aSecretsProvider
using alternative compact configuration formats. -
Uses of Function in org.forgerock.openig.tools.jwt.validation
Modifier and TypeMethodDescription<T,
E extends Exception>
JwtValidator.BuilderJwtValidator.Builder.claim
(String key, Function<JsonValue, ? extends T, E> transformer, JwtClaimConstraint<T> jwtClaimConstraint) Adds aJwtClaimConstraint
on a claim.<T,
E extends Exception>
JwtValidator.BuilderJwtValidator.Builder.optionalClaim
(String key, Function<JsonValue, ? extends T, E> transformer, JwtClaimConstraint<T> jwtClaimConstraint) Adds aJwtClaimConstraint
on an optional claim. -
Uses of Function in org.forgerock.openig.util
Modifier and TypeMethodDescriptionstatic Function<JsonValue,
Bindings, JsonValueException> JsonValues.bindings()
Returns a function that will create some bindings based of a Map-basedJsonValue
.static Function<JsonValue,
Bindings, JsonValueException> Returns a function that will create some bindings based of a Map-basedJsonValue
.JsonValues.constantSecretReference()
Returns aSecretReference.constant(Secret)
from aGenericSecret
attribute value.JsonValues.encryptionMethod()
Returns a function that transforms the JSON value to aEncryptionMethod
object.static Function<JsonValue,
JsonValue, JsonValueException> JsonValues.evaluated()
Returns a function that will evaluate all String nodes.static Function<JsonValue,
JsonValue, JsonValueException> Returns a function that will evaluate all String nodes.JsonValues.expectedType
(Class<T> type, Function<JsonValue, T, E> adapter) Allows to usedefaultTo
in an heaplet configuration to retrieve an object.static <T> Function<JsonValue,
Expression<T>, JsonValueException> JsonValues.expression
(Class<T> type) Returns a function for transforming JsonValues to expressions.static <T> Function<JsonValue,
Expression<T>, JsonValueException> JsonValues.expression
(Class<T> type, Bindings bindings) Returns a function for transforming JsonValues to expressions.static Function<JsonValue,
Instant, JsonValueException> JsonValues.instant()
static Function<JsonValue,
Duration, JsonValueException> JsonValues.javaDuration()
static Function<JsonValue,
JwtFactory, HeapException> JwtFactoryConfigUtils.jwtFactory
(Heap heap) Function supporting transformation of JSON configuration to aJwtFactory
instance registered in the heap.static <T> Function<JsonValue,
LeftValueExpression<T>, JsonValueException> JsonValues.leftValueExpression
(Class<T> type) Returns a function for transforming JsonValues to left-value expressions.Returns a function that transform a JSON node value into a list of adapted instances.static <T> Function<JsonValue,
T, HeapException> JsonValues.lookupOrCreateHeapObject
(Heap heap, Class<T> type) Returns the JSON value as aMap
containing values whose type is specified by a transformation function.static Function<JsonValue,
Optional<JsonValue>, JsonValueException> JsonValues.optional()
static <T> Function<JsonValue,
T, HeapException> JsonValues.optionalHeapObject
(Heap heap, Class<T> type) static <T> Function<JsonValue,
Optional<T>, JsonValueException> JsonValues.optionalOf
(Function<JsonValue, T, JsonValueException> delegate) Returns a wrapping function returning anOptional
result of the givendelegate
function.static Function<JsonValue,
Integer, JsonValueException> JsonValues.positiveInteger()
static Function<JsonValue,
Duration, JsonValueException> JsonValues.positiveLimitedDuration
(Duration defaultDuration) Transform duration configuration to aDuration
, enforcing that its value is positive (non-zero) and limited.JsonValues.properties()
Returns a function that transforms the JSON value to aProperties
object.static <S extends Secret>
Function<JsonValue,Purpose<S>, JsonValueException> static Function<JsonValue,
JsonValue, JsonValueException> Displays a custom message when the required attribute is not present in the configuration.static <T> Function<JsonValue,
T, HeapException> JsonValues.requiredHeapObject
(Heap heap, Class<T> type) static Function<JsonValue,
JsonValue, JsonValueException> JsonValues.resolvedLocation()
Returns a function that will resolve the field $location.static Function<JsonValue,
JsonValue, JsonValueException> JsonValues.resolvedLocation
(Bindings bindings) Returns a function that will resolve the field $location.JsonValues.secretPropertyFormat
(Heap heap) Returns aSecretPropertyFormat
object from aJsonValue
.static <S extends Secret>
Function<JsonValue,SecretReference<S>, JsonValueException> JsonValues.secretReferenceOf
(Function<JsonValue, Purpose<S>, JsonValueException> purposeTransformer, SecretsProvider secretsProvider) Returns a function that returns aSecretReference
for thePurpose
represented by the givenString
value label and known to the suppliedSecretsProvider
.static Function<JsonValue,
JsonValue, JsonValueException> JsonValues.slashEnded()
Returns the JsonValue with its value ended by a slash.Returns the JSON value as aStream
containing objects whose type (and value) is specified by a transformation function.JsonValues.tokenized
(org.forgerock.config.resolvers.PropertyResolver propertyResolver) Returns a function performing deep token substitution and object coercion ($ "functions").Modifier and TypeMethodDescriptionJsonValues.expectedType
(Class<T> type, Function<JsonValue, T, E> adapter) Allows to usedefaultTo
in an heaplet configuration to retrieve an object.Returns a function that transform a JSON node value into a list of adapted instances.Returns the JSON value as aMap
containing values whose type is specified by a transformation function.static <T> Function<JsonValue,
Optional<T>, JsonValueException> JsonValues.optionalOf
(Function<JsonValue, T, JsonValueException> delegate) Returns a wrapping function returning anOptional
result of the givendelegate
function.static <S extends Secret>
Function<JsonValue,SecretReference<S>, JsonValueException> JsonValues.secretReferenceOf
(Function<JsonValue, Purpose<S>, JsonValueException> purposeTransformer, SecretsProvider secretsProvider) Returns a function that returns aSecretReference
for thePurpose
represented by the givenString
value label and known to the suppliedSecretsProvider
.Returns the JSON value as aStream
containing objects whose type (and value) is specified by a transformation function. -
Uses of Function in org.forgerock.secrets
Modifier and TypeMethodDescription<T,
E extends Exception>
TReveals the secret temporarily, allowing it to be used for its intended purpose.<T,
E extends Exception>
TGenericSecret.revealAndDestroy
(Function<byte[], T, E> function) Reveals the secret temporarily and then scrubs the secret material from memory.<T,
E extends Exception>
TGenericSecret.revealAsText
(Charset charset, Function<char[], T, E> function) Reveals the secret temporarily as characters in the given character set.<T,
E extends Exception>
TGenericSecret.revealAsTextAndDestroy
(Charset charset, Function<char[], T, E> function) Reveals the secret temporarily as characters in the given character set and then scrubs the secret material from memory.<T,
E extends Exception>
TGenericSecret.revealAsUtf8
(Function<char[], T, E> function) Reveals the secret temporarily as characters in UTF-8.<T,
E extends Exception>
TGenericSecret.revealAsUtf8AndDestroy
(Function<char[], T, E> function) Reveals the secret temporarily as characters in UTF-8 and then scrubs the secret from memory. -
Uses of Function in org.forgerock.secrets.credentials
Modifier and TypeMethodDescriptionstatic <T extends Secret>
CredentialPair<T>CredentialPair.credentialPair
(SecretReference<T> secretReference, Function<T, PrincipalAndSecret<T>, NoSuchSecretException> mapper) Factory method to create a new instance ofCredentialPair
from a reference to a secret containing both the principal and secret. -
Uses of Function in org.forgerock.secrets.keystore
Modifier and TypeClassDescriptionfinal class
A loader for theKeyStoreSecretStore
that knows how to load standard PKCS#11 Hardware Security Module (HSM) providers on our supported platforms.ModifierConstructorDescriptionKeyStoreSecretStore
(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
Modifier and TypeClassDescriptionclass
CloseSilentlyFunction<VIN extends Closeable,
VOUT, E extends Exception> Function
that silently closes an input-parameter after a delegate-function'sapply(Object)
is invoked.Modifier and TypeMethodDescriptionReturns a composed function that first applies this function to its input, and then applies theafter
function to the result.CloseSilentlyFunction.closeSilently
(Function<IN, OUT, EX> delegate) Wraps a delegate function in aCloseSilentlyFunction
.Returns a composed function that first applies thebefore
function to its input, and then applies this function to the result.Function.identity()
Returns an identity function that returns the input as output.Modifier and TypeMethodDescriptionReturns a composed function that first applies this function to its input, and then applies theafter
function to the result.CloseSilentlyFunction.closeSilently
(Function<IN, OUT, EX> delegate) Wraps a delegate function in aCloseSilentlyFunction
.Returns a composed function that first applies thebefore
function to its input, and then applies this function to the result.LambdaExceptionUtils.rethrowFunction
(Function<T, R, E> function) ModifierConstructorDescriptionCloseSilentlyFunction
(Function<VIN, VOUT, E> delegate) Creates a newCloseSilentlyFunction
instance. -
Uses of Function in org.forgerock.util.promise
Modifier and TypeMethodDescriptionstatic <V,
E extends Exception>
Function<NeverThrowsException,V, E> NeverThrowsException.neverThrown()
Utility method returning an empty function, whose goal is to ease the transformation of aPromise
type.Modifier and TypeMethodDescriptionSubmits the provided function for execution once thisPromise
has completed with a result, and returns a newPromise
representing the outcome of the function.Submits the provided functions for execution once thisPromise
has completed (with a result or an exception), and returns a newPromise
representing the outcome of the invoked function.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 thisPromise
has completed (with a result or an exception or aRuntimeException
), and returns a newPromise
representing the outcome of the invoked function.PromiseImpl.then
(Function<? super V, VOUT, EOUT> onResult, Function<? super E, VOUT, EOUT> onException, Function<? super RuntimeException, VOUT, EOUT> onRuntimeException) Submits the provided function for execution once thisPromise
has not completed with a result (has completed with an exception), and returns a newPromise
representing the outcome of the function.Promise.thenCatchRuntimeException
(Function<? super RuntimeException, V, E> onRuntimeException) Submits the provided function for execution once thisPromise
has not completed with a result nor with an exception but with aRuntimeException
, and returns a newPromise
representing the outcome of the function.PromiseImpl.thenCatchRuntimeException
(Function<? super RuntimeException, V, E> onRuntimeException)
JsonValue::copy
directly instead