Uses of Class org.forgerock.openig.el.Expression (IG Aggregated Javadoc 2023.11.0 Documentation)

Packages that use Expression
Package	Description
org.forgerock.openig.decoration.baseuri	Contains a decorator which overrides the existing request URI, making requests relative to a new base URI.
org.forgerock.openig.el	Integrates with the Java Enterprise Edition Unified Expression Language API.
org.forgerock.openig.filter	Filters the requests and/or responses of HTTP.
org.forgerock.openig.filter.jwt	This package contains the components used to implement some JWT related filter.
org.forgerock.openig.filter.oauth2	This package contains the OAuth2 Token validation filter that acts as an OAuth 2 Resource Server.
org.forgerock.openig.filter.oauth2.client	OAuth 2.0 Client filter implementation.
org.forgerock.openig.filter.oauth2.cnf	JWT confirmation key support for access tokens.
org.forgerock.openig.handler	Handles HTTP requests by generating responses.
org.forgerock.openig.heap	Manages collections or "heaps" of associated objects, initialized from declarative configuration artifacts.
org.forgerock.openig.openam	Integration classes specifically for ForgeRock Access Management.
org.forgerock.openig.sql	Provides SQL and JDBC support.
org.forgerock.openig.types	Contains everything commonly used to work with `TypeDefinition`.
org.forgerock.openig.types.importer	Route import support.
org.forgerock.openig.util	Miscellaneous utility classes.

Uses of Expression in org.forgerock.openig.decoration.baseuri

Methods in org.forgerock.openig.decoration.baseuri with parameters of type Expression
Modifier and Type	Method	Description
`T`	BaseUriFactory.`wrap(T delegate, Expression<String> baseUriExpression, org.slf4j.Logger logger)`	Wraps the decorator to be applied everywhere.

Uses of Expression in org.forgerock.openig.el

Subclasses of Expression in org.forgerock.openig.el
Modifier and Type	Class	Description
`class`	`LeftValueExpression<T>`	A `LeftValueExpression` is a specialized `Expression` to which we can assign a value.

Methods in org.forgerock.openig.el that return Expression
Modifier and Type	Method	Description
`static Expression<Object>`	Expressions.`from(String value)`	Convert a String to a compiled expression.
`static Expression<Object>`	Expressions.`from(String value, Bindings initialBindings)`	Convert a String to a compiled expression.
`static <T> Expression<T>`	Expression.`valueOf(String expression, Class<T> expectedType)`	Factory method to create an Expression.
`static <T> Expression<T>`	Expression.`valueOf(String expression, Class<T> expectedType, Bindings initialBindings)`	Factory method to create an Expression.

Constructors in org.forgerock.openig.el with parameters of type Expression
Constructor	Description
`ExpressionRequestAsyncFunction(Expression<V> expression)`	Constructs an `AsyncFunction` that evaluates the provided `Expression`.

Uses of Expression in org.forgerock.openig.filter

Methods in org.forgerock.openig.filter that return types with arguments of type Expression
Modifier and Type	Method	Description
`MultiValueMap<String,Expression<String>>`	HeaderFilter.`getAddedHeaders()`	Returns the header fields to add to the message, represented as a MultiMap of String to a List of String, each listed value representing an expression that will be evaluated.

Methods in org.forgerock.openig.filter with parameters of type Expression
Modifier and Type	Method	Description
`StaticRequestFilter`	StaticRequestFilter.`addFormParameter(String name, Expression<String> value)`	Adds a new form parameter using the given `key` with the given `Expression`.
`StaticRequestFilter`	StaticRequestFilter.`addHeaderValue(String key, Expression<String> value)`	Adds a new header value using the given `key` with the given `Expression`.
`AssignmentFilter`	AssignmentFilter.`addRequestBinding(Expression<Boolean> condition, LeftValueExpression<?> target, Expression<?> value)`	Registers a conditional binding on the request flow.
`AssignmentFilter`	AssignmentFilter.`addRequestBinding(LeftValueExpression<?> target, Expression<?> value)`	Registers an unconditional (always executed) binding on the request flow.
`SwitchFilter`	SwitchFilter.`addRequestCase(Expression<Boolean> condition, Handler handler)`	Add a request switch case with a condition and the handler to execute if condition yields.
`AssignmentFilter`	AssignmentFilter.`addResponseBinding(Expression<Boolean> condition, LeftValueExpression<?> target, Expression<?> value)`	Registers a conditional binding on the response flow.
`AssignmentFilter`	AssignmentFilter.`addResponseBinding(LeftValueExpression<?> target, Expression<?> value)`	Registers an unconditional (always executed) binding on the response flow.
`SwitchFilter`	SwitchFilter.`addResponseCase(Expression<Boolean> condition, Handler handler)`	Add a response switch case with a condition and the handler to execute if condition yields.
`RetryFilter.Builder`	RetryFilter.Builder.`condition(Expression<Boolean> condition)`	Add a retry condition to the future `RetryFilter`.
`void`	LocationHeaderFilter.`setBaseURI(Expression<String> baseURI)`	Sets the base URI used to rewrite Location headers.
`void`	StaticRequestFilter.`setEntity(Expression<String> entity)`	Sets the message entity expression.
`void`	StaticRequestFilter.`setUri(Expression<String> uri)`	Sets the target URI as an expression to allow dynamic URI construction.

