org.jboss.metadata.web.spec
Class WebMetaData

java.lang.Object
  extended by org.jboss.metadata.javaee.support.IdMetaDataImpl
      extended by org.jboss.metadata.javaee.support.IdMetaDataImplWithDescriptionGroup
          extended by org.jboss.metadata.web.spec.WebMetaData
All Implemented Interfaces:
Serializable, Cloneable, Environment, RemoteEnvironment, IdMetaData
Direct Known Subclasses:
Web23MetaData, Web24MetaData, Web25MetaData

public class WebMetaData
extends IdMetaDataImplWithDescriptionGroup
implements Environment

The web-app spec metadata

Version:
$Revision: 70996 $
Author:
Scott.Stark@jboss.org
See Also:
Serialized Form

Constructor Summary
WebMetaData()
           
 
Method Summary
 AnnotatedEJBReferencesMetaData getAnnotatedEjbReferences()
          Get the ejbReferences.
 List<ParamValueMetaData> getContextParams()
           
 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)
          Get by name
 EJBLocalReferencesMetaData getEjbLocalReferences()
          Get the ejbLocalReferences.
 EJBReferenceMetaData getEjbReferenceByName(String name)
          Get by name
 EJBReferencesMetaData getEjbReferences()
          Get the ejbReferences.
 EnvironmentEntriesMetaData getEnvironmentEntries()
          Get the environmentEntries.
 EnvironmentEntryMetaData getEnvironmentEntryByName(String name)
          Get by name
 List<ErrorPageMetaData> getErrorPages()
           
 List<FilterMappingMetaData> getFilterMappings()
           
 FiltersMetaData getFilters()
           
 EnvironmentRefsGroupMetaData getJndiEnvironmentRefsGroup()
          Get the jndiEnvironmentRefsGroup.
 JspConfigMetaData getJspConfig()
           
 List<ListenerMetaData> getListeners()
           
 LocaleEncodingsMetaData getLocalEncodings()
           
 LoginConfigMetaData getLoginConfig()
           
 MessageDestinationReferenceMetaData getMessageDestinationReferenceByName(String name)
          Get by name
 MessageDestinationReferencesMetaData getMessageDestinationReferences()
          Get the messageDestinationReferences.
 MessageDestinationsMetaData getMessageDestinations()
           
 List<MimeMappingMetaData> getMimeMappings()
           
 PersistenceContextReferenceMetaData getPersistenceContextReferenceByName(String name)
          Get by name
 PersistenceContextReferencesMetaData getPersistenceContextRefs()
          Get the persistenceContextRefs.
 PersistenceUnitReferenceMetaData getPersistenceUnitReferenceByName(String name)
          Get by name
 PersistenceUnitReferencesMetaData getPersistenceUnitRefs()
          Get the persistenceUnitRefs.
 LifecycleCallbacksMetaData getPostConstructs()
          Get the postConstructs.
 LifecycleCallbacksMetaData getPreDestroys()
          Get the preDestroys.
 ResourceEnvironmentReferenceMetaData getResourceEnvironmentReferenceByName(String name)
          Get by name
 ResourceEnvironmentReferencesMetaData getResourceEnvironmentReferences()
          Get the resourceEnvironmentReferences.
 ResourceReferenceMetaData getResourceReferenceByName(String name)
          Get by name
 ResourceReferencesMetaData getResourceReferences()
          Get the resourceReferences.
 List<SecurityConstraintMetaData> getSecurityContraints()
           
 SecurityRolesMetaData getSecurityRoles()
           
 ServiceReferenceMetaData getServiceReferenceByName(String name)
          Get by name
 ServiceReferencesMetaData getServiceReferences()
          Get the service references
 List<ServletMappingMetaData> getServletMappings()
           
 ServletsMetaData getServlets()
           
 SessionConfigMetaData getSessionConfig()
           
 String getVersion()
           
 WelcomeFileListMetaData getWelcomeFileList()
           
 boolean is23()
          Is this a servlet 2.3 version application
 boolean is24()
           
 boolean is25()
           
 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 setSecurityContraints(List<SecurityConstraintMetaData> securityContraints)
           
 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, merge, setDescriptionGroup
 
Methods inherited from class org.jboss.metadata.javaee.support.IdMetaDataImpl
clone, equals, getId, hashCode, merge, merge, setId
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WebMetaData

public WebMetaData()
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)

is23

public boolean is23()
Is this a servlet 2.3 version application

Returns:
true if this is a javaee 2.3 version application

is24

public boolean is24()

is25

public boolean is25()

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)

getSecurityContraints

public List<SecurityConstraintMetaData> getSecurityContraints()

setSecurityContraints

public void setSecurityContraints(List<SecurityConstraintMetaData> securityContraints)

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.

Parameters:
jndiEnvironmentRefsGroup - the jndiEnvironmentRefsGroup.
Throws:
IllegalArgumentException - for a null jndiEnvironmentRefsGroup

getEjbLocalReferenceByName

public EJBLocalReferenceMetaData getEjbLocalReferenceByName(String name)
Description copied from interface: Environment
Get by name

Specified by:
getEjbLocalReferenceByName in interface Environment
Parameters:
name - the name
Returns:
the result or null if not found

getEjbLocalReferences

public EJBLocalReferencesMetaData getEjbLocalReferences()
Description copied from interface: Environment
Get the ejbLocalReferences.

Specified by:
getEjbLocalReferences in interface Environment
Returns:
the ejbLocalReferences.

getEjbReferenceByName

public EJBReferenceMetaData getEjbReferenceByName(String name)
Description copied from interface: RemoteEnvironment
Get by name

