Top Description Fields Constructors Methods
org.mortbay.jetty.plus.webapp

public abstract Class AbstractConfiguration

extends WebXmlConfiguration
Class Inheritance
Known Direct Subclasses
org.mortbay.jetty.plus.webapp.Configuration
Imports
java.util.EventListener, .Iterator, javax.servlet.UnavailableException, org.mortbay.jetty.plus.annotation.Injection, .InjectionCollection, .LifeCycleCallback, .LifeCycleCallbackCollection, .PostConstructCallback, .PreDestroyCallback, .RunAsCollection, org.mortbay.jetty.plus.servlet.ServletHandler, org.mortbay.jetty.security.ConstraintsSecurityHandler, org.mortbay.jetty.servlet.ServletHolder, org.mortbay.jetty.webapp.WebAppContext, .WebXmlConfiguration, org.mortbay.log.Log, org.mortbay.util.TypeUtil, org.mortbay.xml.XmlParser
Configuration

Field Summary

Modifier and TypeField and Description
protected LifeCycleCallbackCollection
_callbacks

protected InjectionCollection
_injections

protected RunAsCollection
_runAsCollection

Inherited from org.mortbay.jetty.webapp.WebXmlConfiguration:
_constraintMappings_context_defaultWelcomeFileList_errorPages_filterMappings_filters_hasJSP_jspServletClass_jspServletName_listeners_metaDataComplete_servletHandler_servletMappings_servlets_version_welcomeFiles_xmlParser

Constructor Summary

AccessConstructor and Description
public
AbstractConfiguration()

Method Summary

Modifier and TypeMethod and Description
public abstract void
bindEnvEntry(String name, Object value)

public abstract void
bindMessageDestinationRef(String name, Class<T> type)

public abstract void
bindResourceEnvRef(String name, Class<T> type)

public abstract void
bindResourceRef(String name, Class<T> type)

public abstract void
bindUserTransaction()

protected void
callPreDestroyCallbacks()

public void
configure(String webXml)

Overrides org.mortbay.jetty.webapp.WebXmlConfiguration.configure.

public void
configureDefaults()

Overrides org.mortbay.jetty.webapp.WebXmlConfiguration.configureDefaults.

Implements org.mortbay.jetty.webapp.Configuration.configureDefaults.

Process webdefaults.xml
public void
configureWebApp()

Overrides org.mortbay.jetty.webapp.WebXmlConfiguration.configureWebApp.

Implements org.mortbay.jetty.webapp.Configuration.configureWebApp.

Process web.xml
public void
deconfigureWebApp()

Overrides org.mortbay.jetty.webapp.WebXmlConfiguration.deconfigureWebApp.

Implements org.mortbay.jetty.webapp.Configuration.deconfigureWebApp.

DeConfigure WebApp.
protected void
initEnvEntry(XmlParser.Node node)

JavaEE 5.4.1.3

protected void
initialize(XmlParser.Node config)

Overrides org.mortbay.jetty.webapp.WebXmlConfiguration.initialize.

protected void

Returns:

the type of the injectable
initInjection(XmlParser.Node node, String jndiName, Class<T> valueClass)

Iterate over the <injection-target> entries for a node

protected void
initMessageDestinationRef(XmlParser.Node node)

Common Annotations Spec section 2.3: message-destination-ref is for: - javax.jms.Queue - javax.jms.Topic

protected void
initPostConstruct(XmlParser.Node node)

Process <post-construct>

protected void
initPreDestroy(XmlParser.Node node)

Process <pre-destroy>

protected void
initResourceEnvRef(XmlParser.Node node)

Common Annotations Spec section 2.3: resource-env-ref is for: - javax.transaction.UserTransaction - javax.resource.cci.InteractionSpec - anything else that is not a connection factory

protected void
initResourceRef(XmlParser.Node node)

Common Annotations Spec section 2.3: resource-ref is for: - javax.sql.DataSource - javax.jms.ConnectionFactory - javax.jms.QueueConnectionFactory - javax.jms.TopicConnectionFactory - javax.mail.Session - java.net.URL - javax.resource.cci.ConnectionFactory - org.omg.CORBA_2_3.ORB - any other connection factory defined by a resource adapter

protected void
initWebXmlElement(String
The element name
element, XmlParser.Node
The node containing the element.
node)

Overrides org.mortbay.jetty.webapp.WebXmlConfiguration.initWebXmlElement.

Handle web.xml element.
protected void
injectAndCallPostConstructCallbacks()

protected abstract void
parseAnnotations()

Parse all classes that are mentioned in web.xml (servlets, filters, listeners) for annotations.

public void
setWebAppContext(WebAppContext context)

Overrides org.mortbay.jetty.webapp.WebXmlConfiguration.setWebAppContext.

Implements org.mortbay.jetty.webapp.Configuration.setWebAppContext.

Set up a context on which to perform the configuration.
Inherited from org.mortbay.jetty.webapp.WebXmlConfiguration:
configureClassLoaderconfigureWebFragmentsfindWebXmlgetJSPServletNamegetWebAppContextinitContextParaminitDisplayNameinitDistributableinitErrorPageinitFilterinitFilterMappinginitializeVersioninitJspConfiginitListenerinitLocaleEncodingListinitLoginConfiginitMimeConfiginitSecurityConstraintinitSecurityRoleinitServletinitServletMappinginitSessionConfiginitTagLibinitWelcomeFileListnewListenerInstancenormalizePatternwebXmlParser

