Package org.openspaces.pu.container.jee.jetty

Class JettyJeeProcessingUnitContainerProvider

java.lang.Object

org.openspaces.pu.container.ProcessingUnitContainerProvider

org.openspaces.pu.container.spi.ApplicationContextProcessingUnitContainerProvider

org.openspaces.pu.container.jee.JeeProcessingUnitContainerProvider

org.openspaces.pu.container.jee.jetty.JettyJeeProcessingUnitContainerProvider

All Implemented Interfaces:

ClusterInfoAware, BeanLevelPropertiesAware

public class JettyJeeProcessingUnitContainerProvider
extends JeeProcessingUnitContainerProvider

An implementation of JeeProcessingUnitContainerProvider that can run web applications (war files) using Jetty.

The jetty xml configuration is loaded from DEFAULT_JETTY_PU location if it exists. If it does not exists, two defaults exists, one is the jetty.plain.pu.xml and the other is jetty.shared.xml. By default, if nothing is passed, the jetty.plain.xml is loaded.

The difference between plain and shared mode is only indicated by the built in jerry spring application context. The plain mode starts a jetty instance per web application instance. The shared mode uses the same jetty instance for all web applications. The default is plain mode as it is usually the simpler and preferred way to use it.

The web application will be enabled automatically for OpenSpaces bootstrapping using BootstrapWebApplicationContextListener.

Post processing of the web.xml and jetty-web.xml is performed allowing to use ${...} notation within them (for example, using system properties, deployed properties, or ${clusterInfo...}).

JMX in jetty can be enabled by passing a deployment property JETTY_JMX_PROP. If set to true jetty will be configured with JMX. In plain mode, where there can be more than one instance of jetty within the same JVM, the domain each instance will be registered under will be gigaspaces.jetty.${clusterInfo.name}.${clusterInfo.runningNumberOffset1}. In shared mode, where there is only one instance of jetty in a single JVM, jetty JMX will be registered with a domain called gigaspaces.jetty.

Author:

kimchy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_JETTY_PU	The optional location where a jetty spring application context (responsible for configuring jetty) will be loaded (within the processing unit).
static final String	INSTANCE_PLAIN
static final String	INSTANCE_SHARD
static final String	INTERNAL_JETTY_PU_PREFIX
static final String	JETTY_INSTANCE_PROP
static final String	JETTY_JMX_PROP	The deployment property controlling if JMX is enabled or not.
static final String	JETTY_LOCATION_PREFIX_SYSPROP

Fields inherited from class org.openspaces.pu.container.jee.JeeProcessingUnitContainerProvider

APPLICATION_CONTEXT_CONTEXT, BEAN_LEVEL_PROPERTIES_CONTEXT, CLUSTER_INFO_CONTEXT, DEFAULT_JEE_CONTAINER, JEE_CONTAINER_PROPERTY_NAME, JETTY_PORT_ACTUAL_CONTEXT, JETTY_PORT_CONTEXT_PREFIX, JETTY_PORT_CONTEXT_SUFFIX

Fields inherited from class org.openspaces.pu.container.spi.ApplicationContextProcessingUnitContainerProvider

DEFAULT_FS_PU_CONTEXT_LOCATION, DEFAULT_PU_CONTEXT_LOCATION

Fields inherited from class org.openspaces.pu.container.ProcessingUnitContainerProvider

CONTAINER_CLASS_PROP, CONTEXT_PROPERTY_DEPLOY_PATH, SPACE_NAME_PROPERTY_KEY

Constructor Summary

Constructors

Constructor	Description
JettyJeeProcessingUnitContainerProvider()

Method Summary

Modifier and Type	Method	Description
ProcessingUnitContainer	createContainer()	See the header javadoc.
static org.springframework.context.ApplicationContext	getCurrentApplicationContext()	Allows to get the current application context (loaded from pu.xml) during web application startup.
static BeanLevelProperties	getCurrentBeanLevelProperties()
static ClusterInfo	getCurrentClusterInfo()
String	getJeeContainerType()

Methods inherited from class org.openspaces.pu.container.jee.JeeProcessingUnitContainerProvider

addConfigLocation, addConfigLocation, getDeployPath, getJeeClassLoader, getJeeContainer, getJeeContainerJarPath, getManifestURLs, getWebAppClassLoaderClassPath, getWebAppClassLoaderJars, initApplicationContext, setClassLoader, setDeployPath, setManifestUrls, setParentContext

Methods inherited from class org.openspaces.pu.container.ProcessingUnitContainerProvider

getBeanLevelProperties, getClusterInfo, getConfig, setBeanLevelProperties, setClusterInfo, setMetricRegistrator, setSpaceName

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_JETTY_PU

public static final String DEFAULT_JETTY_PU

The optional location where a jetty spring application context (responsible for configuring jetty) will be loaded (within the processing unit). If does not exists, will load either the plain or shared built in jetty configurations (controlled by JETTY_INSTANCE_PROP) defaulting to plain.

See Also:

• Constant Field Values

INTERNAL_JETTY_PU_PREFIX

public static final String INTERNAL_JETTY_PU_PREFIX

See Also:

• Constant Field Values

INSTANCE_PLAIN

public static final String INSTANCE_PLAIN

See Also:

• Constant Field Values

INSTANCE_SHARD

public static final String INSTANCE_SHARD

See Also:

• Constant Field Values

JETTY_LOCATION_PREFIX_SYSPROP

public static final String JETTY_LOCATION_PREFIX_SYSPROP

See Also:

• Constant Field Values

JETTY_INSTANCE_PROP

public static final String JETTY_INSTANCE_PROP

See Also:

• Constant Field Values

JETTY_JMX_PROP

public static final String JETTY_JMX_PROP

The deployment property controlling if JMX is enabled or not. Defaults to false (JMX is disabled).

See Also:

• Constant Field Values

Constructor Details

JettyJeeProcessingUnitContainerProvider

public JettyJeeProcessingUnitContainerProvider()

Method Details

getCurrentApplicationContext

public static org.springframework.context.ApplicationContext getCurrentApplicationContext()

Allows to get the current application context (loaded from pu.xml) during web application startup. Can be used to access beans defined within it (like a Space) by components loaded (such as session storage). Note, this is only applicable during web application startup. It is cleared right afterwards.

getCurrentClusterInfo

public static ClusterInfo getCurrentClusterInfo()

getCurrentBeanLevelProperties

public static BeanLevelProperties getCurrentBeanLevelProperties()

getJeeContainerType

public String getJeeContainerType()

Specified by:

getJeeContainerType in class JeeProcessingUnitContainerProvider

createContainer

public ProcessingUnitContainer createContainer()
                                        throws CannotCreateContainerException

See the header javadoc.

Specified by:

createContainer in class ProcessingUnitContainerProvider

Returns:

A newly created processing unit container.

Throws:

CannotCreateContainerException