Constructors in org.forgerock.openig.filter with parameters of type Expression
Constructor	Description
`ConditionEnforcementFilter(Expression<Boolean> condition)`	Creates a new `ConditionEnforcementFilter`.
`ConditionEnforcementFilter(Expression<Boolean> condition, Handler failureHandler)`	Creates a new `ConditionEnforcementFilter`.
`FileAttributesFilter(SeparatedValuesFile file, String key, Expression<String> value, LeftValueExpression<Map> target)`	Builds a new FileAttributesFilter extracting values from the given separated values file.
`HttpBasicAuthFilter(Expression<String> username, Expression<String> password, Handler failureHandler)`	Builds a `HttpBasicAuthFilter` with required expressions and error handler.

Uses of Expression in org.forgerock.openig.filter.jwt

Methods in org.forgerock.openig.filter.jwt that return Expression
Modifier and Type	Method	Description
`protected Expression<String>`	JwtValidationFilter.Heaplet.`jwtExpression()`	Returns the expression to be used to obtain the JWT token value.

Constructors in org.forgerock.openig.filter.jwt with parameters of type Expression
Constructor	Description
`JwtValidationFilter(Expression<String> jwtResolver, JwtValidator validator, Handler failureHandler)`	Constructs a JwtValidationFilter.

Uses of Expression in org.forgerock.openig.filter.oauth2

Constructors in org.forgerock.openig.filter.oauth2 with parameters of type Expression
Constructor	Description
`OAuth2TokenExchangeFilter(URI endpoint, Handler handler, Expression<String> subjectTokenExpression, String subjectTokenType, String requestedTokenType, ResourceAccess scopesAccess, URI resource, String audience, Handler failureHandler)`	Construct a new `OAuth2TokenExchangeFilter`.

Uses of Expression in org.forgerock.openig.filter.oauth2.client

Methods in org.forgerock.openig.filter.oauth2.client that return Expression
Modifier and Type	Method	Description
`protected Expression<String>`	IdTokenValidationFilterHeaplet.`jwtExpression()`

Methods in org.forgerock.openig.filter.oauth2.client with parameters of type Expression
Modifier and Type	Method	Description
`OAuth2ClientFilter`	OAuth2ClientFilter.`setDefaultLoginGoto(Expression<String> endpoint)`	Sets the expression which will be used for obtaining the default login "goto" URI.
`OAuth2ClientFilter`	OAuth2ClientFilter.`setDefaultLogoutGoto(Expression<String> endpoint)`	Sets the expression which will be used for obtaining the default logout "goto" URI.

Constructors in org.forgerock.openig.filter.oauth2.client with parameters of type Expression
Constructor	Description
`OAuth2ClientFilter(org.forgerock.openig.filter.oauth2.client.ClientRegistrationRepository registrations, PerItemEvictionStrategyCache<String,Promise<Map<String,Object>,OAuth2ErrorException>> userInfoCache, String prompt, org.forgerock.openig.filter.oauth2.client.UriValidationService validationService, Clock clock, Handler discoveryAndDynamicRegistrationChain, Expression<String> clientEndpoint, Handler idpSelectionLoginPageHandler)`	Constructs an `OAuth2ClientFilter`.

Uses of Expression in org.forgerock.openig.filter.oauth2.cnf

Constructors in org.forgerock.openig.filter.oauth2.cnf with parameters of type Expression
Constructor	Description
`CertificateThumbprintFilter(Expression<Certificate> certExpr, Handler failureHandler)`	Build a CertificateThumbprintFilter that will compute a certificate thumbprint based on the given `certExpr`.

Uses of Expression in org.forgerock.openig.handler

