Package org.jboss.as.controller

Interface ExpressionResolver

All Known Subinterfaces:

OperationContext

All Known Implementing Classes:

ExpressionResolverImpl

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ExpressionResolver

Resolves ModelType.EXPRESSION expressions in a ModelNode.

Author:

Kabir Khan

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ExpressionResolver.ExpressionResolutionServerException	Runtime exception used to indicate a failure in some resolver extension execution not due to problems with user input like the expression string being resolved or the configuration of resources backing the resolver extension.
static class	ExpressionResolver.ExpressionResolutionUserException	Runtime exception used to indicate some user-driven problem that prevented expression resolution, for example: A flaw in a user provided expression string that results in a ExpressionResolverExtension not being able to resolve the expression.

Field Summary

Fields

Modifier and Type	Field	Description
static Pattern	EXPRESSION_PATTERN	A Pattern that can be used to identify strings that include expression syntax
static ExpressionResolver	EXTENSION_REJECTING	An expression resolver that throws an ExpressionResolver.ExpressionResolutionServerException if any extension expressions are found, otherwise providing the same behavior as SIMPLE.
static ExpressionResolver	REJECTING	An expression resolver that throws an OperationFailedException if any expressions are found.
static ExpressionResolver	SIMPLE	An ExpressionResolver that can only resolve from system properties and environment variables.
static ExpressionResolver	SIMPLE_LENIENT	An expression resolver that will not throw an OperationFailedException when it encounters an unresolvable expression, instead simply returning that expression.
static ExpressionResolver	TEST_RESOLVER	An ExpressionResolver suitable for test cases that can only resolve from system properties and environment variables.

Method Summary

Modifier and Type	Method	Description
org.jboss.dmr.ModelNode	resolveExpressions(org.jboss.dmr.ModelNode node)	Resolves any expressions in the passed in ModelNode.
default org.jboss.dmr.ModelNode	resolveExpressions(org.jboss.dmr.ModelNode node, OperationContext context)	Resolves any expressions in the passed in ModelNode.

Field Detail

EXPRESSION_PATTERN

static final Pattern EXPRESSION_PATTERN

A Pattern that can be used to identify strings that include expression syntax

SIMPLE

static final ExpressionResolver SIMPLE

An ExpressionResolver that can only resolve from system properties and environment variables. Should not be used for most product resolution use cases as it does not support resolution from resolver extensions.

TEST_RESOLVER

static final ExpressionResolver TEST_RESOLVER

An ExpressionResolver suitable for test cases that can only resolve from system properties and environment variables. Should not be used for production code as it does not support resolution from resolver extensions.

SIMPLE_LENIENT

static final ExpressionResolver SIMPLE_LENIENT

An expression resolver that will not throw an OperationFailedException when it encounters an unresolvable expression, instead simply returning that expression. Should not be used for most product resolution use cases as it does not support resolution from resolver extensions.

REJECTING

static final ExpressionResolver REJECTING

An expression resolver that throws an OperationFailedException if any expressions are found. Intended for use with APIs where an ExpressionResolver is required but the caller requires that all expression have already been resolved.

EXTENSION_REJECTING

static final ExpressionResolver EXTENSION_REJECTING

An expression resolver that throws an ExpressionResolver.ExpressionResolutionServerException if any extension expressions are found, otherwise providing the same behavior as SIMPLE. Intended for use in cases where ExpressionResolverExtensions cannot be available but non-extension expression resolution is wanted.

Method Detail

resolveExpressions

org.jboss.dmr.ModelNode resolveExpressions(org.jboss.dmr.ModelNode node)
                                    throws OperationFailedException

Resolves any expressions in the passed in ModelNode. Expressions may represent system properties, vaulted date, or a custom format to be handled by an ExpressionResolverExtension registered using the ResolverExtensionRegistry.

Parameters:

node - the ModelNode containing expressions.

Returns:

a copy of the node with expressions resolved

Throws:

ExpressionResolver.ExpressionResolutionUserException - if expression is a form understood by the resolver but in some way is unacceptable. This should only be thrown due to flaws in the provided expression or the configuration of resources used by a resolver extension, which are 'user' problems. It should not be used for internal problems in the resolver or any extension. If a if a security manager exists and its checkPermission method doesn't allow access to a relevant system property or environment variable, an ExpressionResolutionUserException should be thrown.

OperationFailedException - if an ExpressionResolverExtension throws one from its ExpressionResolverExtension.initialize(OperationContext) method.

ExpressionResolver.ExpressionResolutionServerException - if some other internal expression resolution failure occurs.

resolveExpressions

default org.jboss.dmr.ModelNode resolveExpressions(org.jboss.dmr.ModelNode node,
                                                   OperationContext context)
                                            throws OperationFailedException

Resolves any expressions in the passed in ModelNode. Expressions may represent system properties, vaulted date, or a custom format to be handled by an ExpressionResolverExtension registered using the ResolverExtensionRegistry. For vaulted data the format is ${VAULT::vault_block::attribute_name::sharedKey}

Parameters:

node - the ModelNode containing expressions.

context - the current OperationContext to provide additional contextual information.

Returns:

a copy of the node with expressions resolved

Throws:

ExpressionResolver.ExpressionResolutionUserException - if expression is a form understood by the resolver but in some way is unacceptable. This should only be thrown due to flaws in the provided expression or the configuration of resources used by the resolver extension, which are 'user' problems>. It should not be used for internal problems in the resolver extension. If a if a security manager exists and its checkPermission method doesn't allow access to a relevant system property or environment variable, an ExpressionResolutionUserException should be thrown

OperationFailedException - if an ExpressionResolverExtension throws one from its ExpressionResolverExtension.initialize(OperationContext) method.

ExpressionResolver.ExpressionResolutionServerException - if some other internal expression resolution failure occurs.