Interface Deployable

All Known Implementing Classes:

ContextHandler, ContextHandler.CoreContextHandler, ContextHandler.CoreContextHandler, CoreAppContext, HttpSpiContextHandler, MovedContextHandler, ResourceHandler.ResourceContext, ServletContextHandler, ServletContextHandler, StaticAppContext, WebAppContext, WebAppContext, WebAppContext, WebAppContext

public interface Deployable

Interface that can be implemented by a ContextHandler to allow configuration to be passed from a Deployer without dependencies on the jetty-deploy module itself.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_PREFIX	Deprecated, for removal: This API element is subject to removal in a future version. no replacement.
static final String	BASE_RESOURCE	Attribute key name: Base Resource for context.
static final String	CONFIGURATION_CLASSES	Attribute key name: The Configuration Classes for EE based deployments.
static final String	CONTAINER_SCAN_JARS	Attribute key name: The Container Scan Jar Pattern for EE based deployments.
static final String	CONTEXT_HANDLER_CLASS	Deprecated, for removal: This API element is subject to removal in a future version. no longer used. see DeploymentScanner EnvironmentConfig for new location.
static final String	CONTEXT_PATH	Attribute key name: Specifies the context-path of the ContextHandler
static final String	DEFAULT_CONTEXT_PATH	Attribute key name: Specifies the context-path of the ContextHandler
static final String	DEFAULTS_DESCRIPTOR	Attribute key name: Specifies the default descriptor to user for EE based deployments.
static final String	DIR_ALLOWED	Attribute key name: Configure Directory Listing for Base Resource.
static final String	ENVIRONMENT	Deprecated, for removal: This API element is subject to removal in a future version. no longer used by initializeDefaults(Attributes), functionality still exists in properties files, but is now managed by DeploymentScanner.
static final String	ENVIRONMENT_XML	Deprecated, for removal: This API element is subject to removal in a future version. no longer used by initializeDefaults(Attributes), functionality exists as a ${jetty.base}/environments/*.xml feature instead.
static final String	EXTRACT_WARS	Attribute key name: Specifies the flag to extract/unpack a WAR file for EE based deployments.
static final String	MAIN_PATH	Attribute key name: Specifies the main Path that is being deployed.
static final String	OTHER_PATHS	Attribute key name: Specifies the list of other Path that are relevant to the deployment.
static final String	PARENT_LOADER_PRIORITY	Attribute key name: Specifies the Parent ClassLoader Priority for EE based deployments.
static final String	SCI_EXCLUSION_PATTERN	Attribute key name: Specifies the Servlet Container Initializer Exclusion Pattern for EE based deployments.
static final String	SCI_ORDER	Attribute key name: Specifies the Servlet Container Initializer Ordering for EE based deployments.
static final String	TEMP_DIR	Attribute key name: Temp Directory for context.
static final String	WAR	Attribute key name: Specifies the WAR file (if relevant) of the deployable for EE based deployments.
static final String	WEBINF_SCAN_JARS	Attribute key name: Specifies the pattern of Jars in WEB-INF/lib to scan for annotations in EE based deployments.

Method Summary

Modifier and Type	Method	Description
void	initializeDefaults(Attributes attributes)

Field Details

ATTRIBUTE_PREFIX

@Deprecated(since="12.1.0",
            forRemoval=true)
static final String ATTRIBUTE_PREFIX

Deprecated, for removal: This API element is subject to removal in a future version.

no replacement.

Deprecated attribute key prefix. No longer used.

See Also:

• Constant Field Values

TEMP_DIR

static final String TEMP_DIR

Attribute key name: Temp Directory for context.

Value can be a File, String, or Path

See Also:

• ContextHandler.setTempDirectory(File)
• Constant Field Values

BASE_RESOURCE

static final String BASE_RESOURCE

Attribute key name: Base Resource for context.

Value can be a URI, String, Path, or Resource

See Also:

• ContextHandler.setBaseResource(Resource)
• Constant Field Values

DIR_ALLOWED

static final String DIR_ALLOWED

Attribute key name: Configure Directory Listing for Base Resource.

Value is a Boolean, or String

See Also:

• ResourceHandler.setDirAllowed(boolean)
• Constant Field Values

CONFIGURATION_CLASSES

static final String CONFIGURATION_CLASSES

Attribute key name: The Configuration Classes for EE based deployments.

Non-EE deployments will not use this configuration.

Value is a String[] (String Array)

See Also:

• Constant Field Values

CONTAINER_SCAN_JARS

static final String CONTAINER_SCAN_JARS

Attribute key name: The Container Scan Jar Pattern for EE based deployments.

Non-EE deployments will not use this configuration.

Value is a regex String

See Also:

• Constant Field Values

CONTEXT_PATH

static final String CONTEXT_PATH

Attribute key name: Specifies the context-path of the ContextHandler

Value is a String

See Also:

• ContextHandler.setContextPath(String)
• Constant Field Values

DEFAULT_CONTEXT_PATH

static final String DEFAULT_CONTEXT_PATH

Attribute key name: Specifies the context-path of the ContextHandler

Value is a String

See Also:

• ContextHandler.setContextPath(String)
• Constant Field Values

CONTEXT_HANDLER_CLASS

@Deprecated(since="12.1.0",
            forRemoval=true)
static final String CONTEXT_HANDLER_CLASS

Deprecated, for removal: This API element is subject to removal in a future version.

no longer used. see DeploymentScanner EnvironmentConfig for new location.

Deprecated context handler class attribute key.

See Also:

• Constant Field Values

DEFAULTS_DESCRIPTOR

static final String DEFAULTS_DESCRIPTOR

Attribute key name: Specifies the default descriptor to user for EE based deployments.

Non-EE deployments will not use this configuration.

Value is a String pointing to a filesystem path

See Also:

• Constant Field Values

ENVIRONMENT

@Deprecated(since="12.1.0",
            forRemoval=true)
static final String ENVIRONMENT

Deprecated, for removal: This API element is subject to removal in a future version.

no longer used by initializeDefaults(Attributes), functionality still exists in properties files, but is now managed by DeploymentScanner.

Deprecated environment attribute key.

See Also:

• Constant Field Values

ENVIRONMENT_XML

@Deprecated(since="12.1.0",
            forRemoval=true)
static final String ENVIRONMENT_XML

Deprecated, for removal: This API element is subject to removal in a future version.

no longer used by initializeDefaults(Attributes), functionality exists as a ${jetty.base}/environments/*.xml feature instead.

Deprecated environment XML attribute key prefix.

See Also:

• Constant Field Values

EXTRACT_WARS

static final String EXTRACT_WARS

Attribute key name: Specifies the flag to extract/unpack a WAR file for EE based deployments.

Non-EE deployments will not use this configuration.

Value is a Boolean

See Also:

• Constant Field Values

PARENT_LOADER_PRIORITY

static final String PARENT_LOADER_PRIORITY

Attribute key name: Specifies the Parent ClassLoader Priority for EE based deployments.

Non-EE deployments will not use this configuration.

Value is a Boolean

See Also:

• Constant Field Values

SCI_EXCLUSION_PATTERN

static final String SCI_EXCLUSION_PATTERN

Attribute key name: Specifies the Servlet Container Initializer Exclusion Pattern for EE based deployments.

Non-EE deployments will not use this configuration.

Value is a regex String

See Also:

• Constant Field Values

SCI_ORDER

static final String SCI_ORDER

Attribute key name: Specifies the Servlet Container Initializer Ordering for EE based deployments.

Non-EE deployments will not use this configuration.

Value is a comma-delimited String

See Also:

• "ServletContainerInitializerOrdering in EE specific package for details on syntax"
• Constant Field Values

WAR

static final String WAR

Attribute key name: Specifies the WAR file (if relevant) of the deployable for EE based deployments.

Non-EE deployments will not use this configuration.

Value is a String pointing to a filesystem path

See Also:

• Constant Field Values

WEBINF_SCAN_JARS

static final String WEBINF_SCAN_JARS

Attribute key name: Specifies the pattern of Jars in WEB-INF/lib to scan for annotations in EE based deployments.

Non-EE deployments will not use this configuration.

Value is a regex String

See Also:

• Constant Field Values

MAIN_PATH

static final String MAIN_PATH

Attribute key name: Specifies the main Path that is being deployed.

Value is a Path

See Also:

• Constant Field Values

OTHER_PATHS

static final String OTHER_PATHS

Attribute key name: Specifies the list of other Path that are relevant to the deployment.

Value is a Collection of Path instances

See Also:

• Constant Field Values

Method Details

initializeDefaults

void initializeDefaults(Attributes attributes)