Package org.jboss.metadata.web.spec

Class WebCommonMetaData

java.lang.Object

org.jboss.metadata.javaee.support.IdMetaDataImpl

org.jboss.metadata.javaee.support.IdMetaDataImplWithDescriptionGroup

org.jboss.metadata.web.spec.WebCommonMetaData

All Implemented Interfaces:

Serializable, Cloneable, Environment, RemoteEnvironment, IdMetaData

Direct Known Subclasses:

WebFragmentMetaData, WebMetaData

public class WebCommonMetaData
extends IdMetaDataImplWithDescriptionGroup
implements Environment

The web-app spec metadata, common between the fragments and the main web.xml

Version:

$Revision: 70996 $

Author:

Scott.Stark@jboss.org

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
WebCommonMetaData()

Method Summary

Modifier and Type	Method	Description
AdministeredObjectMetaData	getAdministeredObjectByName(String name)
AdministeredObjectsMetaData	getAdministeredObjects()
AnnotatedEJBReferencesMetaData	getAnnotatedEjbReferences()
AnnotationsMetaData	getAnnotations()
ConnectionFactoriesMetaData	getConnectionFactories()
ConnectionFactoryMetaData	getConnectionFactoryByName(String name)
List<ParamValueMetaData>	getContextParams()
ContextServiceMetaData	getContextServiceByName(String name)
ContextServicesMetaData	getContextServices()
DataSourceMetaData	getDataSourceByName(String name)
DataSourcesMetaData	getDataSources()
EmptyMetaData	getDistributable()
String	getDtdPublicId()	Get the DTD public id if one was seen
String	getDtdSystemId()	Get the DTD system id if one was seen
EJBLocalReferenceMetaData	getEjbLocalReferenceByName(String name)
EJBLocalReferencesMetaData	getEjbLocalReferences()
EJBReferenceMetaData	getEjbReferenceByName(String name)
EJBReferencesMetaData	getEjbReferences()
EnvironmentEntriesMetaData	getEnvironmentEntries()
EnvironmentEntryMetaData	getEnvironmentEntryByName(String name)
List<ErrorPageMetaData>	getErrorPages()
List<FilterMappingMetaData>	getFilterMappings()
FiltersMetaData	getFilters()
JMSConnectionFactoriesMetaData	getJmsConnectionFactories()
JMSConnectionFactoryMetaData	getJmsConnectionFactoryByName(String name)
JMSDestinationMetaData	getJmsDestinationByName(String name)
JMSDestinationsMetaData	getJmsDestinations()
EnvironmentRefsGroupMetaData	getJndiEnvironmentRefsGroup()	Get the jndiEnvironmentRefsGroup.
JspConfigMetaData	getJspConfig()
List<ListenerMetaData>	getListeners()
LocaleEncodingsMetaData	getLocalEncodings()
LoginConfigMetaData	getLoginConfig()
MailSessionMetaData	getMailSessionByName(String name)
MailSessionsMetaData	getMailSessions()
ManagedExecutorMetaData	getManagedExecutorByName(String name)
ManagedExecutorsMetaData	getManagedExecutors()
ManagedScheduledExecutorMetaData	getManagedScheduledExecutorByName(String name)
ManagedScheduledExecutorsMetaData	getManagedScheduledExecutors()
ManagedThreadFactoriesMetaData	getManagedThreadFactories()
ManagedThreadFactoryMetaData	getManagedThreadFactoryByName(String name)
MessageDestinationReferenceMetaData	getMessageDestinationReferenceByName(String name)
MessageDestinationReferencesMetaData	getMessageDestinationReferences()
MessageDestinationsMetaData	getMessageDestinations()
List<MimeMappingMetaData>	getMimeMappings()
PersistenceContextReferenceMetaData	getPersistenceContextReferenceByName(String name)
PersistenceContextReferencesMetaData	getPersistenceContextRefs()
PersistenceUnitReferenceMetaData	getPersistenceUnitReferenceByName(String name)
PersistenceUnitReferencesMetaData	getPersistenceUnitRefs()
LifecycleCallbacksMetaData	getPostConstructs()
LifecycleCallbacksMetaData	getPreDestroys()
ResourceEnvironmentReferenceMetaData	getResourceEnvironmentReferenceByName(String name)
ResourceEnvironmentReferencesMetaData	getResourceEnvironmentReferences()
ResourceReferenceMetaData	getResourceReferenceByName(String name)
ResourceReferencesMetaData	getResourceReferences()
String	getSchemaLocation()
List<SecurityConstraintMetaData>	getSecurityConstraints()
SecurityRolesMetaData	getSecurityRoles()
ServiceReferenceMetaData	getServiceReferenceByName(String name)
ServiceReferencesMetaData	getServiceReferences()
List<ServletMappingMetaData>	getServletMappings()
ServletsMetaData	getServlets()
SessionConfigMetaData	getSessionConfig()
String	getVersion()
WelcomeFileListMetaData	getWelcomeFileList()
boolean	is23()	Is this a servlet 2.3 versionString application
boolean	is24()
boolean	is25()
boolean	is30()
boolean	is31()
void	setAnnotations(AnnotationsMetaData annotations)
void	setContextParams(List<ParamValueMetaData> params)
void	setDistributable(EmptyMetaData distributable)
void	setDTD(String root, String publicId, String systemId)	Callback for the DTD information
void	setErrorPages(List<ErrorPageMetaData> errorPages)
void	setFilterMappings(List<FilterMappingMetaData> filterMappings)
void	setFilters(FiltersMetaData filters)
void	setJndiEnvironmentRefsGroup(EnvironmentRefsGroupMetaData env)	Set the jndiEnvironmentRefsGroup.
void	setJspConfig(JspConfigMetaData jspConfig)
void	setListeners(List<ListenerMetaData> listeners)
void	setLocalEncodings(LocaleEncodingsMetaData localEncodings)
void	setLoginConfig(LoginConfigMetaData loginConfig)
void	setMessageDestinations(MessageDestinationsMetaData messageDestinations)
void	setMimeMappings(List<MimeMappingMetaData> mimeMappings)
void	setSchemaLocation(String schemaLocation)
void	setSecurityConstraints(List<SecurityConstraintMetaData> securityConstraints)
void	setSecurityRoles(SecurityRolesMetaData securityRoles)
void	setServletMappings(List<ServletMappingMetaData> servletMappings)
void	setServlets(ServletsMetaData servlets)
void	setSessionConfig(SessionConfigMetaData sessionConfig)
void	setVersion(String version)
void	setWelcomeFileList(WelcomeFileListMetaData welcomeFileList)

