org.apache.openejb.jee
Class WebApp

java.lang.Object
  org.apache.openejb.jee.WebApp

All Implemented Interfaces:

JndiConsumer, Lifecycle, NamedModule, WebCommon

public class WebApp
extends Object
implements WebCommon, Lifecycle, NamedModule

web-common_3_0.xsd

Java class for web-appType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="web-appType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <choice maxOccurs="unbounded" minOccurs="0">
         <element name="module-name" type="{http://java.sun.com/xml/ns/javaee}string" minOccurs="0"/>
         <group ref="{http://java.sun.com/xml/ns/javaee}web-commonType"/>
         <element name="absolute-ordering" type="{http://java.sun.com/xml/ns/javaee}absoluteOrderingType"/>
       </choice>
       <attGroup ref="{http://java.sun.com/xml/ns/javaee}web-common-attributes"/>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

protected AbsoluteOrdering	absoluteOrdering
protected List<ParamValue>	contextParam
protected KeyedCollection<String,DataSource>	dataSource
protected TextMap	description
protected TextMap	displayName
protected List<Empty>	distributable
protected KeyedCollection<String,EjbLocalRef>	ejbLocalRef
protected KeyedCollection<String,EjbRef>	ejbRef
protected KeyedCollection<String,EnvEntry>	envEntry
protected List<ErrorPage>	errorPage
protected List<Filter>	filter
protected List<FilterMapping>	filterMapping
protected LocalCollection<Icon>	icon
protected String	id
protected List<JspConfig>	jspConfig
protected List<Listener>	listener
protected List<LocaleEncodingMappingList>	localeEncodingMappingList
protected List<LoginConfig>	loginConfig
protected List<MessageDestination>	messageDestination
protected KeyedCollection<String,MessageDestinationRef>	messageDestinationRef
protected Boolean	metadataComplete
protected List<MimeMapping>	mimeMapping
protected String	moduleName
protected KeyedCollection<String,PersistenceContextRef>	persistenceContextRef
protected KeyedCollection<String,PersistenceUnitRef>	persistenceUnitRef
protected List<LifecycleCallback>	postConstruct
protected List<LifecycleCallback>	preDestroy
protected KeyedCollection<String,ResourceEnvRef>	resourceEnvRef
protected KeyedCollection<String,ResourceRef>	resourceRef
protected List<SecurityConstraint>	securityConstraint
protected List<SecurityRole>	securityRole
protected KeyedCollection<String,ServiceRef>	serviceRef
protected List<Servlet>	servlet
protected List<ServletMapping>	servletMapping
protected List<SessionConfig>	sessionConfig
protected String	version
protected List<WelcomeFileList>	welcomeFileList

Constructor Summary

WebApp()

Method Summary

