org.jboss.metadata.web.jboss
Class JBossWebMetaData

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.jboss.JBossWebMetaData
All Implemented Interfaces:
Serializable, Cloneable, IdMetaData
Direct Known Subclasses:
JBoss4xDTDWebMetaData, JBoss50DTDWebMetaData, JBoss50WebMetaData

public class JBossWebMetaData
extends IdMetaDataImplWithDescriptionGroup

The combined web.xml/jboss-web.xml metadata

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

Field Summary
static int SESSION_COOKIES_DEFAULT
           
static int SESSION_COOKIES_DISABLED
           
static int SESSION_COOKIES_ENABLED
           
 
Constructor Summary
JBossWebMetaData()
           
 
Method Summary
 String getAlternativeDD()
           
 HashMap getArbitraryMetadata()
           
 ClassLoadingMetaData getClassLoading()
           
 ClassLoader getContextLoader()
           
 List<ParamValueMetaData> getContextParams()
           
 String getContextRoot()
           
 List<String> getDepends()
           
 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()
           
 ClassLoader getENCLoader()
           
 EnvironmentEntriesMetaData getEnvironmentEntries()
           
 EnvironmentEntryMetaData getEnvironmentEntryByName(String name)
           
 List<ErrorPageMetaData> getErrorPages()
           
 List<FilterMappingMetaData> getFilterMappings()
           
 FiltersMetaData getFilters()
           
 String getJaccContextID()
           
 Environment getJndiEnvironmentRefsGroup()
          Get the jndiEnvironmentRefsGroup.
 JspConfigMetaData getJspConfig()
           
 List<ListenerMetaData> getListeners()
           
 LocaleEncodingsMetaData getLocalEncodings()
           
 LoginConfigMetaData getLoginConfig()
           
 Integer getMaxActiveSessions()
           
 MessageDestinationMetaData getMessageDestination(String name)
           
 MessageDestinationReferenceMetaData getMessageDestinationReferenceByName(String name)
           
 MessageDestinationReferencesMetaData getMessageDestinationReferences()
           
 MessageDestinationsMetaData getMessageDestinations()
           
 List<MimeMappingMetaData> getMimeMappings()
           
 PassivationConfig getPassivationConfig()
           
 PersistenceContextReferenceMetaData getPersistenceContextReferenceByName(String name)
           
 PersistenceContextReferencesMetaData getPersistenceContextRefs()
           
 PersistenceUnitReferenceMetaData getPersistenceUnitReferenceByName(String name)
           
 PersistenceUnitReferencesMetaData getPersistenceUnitRefs()
           
 LifecycleCallbacksMetaData getPostConstructs()
           
 LifecycleCallbacksMetaData getPreDestroys()
           
 Map<String,Set<String>> getPrincipalVersusRolesMap()
           
 String getPublicID()
           
 ReplicationConfig getReplicationConfig()
           
 ResourceEnvironmentReferenceMetaData getResourceEnvironmentReferenceByName(String name)
           
 ResourceEnvironmentReferencesMetaData getResourceEnvironmentReferences()
           
 ResourceReferenceMetaData getResourceReferenceByName(String name)
           
 ResourceReferencesMetaData getResourceReferences()
           
 Map<String,RunAsIdentityMetaData> getRunAsIdentity()
           
 RunAsIdentityMetaData getRunAsIdentity(String servletName)
          Access the RunAsIdentity associated with the given servlet
 List<SecurityConstraintMetaData> getSecurityContraints()
           
 String getSecurityDomain()
           
 Set<String> getSecurityRoleNames()
          Get the security-role names from the web.xml descriptor
 SecurityRoleRefsMetaData getSecurityRoleRefs(String servletName)
          Get the servlet/security-role-refs
 SecurityRolesMetaData getSecurityRoles()
           
 ServiceReferenceMetaData getServiceReferenceByName(String name)
           
 ServiceReferencesMetaData getServiceReferences()
           
 JBossServletMetaData getServletByName(String name)
           
 List<ServletMappingMetaData> getServletMappings()
           
 JBossServletsMetaData getServlets()
           
 String getServletVersion()
           
 SessionConfigMetaData getSessionConfig()
           
 int getSessionCookies()
           
 String getVersion()
           
 List<String> getVirtualHosts()
           
 WebserviceDescriptionsMetaData getWebserviceDescriptions()
           
 WelcomeFileListMetaData getWelcomeFileList()
           
 boolean is23()
          Is this a servlet 2.3 version application
 boolean is24()
           
 boolean is25()
           
 boolean isFlushOnSessionInvalidation()
           
 boolean isJaccAllStoreRole()
           
 boolean isMetadataComplete()
           
 boolean isUseSessionCookies()
           
 void merge(JBossWebMetaData override, WebMetaData original)
           
 void merge(JBossWebMetaData override, WebMetaData original, String overrideFile, String overridenFile, boolean mustOverride)
           
 void mergeSecurityRoles(SecurityRolesMetaData roles)
           
 void setAlternativeDD(String alternativeDD)
           
 void setArbitraryMetadata(HashMap arbitraryMetadata)
           
 void setClassLoading(ClassLoadingMetaData classLoading)
           
 void setContextLoader(ClassLoader cxtLoader)
           
 void setContextParams(List<ParamValueMetaData> params)
           
 void setContextRoot(String contextRoot)
           
 void setDepends(List<String> depends)
           
 void setDistributable(EmptyMetaData distributable)
           
 void setDTD(String root, String publicId, String systemId)
          Callback for the DTD information
 void setENCLoader(ClassLoader encLoader)
           
 void setEnvironmentRefsGroup(JBossEnvironmentRefsGroupMetaData env)
           
 void setErrorPages(List<ErrorPageMetaData> errorPages)
           
 void setFilterMappings(List<FilterMappingMetaData> filterMappings)
           
 void setFilters(FiltersMetaData filters)
           
 void setFlushOnSessionInvalidation(boolean flushOnSessionInvalidation)
           
 void setJaccAllStoreRole(boolean isJaccAllStoreRole)
           
 void setJaccContextID(String jaccContextID)
           
 void setJndiEnvironmentRefsGroup(Environment env)
          Set the jndiEnvironmentRefsGroup.
 void setJspConfig(JspConfigMetaData jspConfig)
           
 void setListeners(List<ListenerMetaData> listeners)
           
 void setLocalEncodings(LocaleEncodingsMetaData localEncodings)
           
 void setLoginConfig(LoginConfigMetaData loginConfig)
           
 void setMaxActiveSessions(Integer maxActiveSessions)
           
 void setMessageDestinations(MessageDestinationsMetaData messageDestinations)
           
 void setMetadataComplete(boolean metadataComplete)
           
 void setMimeMappings(List<MimeMappingMetaData> mimeMappings)
           
 void setPassivationConfig(PassivationConfig passivationConfig)
           
 void setReplicationConfig(ReplicationConfig replicationConfig)
           
 void setRunAsIdentity(Map<String,RunAsIdentityMetaData> runAsIdentity)
          The jboss-web.xml servlet/run-as
 void setSecurityContraints(List<SecurityConstraintMetaData> securityContraints)
           
 void setSecurityDomain(String securityDomain)
           
 void setSecurityRoles(SecurityRolesMetaData securityRoles)
           
 void setServletMappings(List<ServletMappingMetaData> servletMappings)
           
 void setServlets(JBossServletsMetaData servlets)
           
 void setServletVersion(String servletVersion)
           
 void setSessionConfig(SessionConfigMetaData sessionConfig)
           
 void setSessionCookies(int sessionCookies)
           
 void setUseSessionCookies(boolean useSessionCookies)
           
 void setVersion(String version)
           
 void setVirtualHosts(List<String> virtualHosts)
           
 void setWebserviceDescriptions(WebserviceDescriptionsMetaData webserviceDescriptions)
           
 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
 