Methods inherited from class org.jboss.metadata.javaee.support.IdMetaDataImplWithDescriptionGroup

getDescriptionGroup, setDescriptionGroup

Methods inherited from class org.jboss.metadata.javaee.support.IdMetaDataImpl

clone, equals, getId, hashCode, setId

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebCommonMetaData

public WebCommonMetaData()

Method Detail

setDTD

public void setDTD(String root,
                   String publicId,
                   String systemId)

Callback for the DTD information

Parameters:

root -

publicId -

systemId -

getDtdPublicId

public String getDtdPublicId()

Get the DTD public id if one was seen

Returns:

the value of the web.xml dtd public id

getDtdSystemId

public String getDtdSystemId()

Get the DTD system id if one was seen

Returns:

the value of the web.xml dtd system id

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

getSchemaLocation

public String getSchemaLocation()

setSchemaLocation

public void setSchemaLocation(String schemaLocation)

is23

public boolean is23()

Is this a servlet 2.3 versionString application

Returns:

true if this is a javaee 2.3 versionString application

is24

public boolean is24()

is25

public boolean is25()

is30

public boolean is30()

is31

public boolean is31()

getDistributable

public EmptyMetaData getDistributable()

setDistributable

public void setDistributable(EmptyMetaData distributable)

getSessionConfig

public SessionConfigMetaData getSessionConfig()

setSessionConfig

public void setSessionConfig(SessionConfigMetaData sessionConfig)

getContextParams

public List<ParamValueMetaData> getContextParams()

setContextParams

public void setContextParams(List<ParamValueMetaData> params)

getFilters

public FiltersMetaData getFilters()

setFilters

public void setFilters(FiltersMetaData filters)

getFilterMappings

public List<FilterMappingMetaData> getFilterMappings()

setFilterMappings

public void setFilterMappings(List<FilterMappingMetaData> filterMappings)

getErrorPages

public List<ErrorPageMetaData> getErrorPages()

setErrorPages

public void setErrorPages(List<ErrorPageMetaData> errorPages)

getJspConfig

public JspConfigMetaData getJspConfig()

setJspConfig

public void setJspConfig(JspConfigMetaData jspConfig)

getListeners

public List<ListenerMetaData> getListeners()

setListeners

public void setListeners(List<ListenerMetaData> listeners)

getLocalEncodings

public LocaleEncodingsMetaData getLocalEncodings()

setLocalEncodings

public void setLocalEncodings(LocaleEncodingsMetaData localEncodings)

getLoginConfig

public LoginConfigMetaData getLoginConfig()

setLoginConfig

public void setLoginConfig(LoginConfigMetaData loginConfig)

getMimeMappings

public List<MimeMappingMetaData> getMimeMappings()

setMimeMappings