WebApp	addFilter(String name, String clazz, String... mappings)
WebApp	addFilterInitParam(String filterName, String name, String value)
WebApp	addInitParam(String servletName, String name, String value)
WebApp	addListener(String classname)
void	addPostConstruct(String method)
void	addPreDestroy(String method)
WebApp	addServlet(String name, String clazz, String... mappings)
WebApp	addServletMapping(String servletName, String mapping)
Map<String,String>	contextParamsAsMap()
WebApp	contextRoot(String root)
AbsoluteOrdering	getAbsoluteOrdering()
List<ParamValue>	getContextParam()
String	getContextRoot()
Collection<DataSource>	getDataSource()
Map<String,DataSource>	getDataSourceMap()
String	getDescription()
Text[]	getDescriptions()
String	getDisplayName()
Text[]	getDisplayNames()
List<Empty>	getDistributable()
Collection<EjbLocalRef>	getEjbLocalRef()
Map<String,EjbLocalRef>	getEjbLocalRefMap()
Collection<EjbRef>	getEjbRef()
Map<String,EjbRef>	getEjbRefMap()
Collection<EnvEntry>	getEnvEntry()
Map<String,EnvEntry>	getEnvEntryMap()
List<ErrorPage>	getErrorPage()
List<Filter>	getFilter()
List<FilterMapping>	getFilterMapping()
List<String>	getFilterMappings(String filterName)
Icon	getIcon()
Map<String,Icon>	getIconMap()
Collection<Icon>	getIcons()
String	getId()
String	getJndiConsumerName()
List<JspConfig>	getJspConfig()
List<Listener>	getListener()
List<LocaleEncodingMappingList>	getLocaleEncodingMappingList()
List<LoginConfig>	getLoginConfig()
List<MessageDestination>	getMessageDestination()
Collection<MessageDestinationRef>	getMessageDestinationRef()
Map<String,MessageDestinationRef>	getMessageDestinationRefMap()
List<MimeMapping>	getMimeMapping()
String	getModuleName()
Collection<PersistenceContextRef>	getPersistenceContextRef()
Map<String,PersistenceContextRef>	getPersistenceContextRefMap()
Collection<PersistenceUnitRef>	getPersistenceUnitRef()
Map<String,PersistenceUnitRef>	getPersistenceUnitRefMap()
List<LifecycleCallback>	getPostConstruct()
List<LifecycleCallback>	getPreDestroy()
Collection<ResourceEnvRef>	getResourceEnvRef()
Map<String,ResourceEnvRef>	getResourceEnvRefMap()
Collection<ResourceRef>	getResourceRef()
Map<String,ResourceRef>	getResourceRefMap()
List<SecurityConstraint>	getSecurityConstraint()
List<SecurityRole>	getSecurityRole()
Collection<ServiceRef>	getServiceRef()
Map<String,ServiceRef>	getServiceRefMap()
List<Servlet>	getServlet()
List<ServletMapping>	getServletMapping()
List<String>	getServletMappings(String servletName)
List<SessionConfig>	getSessionConfig()
Taglib	getTaglib()
String	getVersion()
List<WelcomeFileList>	getWelcomeFileList()
Boolean	isMetadataComplete()
void	setAbsoluteOrdering(AbsoluteOrdering absoluteOrdering)
void	setContextRoot(String contextRoot)
void	setDescriptions(Text[] text)
void	setDisplayNames(Text[] text)
void	setId(String value)
void	setMetadataComplete(Boolean value)
void	setModuleName(String moduleName)
void	setTaglib(Taglib taglib)
void	setVersion(String value)

Methods inherited from class java.lang.Object

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

Field Detail

description

protected TextMap description

displayName

protected TextMap displayName

icon

protected LocalCollection<Icon> icon

distributable

protected List<Empty> distributable

contextParam

protected List<ParamValue> contextParam

filter

protected List<Filter> filter

filterMapping

protected List<FilterMapping> filterMapping

listener

protected List<Listener> listener

servlet

protected List<Servlet> servlet

servletMapping

protected List<ServletMapping> servletMapping

sessionConfig

protected List<SessionConfig> sessionConfig

mimeMapping

protected List<MimeMapping> mimeMapping

welcomeFileList

protected List<WelcomeFileList> welcomeFileList

errorPage

protected List<ErrorPage> errorPage

jspConfig

protected List<JspConfig> jspConfig

securityConstraint

protected List<SecurityConstraint> securityConstraint

loginConfig

protected List<LoginConfig> loginConfig

securityRole

protected List<SecurityRole> securityRole

localeEncodingMappingList

protected List<LocaleEncodingMappingList> localeEncodingMappingList

envEntry

protected KeyedCollection<String,EnvEntry> envEntry

ejbRef

protected KeyedCollection<String,EjbRef> ejbRef

ejbLocalRef

protected KeyedCollection<String,EjbLocalRef> ejbLocalRef

serviceRef

protected KeyedCollection<String,ServiceRef> serviceRef

resourceRef

protected KeyedCollection<String,ResourceRef> resourceRef

resourceEnvRef

protected KeyedCollection<String,ResourceEnvRef> resourceEnvRef

messageDestinationRef

protected KeyedCollection<String,MessageDestinationRef> messageDestinationRef

persistenceContextRef

protected KeyedCollection<String,PersistenceContextRef> persistenceContextRef

persistenceUnitRef

protected KeyedCollection<String,PersistenceUnitRef> persistenceUnitRef

dataSource

protected KeyedCollection<String,DataSource> dataSource

postConstruct

protected List<LifecycleCallback> postConstruct

preDestroy

protected List<LifecycleCallback> preDestroy

messageDestination

protected List<MessageDestination> messageDestination

moduleName

protected String moduleName

absoluteOrdering

protected AbsoluteOrdering absoluteOrdering

id

protected String id

metadataComplete

protected Boolean metadataComplete

version

protected String version

Constructor Detail

WebApp

public WebApp()

Method Detail

getJndiConsumerName

public String getJndiConsumerName()

