org.milyn.cdr.extension

Class ExtensionContext

java.lang.Object

org.milyn.cdr.extension.ExtensionContext

public class ExtensionContext
extends Object

Context object used by Smooks configuration extension visitors.

Author:

tom.fennelly@gmail.com

Constructor Summary

Constructors

Constructor and Description
ExtensionContext(XMLConfigDigester xmlConfigDigester, String defaultSelector, String defaultNamespace, String defaultProfile, ExpressionEvaluator defaultConditionEvaluator) Public constructor.

Method Summary

Modifier and Type	Method and Description
void	addResource(SmooksResourceConfiguration resource) Add a resource configuration to the list of resources for this Extension Context.
void	addResourceTemplate(SmooksResourceConfiguration resource) Add a resource configuration template to the resources stack for this Extension Context.
SmooksResourceConfiguration	getCurrentConfig()
ExpressionEvaluator	getDefaultConditionEvaluator()
String	getDefaultNamespace()
String	getDefaultProfile()
String	getDefaultSelector()
static ExtensionContext	getExtensionContext(ExecutionContext executionContext) Get the ExtensionContext from the ExecutionContext.
SmooksResourceConfiguration	getResourceByName(String name)
SmooksResourceConfigurationList	getResourceList() Get the active resource configuration list.
List<SmooksResourceConfiguration>	getResources() Get the resource list.
Stack<SmooksResourceConfiguration>	getResourceStack() Get the resource stack.
XMLConfigDigester	getXmlConfigDigester()
List<SmooksResourceConfiguration>	lookupResource(ConfigSearch searchCriteria) Lookup an existing resource configuration from the global config list.
static void	setExtensionContext(ExtensionContext extensionContext, ExecutionContext executionContext) Set the ExtensionContext on the ExecutionContext.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExtensionContext

public ExtensionContext(XMLConfigDigester xmlConfigDigester,
                        String defaultSelector,
                        String defaultNamespace,
                        String defaultProfile,
                        ExpressionEvaluator defaultConditionEvaluator)

Public constructor.

Parameters:

xmlConfigDigester - The base XMLConfigDigester.

defaultSelector - The default selector.

defaultNamespace - The default namespace.

defaultProfile - The default profile.

defaultConditionEvaluator - The default condition evaluator.

Method Detail

setExtensionContext

public static void setExtensionContext(ExtensionContext extensionContext,
                                       ExecutionContext executionContext)

Set the ExtensionContext on the ExecutionContext.

Parameters:

extensionContext - Extension Context.

executionContext - Execution Context.

getExtensionContext

public static ExtensionContext getExtensionContext(ExecutionContext executionContext)

Get the ExtensionContext from the ExecutionContext.

Parameters:

executionContext - Execution Context.

Returns:

Extension Context.

addResource

public void addResource(SmooksResourceConfiguration resource)

Add a resource configuration to the list of resources for this Extension Context.

The resource gets added to the resourceStack and the basic list of resources.

Parameters:

resource - The resource to be added.

addResourceTemplate

public void addResourceTemplate(SmooksResourceConfiguration resource)

Add a resource configuration template to the resources stack for this Extension Context.

This resource is not added as a resource on the Smooks instance, but is instead available for cloning.

Parameters:

resource - The resource to be added.

getResourceStack

public Stack<SmooksResourceConfiguration> getResourceStack()

Get the resource stack.

Returns:

The resource stack.

See Also:

addResource(org.milyn.cdr.SmooksResourceConfiguration)

getResources

public List<SmooksResourceConfiguration> getResources()

Get the resource list.

Returns:

The resource list.

See Also:

addResource(org.milyn.cdr.SmooksResourceConfiguration)

getResourceList

public SmooksResourceConfigurationList getResourceList()

Get the active resource configuration list.

This is the global config list i.e. not just the config list for the config being processed.

Returns:

The active resource configuration list.

getCurrentConfig

public SmooksResourceConfiguration getCurrentConfig()

getXmlConfigDigester

public XMLConfigDigester getXmlConfigDigester()

getDefaultSelector

public String getDefaultSelector()

getDefaultNamespace

public String getDefaultNamespace()

getDefaultProfile

public String getDefaultProfile()

getDefaultConditionEvaluator

public ExpressionEvaluator getDefaultConditionEvaluator()

getResourceByName

public SmooksResourceConfiguration getResourceByName(String name)

lookupResource

public List<SmooksResourceConfiguration> lookupResource(ConfigSearch searchCriteria)

Lookup an existing resource configuration from the global config list.

Note that this is resource config order-dependent. It will not locate configs that have not yet been loaded.

Parameters:

searchCriteria - The resource lookup criteria.

Returns:

List of matches resources, or an empty List if no matches are found.