Field Detail

SESSION_COOKIES_DEFAULT

public static final int SESSION_COOKIES_DEFAULT
See Also:
Constant Field Values

SESSION_COOKIES_ENABLED

public static final int SESSION_COOKIES_ENABLED
See Also:
Constant Field Values

SESSION_COOKIES_DISABLED

public static final int SESSION_COOKIES_DISABLED
See Also:
Constant Field Values
Constructor Detail

JBossWebMetaData

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

getServletVersion

public String getServletVersion()

setServletVersion

public void setServletVersion(String servletVersion)

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

isMetadataComplete

public boolean isMetadataComplete()

setMetadataComplete

public void setMetadataComplete(boolean metadataComplete)

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)

getServletByName

public JBossServletMetaData getServletByName(String name)

getServlets

public JBossServletsMetaData getServlets()

setServlets

public void setServlets(JBossServletsMetaData 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)

getEjbLocalReferenceByName

public EJBLocalReferenceMetaData getEjbLocalReferenceByName(String name)

getEjbLocalReferences

public EJBLocalReferencesMetaData getEjbLocalReferences()

getEjbReferenceByName

public EJBReferenceMetaData getEjbReferenceByName(String name)

getEjbReferences

public EJBReferencesMetaData getEjbReferences()

getEnvironmentEntries