Specified by:
getEjbReferenceByName in interface RemoteEnvironment
Parameters:
name - the name
Returns:
the result or null if not found

getEjbReferences

public EJBReferencesMetaData getEjbReferences()
Description copied from interface: RemoteEnvironment
Get the ejbReferences.

Specified by:
getEjbReferences in interface RemoteEnvironment
Returns:
the ejbReferences.

getAnnotatedEjbReferences

public AnnotatedEJBReferencesMetaData getAnnotatedEjbReferences()
Description copied from interface: RemoteEnvironment
Get the ejbReferences.

Specified by:
getAnnotatedEjbReferences in interface RemoteEnvironment
Returns:
the ejbReferences.

getEnvironmentEntries

public EnvironmentEntriesMetaData getEnvironmentEntries()
Description copied from interface: RemoteEnvironment
Get the environmentEntries.

Specified by:
getEnvironmentEntries in interface RemoteEnvironment
Returns:
the environmentEntries.

getEnvironmentEntryByName

public EnvironmentEntryMetaData getEnvironmentEntryByName(String name)
Description copied from interface: RemoteEnvironment
Get by name

Specified by:
getEnvironmentEntryByName in interface RemoteEnvironment
Parameters:
name - the name
Returns:
the result or null if not found

getMessageDestinationReferenceByName

public MessageDestinationReferenceMetaData getMessageDestinationReferenceByName(String name)
Description copied from interface: RemoteEnvironment
Get by name

Specified by:
getMessageDestinationReferenceByName in interface RemoteEnvironment
Parameters:
name - the name
Returns:
the result or null if not found

getMessageDestinationReferences

public MessageDestinationReferencesMetaData getMessageDestinationReferences()
Description copied from interface: RemoteEnvironment
Get the messageDestinationReferences.

Specified by:
getMessageDestinationReferences in interface RemoteEnvironment
Returns:
the messageDestinationReferences.

getPersistenceContextReferenceByName

public PersistenceContextReferenceMetaData getPersistenceContextReferenceByName(String name)
Description copied from interface: Environment
Get by name

Specified by:
getPersistenceContextReferenceByName in interface Environment
Parameters:
name - the name
Returns:
the result or null if not found

getPersistenceContextRefs

public PersistenceContextReferencesMetaData getPersistenceContextRefs()
Description copied from interface: Environment
Get the persistenceContextRefs.

Specified by:
getPersistenceContextRefs in interface Environment
Returns:
the persistenceContextRefs.

getPersistenceUnitReferenceByName

public PersistenceUnitReferenceMetaData getPersistenceUnitReferenceByName(String name)
Description copied from interface: RemoteEnvironment
Get by name

Specified by:
getPersistenceUnitReferenceByName in interface RemoteEnvironment
Parameters:
name - the name
Returns:
the result or null if not found

getPersistenceUnitRefs

public PersistenceUnitReferencesMetaData getPersistenceUnitRefs()
Description copied from interface: RemoteEnvironment
Get the persistenceUnitRefs.

Specified by:
getPersistenceUnitRefs in interface RemoteEnvironment
Returns:
the persistenceUnitRefs.

getPostConstructs

public LifecycleCallbacksMetaData getPostConstructs()
Description copied from interface: RemoteEnvironment
Get the postConstructs.

Specified by:
getPostConstructs in interface RemoteEnvironment
Returns:
the postConstructs.

getPreDestroys

public LifecycleCallbacksMetaData getPreDestroys()
Description copied from interface: RemoteEnvironment
Get the preDestroys.

Specified by:
getPreDestroys in interface RemoteEnvironment
Returns:
the preDestroys.

getResourceEnvironmentReferenceByName

public ResourceEnvironmentReferenceMetaData getResourceEnvironmentReferenceByName(String name)
Description copied from interface: RemoteEnvironment
Get by name

Specified by:
getResourceEnvironmentReferenceByName in interface RemoteEnvironment
Parameters:
name - the name
Returns:
the result or null if not found

getResourceEnvironmentReferences

public ResourceEnvironmentReferencesMetaData getResourceEnvironmentReferences()
Description copied from interface: RemoteEnvironment
Get the resourceEnvironmentReferences.

Specified by:
getResourceEnvironmentReferences in interface RemoteEnvironment
Returns:
the resourceEnvironmentReferences.

getResourceReferenceByName

public ResourceReferenceMetaData getResourceReferenceByName(String name)
Description copied from interface: RemoteEnvironment
Get by name

Specified by:
getResourceReferenceByName in interface RemoteEnvironment
Parameters:
name - the name
Returns:
the result or null if not found

getResourceReferences

public ResourceReferencesMetaData getResourceReferences()
Description copied from interface: RemoteEnvironment
Get the resourceReferences.

Specified by:
getResourceReferences in interface RemoteEnvironment
Returns:
the resourceReferences.

getServiceReferenceByName

public ServiceReferenceMetaData getServiceReferenceByName(String name)
Description copied from interface: RemoteEnvironment
Get by name

Specified by:
getServiceReferenceByName in interface RemoteEnvironment
Parameters:
name - the name
Returns:
the result or null if not found

getServiceReferences

public ServiceReferencesMetaData getServiceReferences()
Description copied from interface: RemoteEnvironment
Get the service references

Specified by:
getServiceReferences in interface RemoteEnvironment
Returns:

getMessageDestinations

public MessageDestinationsMetaData getMessageDestinations()

setMessageDestinations

public void setMessageDestinations(MessageDestinationsMetaData messageDestinations)


Copyright © 2009 JBoss Inc.. All Rights Reserved.