Specified by:

getJndiConsumerName in interface JndiConsumer

Specified by:

getJndiConsumerName in interface WebCommon

getContextRoot

public String getContextRoot()

Specified by:

getContextRoot in interface WebCommon

setContextRoot

public void setContextRoot(String contextRoot)

Specified by:

setContextRoot in interface WebCommon

getDescriptions

public Text[] getDescriptions()

Specified by:

getDescriptions in interface WebCommon

setDescriptions

public void setDescriptions(Text[] text)

Specified by:

setDescriptions in interface WebCommon

getDescription

public String getDescription()

Specified by:

getDescription in interface WebCommon

getDisplayNames

public Text[] getDisplayNames()

Specified by:

getDisplayNames in interface WebCommon

setDisplayNames

public void setDisplayNames(Text[] text)

Specified by:

setDisplayNames in interface WebCommon

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface WebCommon

getIcons

public Collection<Icon> getIcons()

Specified by:

getIcons in interface WebCommon

getIconMap

public Map<String,Icon> getIconMap()

Specified by:

getIconMap in interface WebCommon

getIcon

public Icon getIcon()

Specified by:

getIcon in interface WebCommon

getDistributable

public List<Empty> getDistributable()

Specified by:

getDistributable in interface WebCommon

getContextParam

public List<ParamValue> getContextParam()

Specified by:

getContextParam in interface WebCommon

getFilter

public List<Filter> getFilter()

Specified by:

getFilter in interface WebCommon

getFilterMapping

public List<FilterMapping> getFilterMapping()

Specified by:

getFilterMapping in interface WebCommon

getListener

public List<Listener> getListener()

Specified by:

getListener in interface WebCommon

getServlet

public List<Servlet> getServlet()

Specified by:

getServlet in interface WebCommon

getServletMapping

public List<ServletMapping> getServletMapping()

Specified by:

getServletMapping in interface WebCommon

getSessionConfig

public List<SessionConfig> getSessionConfig()

Specified by:

getSessionConfig in interface WebCommon

getMimeMapping

public List<MimeMapping> getMimeMapping()

Specified by:

getMimeMapping in interface WebCommon

getWelcomeFileList

public List<WelcomeFileList> getWelcomeFileList()

Specified by:

getWelcomeFileList in interface WebCommon

getErrorPage

public List<ErrorPage> getErrorPage()

Specified by:

getErrorPage in interface WebCommon

getJspConfig

public List<JspConfig> getJspConfig()

Specified by:

getJspConfig in interface WebCommon

getSecurityConstraint

public List<SecurityConstraint> getSecurityConstraint()

Specified by:

getSecurityConstraint in interface WebCommon

getLoginConfig

public List<LoginConfig> getLoginConfig()

Specified by:

getLoginConfig in interface WebCommon

getSecurityRole

public List<SecurityRole> getSecurityRole()

Specified by:

getSecurityRole in interface WebCommon

getLocaleEncodingMappingList

public List<LocaleEncodingMappingList> getLocaleEncodingMappingList()

Specified by:

getLocaleEncodingMappingList in interface WebCommon

getEnvEntry

public Collection<EnvEntry> getEnvEntry()

Specified by:

getEnvEntry in interface JndiConsumer

getEnvEntryMap

public Map<String,EnvEntry> getEnvEntryMap()

Specified by:

getEnvEntryMap in interface JndiConsumer

getEjbRef

public Collection<EjbRef> getEjbRef()

Specified by:

getEjbRef in interface JndiConsumer

getEjbRefMap

public Map<String,EjbRef> getEjbRefMap()

Specified by:

getEjbRefMap in interface JndiConsumer

getEjbLocalRef

public Collection<EjbLocalRef> getEjbLocalRef()

Specified by:

getEjbLocalRef in interface JndiConsumer

getEjbLocalRefMap

public Map<String,EjbLocalRef> getEjbLocalRefMap()

Specified by:

getEjbLocalRefMap in interface JndiConsumer

getServiceRef

public Collection<ServiceRef> getServiceRef()

Specified by:

getServiceRef in interface JndiConsumer

getServiceRefMap

public Map<String,ServiceRef> getServiceRefMap()

Specified by:

getServiceRefMap in interface JndiConsumer

getResourceRef

public Collection<ResourceRef> getResourceRef()

Specified by:

getResourceRef in interface JndiConsumer

getResourceRefMap