public void setMimeMappings(List<MimeMappingMetaData> mimeMappings)

getServlets

public ServletsMetaData getServlets()

setServlets

public void setServlets(ServletsMetaData servlets)

getServletMappings

public List<ServletMappingMetaData> getServletMappings()

setServletMappings

public void setServletMappings(List<ServletMappingMetaData> servletMappings)

getSecurityConstraints

public List<SecurityConstraintMetaData> getSecurityConstraints()

setSecurityConstraints

public void setSecurityConstraints(List<SecurityConstraintMetaData> securityConstraints)

getSecurityRoles

public SecurityRolesMetaData getSecurityRoles()

setSecurityRoles

public void setSecurityRoles(SecurityRolesMetaData securityRoles)

getWelcomeFileList

public WelcomeFileListMetaData getWelcomeFileList()

setWelcomeFileList

public void setWelcomeFileList(WelcomeFileListMetaData welcomeFileList)

getJndiEnvironmentRefsGroup

public EnvironmentRefsGroupMetaData getJndiEnvironmentRefsGroup()

Get the jndiEnvironmentRefsGroup.

Returns:

the jndiEnvironmentRefsGroup.

setJndiEnvironmentRefsGroup

public void setJndiEnvironmentRefsGroup(EnvironmentRefsGroupMetaData env)

Set the jndiEnvironmentRefsGroup. IT DOESN'T MERGE

Parameters:

env - the jndiEnvironmentRefsGroup.

Throws:

IllegalArgumentException - for a null jndiEnvironmentRefsGroup

getDataSourceByName

public DataSourceMetaData getDataSourceByName(String name)

Specified by:

getDataSourceByName in interface RemoteEnvironment

getDataSources

public DataSourcesMetaData getDataSources()

Specified by:

getDataSources in interface RemoteEnvironment

getEjbLocalReferenceByName

public EJBLocalReferenceMetaData getEjbLocalReferenceByName(String name)

Specified by:

getEjbLocalReferenceByName in interface Environment

getEjbLocalReferences

public EJBLocalReferencesMetaData getEjbLocalReferences()

Specified by:

getEjbLocalReferences in interface Environment

getEjbReferenceByName

public EJBReferenceMetaData getEjbReferenceByName(String name)

Specified by:

getEjbReferenceByName in interface RemoteEnvironment

getEjbReferences

public EJBReferencesMetaData getEjbReferences()

Specified by:

getEjbReferences in interface RemoteEnvironment

getAnnotatedEjbReferences

public AnnotatedEJBReferencesMetaData getAnnotatedEjbReferences()

Specified by:

getAnnotatedEjbReferences in interface RemoteEnvironment

getEnvironmentEntries

public EnvironmentEntriesMetaData getEnvironmentEntries()

Specified by:

getEnvironmentEntries in interface RemoteEnvironment

getEnvironmentEntryByName

public EnvironmentEntryMetaData getEnvironmentEntryByName(String name)

Specified by:

getEnvironmentEntryByName in interface RemoteEnvironment

getMessageDestinationReferenceByName

public MessageDestinationReferenceMetaData getMessageDestinationReferenceByName(String name)

Specified by:

getMessageDestinationReferenceByName in interface RemoteEnvironment

getMessageDestinationReferences

public MessageDestinationReferencesMetaData getMessageDestinationReferences()

Specified by:

getMessageDestinationReferences in interface RemoteEnvironment

getPersistenceContextReferenceByName

public PersistenceContextReferenceMetaData getPersistenceContextReferenceByName(String name)

Specified by:

getPersistenceContextReferenceByName in interface Environment

getPersistenceContextRefs

public PersistenceContextReferencesMetaData getPersistenceContextRefs()

Specified by:

getPersistenceContextRefs in interface Environment

getPersistenceUnitReferenceByName

public PersistenceUnitReferenceMetaData getPersistenceUnitReferenceByName(String name)

Specified by:

getPersistenceUnitReferenceByName in interface RemoteEnvironment

getPersistenceUnitRefs

public PersistenceUnitReferencesMetaData getPersistenceUnitRefs()

Specified by:

getPersistenceUnitRefs in interface RemoteEnvironment

getPostConstructs

public LifecycleCallbacksMetaData getPostConstructs()

Specified by:

getPostConstructs in interface RemoteEnvironment

getPreDestroys

public LifecycleCallbacksMetaData getPreDestroys()

Specified by:

getPreDestroys in interface RemoteEnvironment

getResourceEnvironmentReferenceByName

public ResourceEnvironmentReferenceMetaData getResourceEnvironmentReferenceByName(String name)

Specified by:

getResourceEnvironmentReferenceByName in interface RemoteEnvironment

getResourceEnvironmentReferences