Methods in org.forgerock.openig.handler with parameters of type Expression
Modifier and Type	Method	Description
`DispatchHandler`	DispatchHandler.`addBinding(Expression<Boolean> condition, Handler handler, Expression<String> baseURI)`	Binds an expression to the current handler to dispatch to.
`SequenceHandler`	SequenceHandler.`addBinding(Handler handler, Expression<Boolean> postCondition)`	Binds sequenced handlers with sequence processing post-conditions.
`StaticResponseHandler`	StaticResponseHandler.`addHeader(String key, Expression<String> expression)`	Adds a pair key / expression to the header.
`StaticResponseHandler`	StaticResponseHandler.`addTrailer(String key, Expression<String> expression)`	Adds a pair key / expression to the trailer.
`DispatchHandler`	DispatchHandler.`addUnconditionalBinding(Handler handler, Expression<String> baseURI)`	Adds an unconditional bindings to the handler.

Constructors in org.forgerock.openig.handler with parameters of type Expression
Constructor	Description
`StaticResponseHandler(Status status, Expression<String> entity)`	Constructor.

Uses of Expression in org.forgerock.openig.heap

Methods in org.forgerock.openig.heap that return types with arguments of type Expression
Modifier and Type	Method	Description
`protected <T> Function<JsonValue,Expression<T>,JsonValueException>`	GenericHeaplet.`expression(Class<T> type)`	Returns a function that will create an `Expression` from the string by the `JsonValue` using the bindings defined in the heap of this Heaplet as initial bindings.

Uses of Expression in org.forgerock.openig.openam

Methods in org.forgerock.openig.openam with parameters of type Expression
Modifier and Type	Method	Description
`void`	PolicyEnforcementFilter.`setJwtSubject(Expression<String> jwtSubject)`	Sets the JWT string for the subject.
`void`	PolicyEnforcementFilter.`setSsoTokenSubject(Expression<String> ssoTokenSubject)`	Sets the SSO token for the subject.

Constructors in org.forgerock.openig.openam with parameters of type Expression
Constructor	Description
`SessionInfoFilter(SessionService sessionService, Expression<String> ssoToken)`	Creates a new OpenAM session info filter.
`SingleSignOnFilter(AmService amService, Realm realm, Expression<Boolean> logoutExpression, String defaultLogoutLandingPage, Expression<String> loginEndpoint, String authnService, boolean enableRedirectionMarker, String redirectionMarkerName)`	Creates a new SingleSignOnFilter.
`TokenTransformationFilter(Handler handler, URI endpoint, Expression<String> idToken)`	Constructs a new TokenTransformationFilter transforming the OpenID Connect id_token from `idToken` into a SAML 2.0 Assertions structure (into `StsContext`).

Uses of Expression in org.forgerock.openig.sql

Methods in org.forgerock.openig.sql that return types with arguments of type Expression
Modifier and Type	Method	Description
`List<Expression<?>>`	SqlAttributesFilter.`getParameters()`	Returns the list of parameters to evaluate and include in the execution of the prepared statement.

Uses of Expression in org.forgerock.openig.types

Methods in org.forgerock.openig.types that return types with arguments of type Expression
Modifier and Type	Method	Description
`static <T> org.forgerock.openig.model.type.StringTypeDefinition<Expression<T>>`	TypeDefinitions.`expressionOf(Class<T> type)`	Represents a runtime `Expression` of type T, which is a String with a specific `Syntax`.
`static <T> org.forgerock.openig.model.type.Syntax<Expression<T>>`	TypeDefinitions.`expressionSyntaxOf(Class<T> type)`	Creates an expression `Syntax` that is bound to the given `type`.

Uses of Expression in org.forgerock.openig.types.importer

Methods in org.forgerock.openig.types.importer that return Expression
Modifier and Type	Method	Description
`Expression<Boolean>`	RouteInstance.`condition()`	Returns the condition expression of this route.

Methods in org.forgerock.openig.types.importer with parameters of type Expression
Modifier and Type	Method	Description
`RouteInstance`	RouteInstance.`condition(Expression<Boolean> condition)`	Sets the condition expression that describes what requests are accepted by this route.

Uses of Expression in org.forgerock.openig.util

Methods in org.forgerock.openig.util that return types with arguments of type Expression
Modifier and Type	Method	Description
`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.

Methods in org.forgerock.openig.util with parameters of type Expression
Modifier and Type	Method	Description
`static Promise<Request,URISyntaxException>`	BaseUriUtil.`rebaseRequest(Expression<String> baseUri, Bindings bindings, Request request)`	Rebase the URI of the request based on the evaluation of the baseUri expression.