Field Detail

_callbacksback to summary
protected LifeCycleCallbackCollection _callbacks
_injectionsback to summary
protected InjectionCollection _injections
_runAsCollectionback to summary
protected RunAsCollection _runAsCollection

Constructor Detail

AbstractConfigurationback to summary
public AbstractConfiguration() throws ClassNotFoundException

Method Detail

bindEnvEntryback to summary
public abstract void bindEnvEntry(String name, Object value) throws Exception
bindMessageDestinationRefback to summary
public abstract void bindMessageDestinationRef(String name, Class<T> type) throws Exception
bindResourceEnvRefback to summary
public abstract void bindResourceEnvRef(String name, Class<T> type) throws Exception
bindResourceRefback to summary
public abstract void bindResourceRef(String name, Class<T> type) throws Exception
bindUserTransactionback to summary
public abstract void bindUserTransaction() throws Exception
callPreDestroyCallbacksback to summary
protected void callPreDestroyCallbacks() throws Exception
configureback to summary
public void configure(String webXml) throws Exception

Overrides org.mortbay.jetty.webapp.WebXmlConfiguration.configure.

configureDefaultsback to summary
public void configureDefaults() throws Exception

Overrides org.mortbay.jetty.webapp.WebXmlConfiguration.configureDefaults.

Implements org.mortbay.jetty.webapp.Configuration.configureDefaults.

Doc from org.mortbay.jetty.webapp.WebXmlConfiguration.configureDefaults.

Process webdefaults.xml

configureWebAppback to summary
public void configureWebApp() throws Exception

Overrides org.mortbay.jetty.webapp.WebXmlConfiguration.configureWebApp.

Implements org.mortbay.jetty.webapp.Configuration.configureWebApp.

Doc from org.mortbay.jetty.webapp.WebXmlConfiguration.configureWebApp.

Process web.xml

deconfigureWebAppback to summary
public void deconfigureWebApp() throws Exception

Overrides org.mortbay.jetty.webapp.WebXmlConfiguration.deconfigureWebApp.

Implements org.mortbay.jetty.webapp.Configuration.deconfigureWebApp.

Doc from org.mortbay.jetty.webapp.Configuration.deconfigureWebApp.

DeConfigure WebApp. This method is called to undo all configuration done to this webapphandler. This is called to allow the context to work correctly over a stop/start cycle

initEnvEntryback to summary
protected void initEnvEntry(XmlParser.Node node) throws Exception

JavaEE 5.4.1.3

initializeback to summary
protected void initialize(XmlParser.Node config) throws ClassNotFoundException, UnavailableException

Overrides org.mortbay.jetty.webapp.WebXmlConfiguration.initialize.

initInjectionback to summary
protected void initInjection(XmlParser.Node node, String jndiName, Class<T> valueClass)

Iterate over the <injection-target> entries for a node

Returns:void

the type of the injectable

initMessageDestinationRefback to summary
protected void initMessageDestinationRef(XmlParser.Node node) throws Exception

Common Annotations Spec section 2.3: message-destination-ref is for: - javax.jms.Queue - javax.jms.Topic

initPostConstructback to summary
protected void initPostConstruct(XmlParser.Node node)

Process <post-construct>

initPreDestroyback to summary
protected void initPreDestroy(XmlParser.Node node)

Process <pre-destroy>

initResourceEnvRefback to summary
protected void initResourceEnvRef(XmlParser.Node node) throws Exception

Common Annotations Spec section 2.3: resource-env-ref is for: - javax.transaction.UserTransaction - javax.resource.cci.InteractionSpec - anything else that is not a connection factory

initResourceRefback to summary
protected void initResourceRef(XmlParser.Node node) throws Exception

Common Annotations Spec section 2.3: resource-ref is for: - javax.sql.DataSource - javax.jms.ConnectionFactory - javax.jms.QueueConnectionFactory - javax.jms.TopicConnectionFactory - javax.mail.Session - java.net.URL - javax.resource.cci.ConnectionFactory - org.omg.CORBA_2_3.ORB - any other connection factory defined by a resource adapter

initWebXmlElementback to summary
protected void initWebXmlElement(String element, XmlParser.Node node) throws Exception

Overrides org.mortbay.jetty.webapp.WebXmlConfiguration.initWebXmlElement.

Doc from org.mortbay.jetty.webapp.WebXmlConfiguration.initWebXmlElement.

Handle web.xml element. This method is called for each top level element within the web.xml file. It may be specialized by derived WebAppHandlers to provide additional configuration and handling.

Parameters
element:String

The element name

node:XmlParser.Node

The node containing the element.

injectAndCallPostConstructCallbacksback to summary
protected void injectAndCallPostConstructCallbacks() throws Exception
parseAnnotationsback to summary
protected abstract void parseAnnotations() throws Exception

Parse all classes that are mentioned in web.xml (servlets, filters, listeners) for annotations.

setWebAppContextback to summary
public void setWebAppContext(WebAppContext context)

Overrides org.mortbay.jetty.webapp.WebXmlConfiguration.setWebAppContext.

Implements org.mortbay.jetty.webapp.Configuration.setWebAppContext.

Doc from org.mortbay.jetty.webapp.Configuration.setWebAppContext.

Set up a context on which to perform the configuration.