public EnvironmentEntriesMetaData getEnvironmentEntries()

getEnvironmentEntryByName

public EnvironmentEntryMetaData getEnvironmentEntryByName(String name)

getMessageDestinationReferenceByName

public MessageDestinationReferenceMetaData getMessageDestinationReferenceByName(String name)

getMessageDestinationReferences

public MessageDestinationReferencesMetaData getMessageDestinationReferences()

getPersistenceContextReferenceByName

public PersistenceContextReferenceMetaData getPersistenceContextReferenceByName(String name)

getPersistenceContextRefs

public PersistenceContextReferencesMetaData getPersistenceContextRefs()

getPersistenceUnitReferenceByName

public PersistenceUnitReferenceMetaData getPersistenceUnitReferenceByName(String name)

getPersistenceUnitRefs

public PersistenceUnitReferencesMetaData getPersistenceUnitRefs()

getPostConstructs

public LifecycleCallbacksMetaData getPostConstructs()

getPreDestroys

public LifecycleCallbacksMetaData getPreDestroys()

getResourceEnvironmentReferenceByName

public ResourceEnvironmentReferenceMetaData getResourceEnvironmentReferenceByName(String name)

getResourceEnvironmentReferences

public ResourceEnvironmentReferencesMetaData getResourceEnvironmentReferences()

getResourceReferenceByName

public ResourceReferenceMetaData getResourceReferenceByName(String name)

getResourceReferences

public ResourceReferencesMetaData getResourceReferences()

getServiceReferenceByName

public ServiceReferenceMetaData getServiceReferenceByName(String name)

getServiceReferences

public ServiceReferencesMetaData getServiceReferences()

getMessageDestinations

public MessageDestinationsMetaData getMessageDestinations()

setMessageDestinations

public void setMessageDestinations(MessageDestinationsMetaData messageDestinations)

getAlternativeDD

public String getAlternativeDD()

setAlternativeDD

public void setAlternativeDD(String alternativeDD)

getContextRoot

public String getContextRoot()

setContextRoot

public void setContextRoot(String contextRoot)

getDepends

public List<String> getDepends()

getENCLoader

public ClassLoader getENCLoader()

setENCLoader

public void setENCLoader(ClassLoader encLoader)

getContextLoader

public ClassLoader getContextLoader()

setContextLoader

public void setContextLoader(ClassLoader cxtLoader)

setDepends

public void setDepends(List<String> depends)

getClassLoading

public ClassLoadingMetaData getClassLoading()

setClassLoading

public void setClassLoading(ClassLoadingMetaData classLoading)

getJaccContextID

public String getJaccContextID()

