Package org.jboss.as.controller.transform

Interface Transformers

All Known Implementing Classes:

TransformersImpl

public interface Transformers

Transformers API for manipulating transformation operations between different versions of application server

Since:

7.1.2

Author:

Emanuel Muckenhuber, Tomaz Cerar

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Transformers.Factory	Convenience factory for unit tests, and default internal implementations
static interface	Transformers.OperationExcludedTransformationRegistry	Provides information on whether a target process is excluded from receiving operations for a particular resource addresses.
static interface	Transformers.ResourceIgnoredTransformationRegistry	Provides information on whether a target process is ignoring particular resource addresses.
static class	Transformers.TransformationInputs	Standard inputs into a transformation process.

Field Summary

Fields

Modifier and Type	Field	Description
static final Transformers.ResourceIgnoredTransformationRegistry	DEFAULT	A default Transformers.ResourceIgnoredTransformationRegistry that says that no addresses are being ignored.

Method Summary

Modifier and Type	Method	Description
TransformationTarget	getTarget()	Get information about the target.
OperationTransformer.TransformedOperation	transformOperation(TransformationContext context, org.jboss.dmr.ModelNode operation)	Only for use by test frameworks. Transforms an operation.
OperationTransformer.TransformedOperation	transformOperation(Transformers.TransformationInputs transformationInputs, org.jboss.dmr.ModelNode operation)	Transform an operation.
Resource	transformResource(ResourceTransformationContext context, Resource resource)	Only for use by test frameworks..
Resource	transformRootResource(Transformers.TransformationInputs transformationInputs, Resource resource)	Transform a given root resource, including children.
Resource	transformRootResource(Transformers.TransformationInputs transformationInputs, Resource resource, Transformers.ResourceIgnoredTransformationRegistry ignoredTransformationRegistry)	Transform a given resource, including children, removing resources that the given ignoredTransformationRegistry indicates are being ignored by the target process.

Field Details

DEFAULT

static final Transformers.ResourceIgnoredTransformationRegistry DEFAULT

A default Transformers.ResourceIgnoredTransformationRegistry that says that no addresses are being ignored.

Method Details

getTarget

TransformationTarget getTarget()

Get information about the target.

Returns:

the target

transformOperation

OperationTransformer.TransformedOperation transformOperation(TransformationContext context,
 org.jboss.dmr.ModelNode operation)
                                                      throws OperationFailedException

Only for use by test frameworks. Transforms an operation.

Parameters:

context - contextual information about the transformation

operation - the operation to transform

Returns:

the transformed operation

Throws:

OperationFailedException

transformOperation

OperationTransformer.TransformedOperation transformOperation(Transformers.TransformationInputs transformationInputs,
 org.jboss.dmr.ModelNode operation)
                                                      throws OperationFailedException

Transform an operation.

Parameters:

transformationInputs - standard inputs into a transformation process. Cannot be null

operation - the operation to transform. Cannot be null

Returns:

the transformed operation. Will not be null

Throws:

OperationFailedException

transformResource

Resource transformResource(ResourceTransformationContext context,
 Resource resource)
                    throws OperationFailedException

Only for use by test frameworks.. Transforms the given resource.

Parameters:

context - contextual information about the transformation

resource - to transform

Returns:

transformed resource, or same if no transformation was needed

Throws:

OperationFailedException

transformRootResource

Resource transformRootResource(Transformers.TransformationInputs transformationInputs,
 Resource resource)
                        throws OperationFailedException

Transform a given root resource, including children. The given resource must represent the root of HC's full resource tree but need not include all children, if the caller is not interested in transforming the excluded children.

Parameters:

transformationInputs - standard inputs into a transformation process. Cannot be null

resource - the root resource. Cannot be null

Returns:

the transformed resource. Will not be null

Throws:

OperationFailedException

transformRootResource

Resource transformRootResource(Transformers.TransformationInputs transformationInputs,
 Resource resource,
 Transformers.ResourceIgnoredTransformationRegistry ignoredTransformationRegistry)
                        throws OperationFailedException

Transform a given resource, including children, removing resources that the given ignoredTransformationRegistry indicates are being ignored by the target process. The given resource must represent the root of HC's full resource tree but need not include all children, if the caller is not interested in transforming the excluded children.

Parameters:

transformationInputs - standard inputs to a transformation. Cannot be null

resource - the resource to be transformed (including children)

ignoredTransformationRegistry - provider of information on what addresses are being ignored by the target process

Returns:

the transformed resource

Throws:

OperationFailedException