public Map<String,ResourceRef> getResourceRefMap()

Specified by:

getResourceRefMap in interface JndiConsumer

getResourceEnvRef

public Collection<ResourceEnvRef> getResourceEnvRef()

Specified by:

getResourceEnvRef in interface JndiConsumer

getResourceEnvRefMap

public Map<String,ResourceEnvRef> getResourceEnvRefMap()

Specified by:

getResourceEnvRefMap in interface JndiConsumer

getMessageDestinationRef

public Collection<MessageDestinationRef> getMessageDestinationRef()

Specified by:

getMessageDestinationRef in interface JndiConsumer

getMessageDestinationRefMap

public Map<String,MessageDestinationRef> getMessageDestinationRefMap()

Specified by:

getMessageDestinationRefMap in interface JndiConsumer

getPersistenceContextRef

public Collection<PersistenceContextRef> getPersistenceContextRef()

Specified by:

getPersistenceContextRef in interface JndiConsumer

getPersistenceContextRefMap

public Map<String,PersistenceContextRef> getPersistenceContextRefMap()

Specified by:

getPersistenceContextRefMap in interface JndiConsumer

getPersistenceUnitRef

public Collection<PersistenceUnitRef> getPersistenceUnitRef()

Specified by:

getPersistenceUnitRef in interface JndiConsumer

getPersistenceUnitRefMap

public Map<String,PersistenceUnitRef> getPersistenceUnitRefMap()

Specified by:

getPersistenceUnitRefMap in interface JndiConsumer

addPostConstruct

public void addPostConstruct(String method)

Specified by:

addPostConstruct in interface Lifecycle

getPostConstruct

public List<LifecycleCallback> getPostConstruct()

Specified by:

getPostConstruct in interface Lifecycle

Specified by:

getPostConstruct in interface WebCommon

addPreDestroy

public void addPreDestroy(String method)

Specified by:

addPreDestroy in interface Lifecycle

getPreDestroy

public List<LifecycleCallback> getPreDestroy()

Specified by:

getPreDestroy in interface Lifecycle

Specified by:

getPreDestroy in interface WebCommon

getMessageDestination

public List<MessageDestination> getMessageDestination()

Specified by:

getMessageDestination in interface WebCommon

getId

public String getId()

Specified by:

getId in interface NamedModule

Specified by:

getId in interface WebCommon

setId

public void setId(String value)

Specified by:

setId in interface NamedModule

Specified by:

setId in interface WebCommon

isMetadataComplete

public Boolean isMetadataComplete()

Specified by:

isMetadataComplete in interface WebCommon

setMetadataComplete

public void setMetadataComplete(Boolean value)

Specified by:

setMetadataComplete in interface WebCommon

getVersion

public String getVersion()

Specified by:

getVersion in interface WebCommon

setVersion

public void setVersion(String value)

Specified by:

setVersion in interface WebCommon

getDataSource

public Collection<DataSource> getDataSource()

Specified by:

getDataSource in interface JndiConsumer

getDataSourceMap

public Map<String,DataSource> getDataSourceMap()

Specified by:

getDataSourceMap in interface JndiConsumer

getAbsoluteOrdering

public AbsoluteOrdering getAbsoluteOrdering()

setAbsoluteOrdering

public void setAbsoluteOrdering(AbsoluteOrdering absoluteOrdering)

getModuleName

public String getModuleName()

Specified by:

getModuleName in interface NamedModule

setModuleName

public void setModuleName(String moduleName)

Specified by:

setModuleName in interface NamedModule

getTaglib

public Taglib getTaglib()

setTaglib

public void setTaglib(Taglib taglib)

contextParamsAsMap

public Map<String,String> contextParamsAsMap()

getServletMappings

public List<String> getServletMappings(String servletName)

getFilterMappings

public List<String> getFilterMappings(String filterName)

addServlet

public WebApp addServlet(String name,
                         String clazz,
                         String... mappings)

addServletMapping

public WebApp addServletMapping(String servletName,
                                String mapping)

addInitParam

public WebApp addInitParam(String servletName,
                           String name,
                           String value)

addFilter

public WebApp addFilter(String name,
                        String clazz,
                        String... mappings)

addFilterInitParam

public WebApp addFilterInitParam(String filterName,
                                 String name,
                                 String value)

contextRoot

public WebApp contextRoot(String root)

addListener

public WebApp addListener(String classname)