Interface ContextHandlerFactory

All Known Implementing Classes:

StandardContextHandlerFactory

public interface ContextHandlerFactory

A factory to create a ContextHandler from a set of associated files.

See Also:

• DeploymentScanner

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CONTEXT_HANDLER_CLASS_ATTRIBUTE	The attribute name for the value holding the default class to used for creating ContextHandler in the environment
static final String	ENVIRONMENT_ATTRIBUTE	The attribute name for the environment name.
static final String	ENVIRONMENT_XML_PATHS_ATTRIBUTE	Attribute name that stores the List<Path> pointing to XML files that represent the Environment XML files to apply to the ContextHandler has been created.

Method Summary

Modifier and Type	Method	Description
ContextHandler	newContextHandler(Server server, Environment environment, Path mainPath, Set<Path> otherPaths, Attributes deployAttributes)

Field Details

DEFAULT_CONTEXT_HANDLER_CLASS_ATTRIBUTE

static final String DEFAULT_CONTEXT_HANDLER_CLASS_ATTRIBUTE

The attribute name for the value holding the default class to used for creating ContextHandler in the environment

See Also:

• Constant Field Values

ENVIRONMENT_ATTRIBUTE

static final String ENVIRONMENT_ATTRIBUTE

The attribute name for the environment name.

See Also:

• Constant Field Values

ENVIRONMENT_XML_PATHS_ATTRIBUTE

static final String ENVIRONMENT_XML_PATHS_ATTRIBUTE

Attribute name that stores the List<Path> pointing to XML files that represent the Environment XML files to apply to the ContextHandler has been created.

See Also:

• Constant Field Values

Method Details

newContextHandler

ContextHandler newContextHandler(Server server,
 Environment environment,
 Path mainPath,
 Set<Path> otherPaths,
 Attributes deployAttributes)
                          throws Exception

Parameters:

server - The server for the context.

environment - The environment for the context

mainPath - The Path of the main file of the context (e.g. a WAR file or XML)

otherPaths - Other files associated with the context (e.g. property files)

deployAttributes - Attributes describing the details of the deployment and that are made available to the XmlConfiguration. The attribute names can be

• Attributes defined in Deployable
• DEFAULT_CONTEXT_HANDLER_CLASS_ATTRIBUTE
• ENVIRONMENT_ATTRIBUTE
• ENVIRONMENT_XML_PATHS_ATTRIBUTE

Returns:

The created ContextHandler

Throws:

Exception - If there is a problem creating the ContextHandler