public ResourceEnvironmentReferencesMetaData getResourceEnvironmentReferences()

Specified by:

getResourceEnvironmentReferences in interface RemoteEnvironment

getResourceReferenceByName

public ResourceReferenceMetaData getResourceReferenceByName(String name)

Specified by:

getResourceReferenceByName in interface RemoteEnvironment

getResourceReferences

public ResourceReferencesMetaData getResourceReferences()

Specified by:

getResourceReferences in interface RemoteEnvironment

getServiceReferenceByName

public ServiceReferenceMetaData getServiceReferenceByName(String name)

Specified by:

getServiceReferenceByName in interface RemoteEnvironment

getServiceReferences

public ServiceReferencesMetaData getServiceReferences()

Specified by:

getServiceReferences in interface RemoteEnvironment

getAdministeredObjects

public AdministeredObjectsMetaData getAdministeredObjects()

Specified by:

getAdministeredObjects in interface RemoteEnvironment

getAdministeredObjectByName

public AdministeredObjectMetaData getAdministeredObjectByName(String name)
                                                       throws IllegalArgumentException

Specified by:

getAdministeredObjectByName in interface RemoteEnvironment

Throws:

IllegalArgumentException

getConnectionFactories

public ConnectionFactoriesMetaData getConnectionFactories()

Specified by:

getConnectionFactories in interface RemoteEnvironment

getConnectionFactoryByName

public ConnectionFactoryMetaData getConnectionFactoryByName(String name)
                                                     throws IllegalArgumentException

Specified by:

getConnectionFactoryByName in interface RemoteEnvironment

Throws:

IllegalArgumentException

getJmsConnectionFactories

public JMSConnectionFactoriesMetaData getJmsConnectionFactories()

Specified by:

getJmsConnectionFactories in interface RemoteEnvironment

getJmsConnectionFactoryByName

public JMSConnectionFactoryMetaData getJmsConnectionFactoryByName(String name)
                                                           throws IllegalArgumentException

Specified by:

getJmsConnectionFactoryByName in interface RemoteEnvironment

Throws:

IllegalArgumentException

getJmsDestinations

public JMSDestinationsMetaData getJmsDestinations()

Specified by:

getJmsDestinations in interface RemoteEnvironment

getJmsDestinationByName

public JMSDestinationMetaData getJmsDestinationByName(String name)
                                               throws IllegalArgumentException

Specified by:

getJmsDestinationByName in interface RemoteEnvironment

Throws:

IllegalArgumentException

getMailSessions

public MailSessionsMetaData getMailSessions()

Specified by:

getMailSessions in interface RemoteEnvironment

getMailSessionByName

public MailSessionMetaData getMailSessionByName(String name)
                                         throws IllegalArgumentException

Specified by:

getMailSessionByName in interface RemoteEnvironment

Throws:

IllegalArgumentException

getMessageDestinations

public MessageDestinationsMetaData getMessageDestinations()

setMessageDestinations

public void setMessageDestinations(MessageDestinationsMetaData messageDestinations)

getContextServices

public ContextServicesMetaData getContextServices()

Specified by:

getContextServices in interface Environment

getContextServiceByName

public ContextServiceMetaData getContextServiceByName(String name)
                                               throws IllegalArgumentException

Specified by:

getContextServiceByName in interface Environment

Throws:

IllegalArgumentException

getManagedExecutors

public ManagedExecutorsMetaData getManagedExecutors()

Specified by:

getManagedExecutors in interface Environment

getManagedExecutorByName

public ManagedExecutorMetaData getManagedExecutorByName(String name)
                                                 throws IllegalArgumentException

Specified by:

getManagedExecutorByName in interface Environment

Throws:

IllegalArgumentException

getManagedScheduledExecutors

public ManagedScheduledExecutorsMetaData getManagedScheduledExecutors()

Specified by:

getManagedScheduledExecutors in interface Environment

getManagedScheduledExecutorByName

public ManagedScheduledExecutorMetaData getManagedScheduledExecutorByName(String name)
                                                                   throws IllegalArgumentException

Specified by:

getManagedScheduledExecutorByName in interface Environment

Throws:

IllegalArgumentException

getManagedThreadFactories

public ManagedThreadFactoriesMetaData getManagedThreadFactories()

Specified by:

getManagedThreadFactories in interface Environment

getManagedThreadFactoryByName

public ManagedThreadFactoryMetaData getManagedThreadFactoryByName(String name)
                                                           throws IllegalArgumentException

Specified by:

getManagedThreadFactoryByName in interface Environment

Throws:

IllegalArgumentException

getAnnotations

public AnnotationsMetaData getAnnotations()

setAnnotations

public void setAnnotations(AnnotationsMetaData annotations)