setJaccContextID

public void setJaccContextID(String jaccContextID)

getPublicID

public String getPublicID()

getSecurityDomain

public String getSecurityDomain()

setSecurityDomain

public void setSecurityDomain(String securityDomain)

getArbitraryMetadata

public HashMap getArbitraryMetadata()

setArbitraryMetadata

public void setArbitraryMetadata(HashMap arbitraryMetadata)

isFlushOnSessionInvalidation

public boolean isFlushOnSessionInvalidation()

setFlushOnSessionInvalidation

public void setFlushOnSessionInvalidation(boolean flushOnSessionInvalidation)

getMaxActiveSessions

public Integer getMaxActiveSessions()

setMaxActiveSessions

public void setMaxActiveSessions(Integer maxActiveSessions)

getPassivationConfig

public PassivationConfig getPassivationConfig()

setPassivationConfig

public void setPassivationConfig(PassivationConfig passivationConfig)

getReplicationConfig

public ReplicationConfig getReplicationConfig()

setReplicationConfig

public void setReplicationConfig(ReplicationConfig replicationConfig)

isUseSessionCookies

public boolean isUseSessionCookies()

setUseSessionCookies

public void setUseSessionCookies(boolean useSessionCookies)

getSessionCookies

public int getSessionCookies()

setSessionCookies

public void setSessionCookies(int sessionCookies)

getVirtualHosts

public List<String> getVirtualHosts()

setVirtualHosts

public void setVirtualHosts(List<String> virtualHosts)

getWebserviceDescriptions

public WebserviceDescriptionsMetaData getWebserviceDescriptions()

setWebserviceDescriptions

public void setWebserviceDescriptions(WebserviceDescriptionsMetaData webserviceDescriptions)

getSecurityRoleNames

public Set<String> getSecurityRoleNames()
Get the security-role names from the web.xml descriptor

Returns:
Set of the security-role names from the web.xml

getSecurityRoleRefs

public SecurityRoleRefsMetaData getSecurityRoleRefs(String servletName)
Get the servlet/security-role-refs

Parameters:
servletName -
Returns:

getPrincipalVersusRolesMap

public Map<String,Set<String>> getPrincipalVersusRolesMap()

getJndiEnvironmentRefsGroup

public Environment getJndiEnvironmentRefsGroup()
Get the jndiEnvironmentRefsGroup.

Returns:
the jndiEnvironmentRefsGroup.

setJndiEnvironmentRefsGroup

public void setJndiEnvironmentRefsGroup(Environment env)
Set the jndiEnvironmentRefsGroup.

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

setEnvironmentRefsGroup

public void setEnvironmentRefsGroup(JBossEnvironmentRefsGroupMetaData env)

isJaccAllStoreRole

public boolean isJaccAllStoreRole()

setJaccAllStoreRole

public void setJaccAllStoreRole(boolean isJaccAllStoreRole)

getMessageDestination

public MessageDestinationMetaData getMessageDestination(String name)

getRunAsIdentity

public RunAsIdentityMetaData getRunAsIdentity(String servletName)
Access the RunAsIdentity associated with the given servlet

Parameters:
servletName - - the servlet-name from the web.xml
Returns:
RunAsIdentity for the servet if one exists, null otherwise

getRunAsIdentity

public Map<String,RunAsIdentityMetaData> getRunAsIdentity()
Returns:
servlet/run-as

setRunAsIdentity

public void setRunAsIdentity(Map<String,RunAsIdentityMetaData> runAsIdentity)
The jboss-web.xml servlet/run-as


mergeSecurityRoles

public void mergeSecurityRoles(SecurityRolesMetaData roles)

merge

public void merge(JBossWebMetaData override,
                  WebMetaData original)

merge

public void merge(JBossWebMetaData override,
                  WebMetaData original,
                  String overrideFile,
                  String overridenFile,
                  boolean mustOverride)


Copyright © 2011 JBoss, a division of Red Hat, Inc.. All Rights Reserved.