org.jboss.as.controller

Interface ExpressionResolverExtension

public interface ExpressionResolverExtension

Object that can be used to extend the functionality of an ExpressionResolver by handling expression strings in formats not understood by the expression resolver.

Method Summary

Modifier and Type	Method and Description
void	initialize(OperationContext context) Initialize the extension using the given OperationContext.
String	resolveExpression(String expression, OperationContext context) Resolve a given simple expression string, returning null if the string is not of a form recognizable to the plugin.

Method Detail

initialize

void initialize(OperationContext context)
         throws OperationFailedException

Initialize the extension using the given OperationContext. May be called multiple times for a given extension, so extensions should handle that appropriately.

Parameters:

context - the OperationContext. Will not be null

Throws:

OperationFailedException - if a problem initializing occurs that indicates a user mistake (e.g. an improper configuration of a resource used by the extension.) Do not use for non-user-driven problems; use runtime exceptions for those. Throwing a runtime exception that implements OperationClientException is also a valid way to handle user mistakes.

resolveExpression

String resolveExpression(String expression,
                         OperationContext context)

Resolve a given simple expression string, returning null if the string is not of a form recognizable to the plugin.

Parameters:

expression - a string that begins with ${ and ends with } and that does not have any substrings that match that pattern.

context - the current OperationContext to provide additional contextual information.

Returns:

a string representing the resolve expression, or null if expression is not of a form understood by the plugin.

Throws:

ExpressionResolver.ExpressionResolutionUserException - if expression is a form understood by the plugin 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.

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