WebMetaData (JBoss Server API) - JBoss 3.2.7 server API Documentation 英文版文档

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.metadata
Class WebMetaData

java.lang.Object
  org.jboss.metadata.WebMetaData

All Implemented Interfaces:: XmlLoadable

public class WebMetaData
extends Object
implements XmlLoadable

A representation of the web.xml and jboss-web.xml deployment descriptors as used by the AbstractWebContainer web container integration support class.

Version:: $Revision: 1.9.2.14 $
Author:: Scott.Stark@jboss.org
See Also:: XmlLoadable, AbstractWebContainer

Field Summary

static int REPLICATION_GRANULARITY_ATTRIBUTE


static int REPLICATION_GRANULARITY_FIELD


static int REPLICATION_GRANULARITY_SESSION
          Specify the session replication granularity level: session --- whole session level, attribute --- per attribute change, field --- fine grained user object level.

static int REPLICATION_TYPE_ASYNC


static int REPLICATION_TYPE_SYNC


static int SESSION_COOKIES_DEFAULT


static int SESSION_COOKIES_DISABLED


static int SESSION_COOKIES_ENABLED


static int SESSION_INVALIDATE_ACCESS


static int SESSION_INVALIDATE_SET


static int SESSION_INVALIDATE_SET_AND_GET


static int SESSION_INVALIDATE_SET_AND_NON_PRIMITIVE_GET


Constructor Summary

WebMetaData()


Method Summary

String getContextRoot()
          This the the jboss-web.xml descriptor context-root and it is only meaningful if a war is deployed outside of an ear.

Collection getDepends()
          Access the web application depends

boolean getDistributable()
          The distributable flag.

Iterator getEjbLocalReferences()
          Return an iterator of the ejb-local-ref mappings.

Iterator getEjbReferences()
          Return an iterator of the ejb-ref mappings.

ClassLoader getENCLoader()


Iterator getEnvironmentEntries()
          Return an iterator of the env-entry mappings.

int getInvalidateSessionPolicy()


boolean getJava2ClassLoadingCompliance()
          A flag indicating if the normal Java2 parent first class loading model should be used over the servlet 2.3 web container first model.

org.jboss.mx.loading.LoaderRepositoryFactory.LoaderRepositoryConfig getLoaderConfig()


int getReplicationGranularity()


int getReplicationType()


Iterator getResourceEnvReferences()
          Return an iterator of the resource-ref mappings.

Iterator getResourceReferences()
          Return an iterator of the resource-ref mappings.

String getSecurityDomain()
          Return the optional security-domain jboss-web.xml element.

int getSessionCookies()


Iterator getVirtualHosts()
          The servlet container virtual hosts the war should be deployed into.

protected void importJBossWebXml(Element jbossWeb)
          Parse the elements of the jboss-web element used by the integration layer.

protected void importWebXml(Element webApp)
          Parse the elements of the web-app element used by the integration layer.

void importXml(Element element)


boolean isFlushOnSessionInvalidation()
          The flag indicating whether the associated security domain cache should be flushed when the session is invalidated.

void parseMetaData(String ctxPath, URL warURL)
          This method creates a context-root string from either the WEB-INF/jboss-web.xml context-root element is one exists, or the filename portion of the warURL.

void setContextRoot(String contextRoot)


void setENCLoader(ClassLoader encLoader)


void setFlushOnSessionInvalidation(boolean flag)
          The flag indicating whether the associated security domain cache should be flushed when the session is invalidated.

void setJava2ClassLoadingCompliance(boolean flag)


void setLoaderConfig(org.jboss.mx.loading.LoaderRepositoryFactory.LoaderRepositoryConfig loaderConfig)


Methods inherited from class java.lang.Object

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

Field Detail

SESSION_INVALIDATE_ACCESS

public static final int SESSION_INVALIDATE_ACCESS

See Also:: Constant Field Values

SESSION_INVALIDATE_SET_AND_GET

public static final int SESSION_INVALIDATE_SET_AND_GET

See Also:: Constant Field Values

SESSION_INVALIDATE_SET_AND_NON_PRIMITIVE_GET

public static final int SESSION_INVALIDATE_SET_AND_NON_PRIMITIVE_GET

See Also:: Constant Field Values

SESSION_INVALIDATE_SET

public static final int SESSION_INVALIDATE_SET

See Also:: Constant Field Values

REPLICATION_TYPE_SYNC

public static final int REPLICATION_TYPE_SYNC

See Also:: Constant Field Values

REPLICATION_TYPE_ASYNC

public static final int REPLICATION_TYPE_ASYNC

See Also:: Constant Field Values

REPLICATION_GRANULARITY_SESSION

public static final int REPLICATION_GRANULARITY_SESSION

Specify the session replication granularity level: session --- whole session level, attribute --- per attribute change, field --- fine grained user object level.

See Also:: Constant Field Values

REPLICATION_GRANULARITY_ATTRIBUTE

public static final int REPLICATION_GRANULARITY_ATTRIBUTE

See Also:: Constant Field Values

REPLICATION_GRANULARITY_FIELD

public static final int REPLICATION_GRANULARITY_FIELD

See Also:: Constant Field Values

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

WebMetaData

public WebMetaData()

Method Detail

getEnvironmentEntries

public Iterator getEnvironmentEntries()

Return an iterator of the env-entry mappings.

Returns:: Iterator of EnvEntryMetaData objects.

getEjbReferences

public Iterator getEjbReferences()

Return an iterator of the ejb-ref mappings.

Returns:: Iterator of EjbRefMetaData objects.

getEjbLocalReferences

public Iterator getEjbLocalReferences()

Return an iterator of the ejb-local-ref mappings.

Returns:: Iterator of EjbLocalRefMetaData objects.

getResourceReferences

public Iterator getResourceReferences()

Return an iterator of the resource-ref mappings.

Returns:: Iterator of ResourceRefMetaData objects.

getResourceEnvReferences

public Iterator getResourceEnvReferences()

Return an iterator of the resource-ref mappings.

Returns:: Iterator of ResourceEnvRefMetaData objects.

getContextRoot

public String getContextRoot()

This the the jboss-web.xml descriptor context-root and it is only meaningful if a war is deployed outside of an ear.

setContextRoot

public void setContextRoot(String contextRoot)

getSecurityDomain

public String getSecurityDomain()

Return the optional security-domain jboss-web.xml element.

Returns:: The jndiName of the security manager implementation that is responsible for security of the web application. May be null if there was no security-domain specified in the jboss-web.xml descriptor.

isFlushOnSessionInvalidation

public boolean isFlushOnSessionInvalidation()

The flag indicating whether the associated security domain cache should be flushed when the session is invalidated.

Returns:: true if the flush should occur, false otherwise.

setFlushOnSessionInvalidation

public void setFlushOnSessionInvalidation(boolean flag)

The flag indicating whether the associated security domain cache should be flushed when the session is invalidated.

Parameters:: flag - - true if the flush should occur, false otherwise.

getVirtualHosts

public Iterator getVirtualHosts()

The servlet container virtual hosts the war should be deployed into. If empty then the servlet container default host should be used.

getDistributable

public boolean getDistributable()

The distributable flag.

Returns:: true if the web-app is marked distributable

getDepends

public Collection getDepends()

Access the web application depends

Returns:: Iterator of JMX ObjectNames the web app depends on.

getJava2ClassLoadingCompliance

public boolean getJava2ClassLoadingCompliance()

A flag indicating if the normal Java2 parent first class loading model should be used over the servlet 2.3 web container first model.

Returns:: true for parent first, false for the servlet 2.3 model

setJava2ClassLoadingCompliance

public void setJava2ClassLoadingCompliance(boolean flag)

getLoaderConfig

public org.jboss.mx.loading.LoaderRepositoryFactory.LoaderRepositoryConfig getLoaderConfig()

setLoaderConfig

public void setLoaderConfig(org.jboss.mx.loading.LoaderRepositoryFactory.LoaderRepositoryConfig loaderConfig)

getENCLoader

public ClassLoader getENCLoader()

setENCLoader

public void setENCLoader(ClassLoader encLoader)

getSessionCookies

public int getSessionCookies()

getInvalidateSessionPolicy

public int getInvalidateSessionPolicy()

getReplicationType

public int getReplicationType()

getReplicationGranularity

public int getReplicationGranularity()

importXml

public void importXml(Element element)
               throws Exception

Specified by:: importXml in interface XmlLoadable

Throws:: Exception

importWebXml

protected void importWebXml(Element webApp)
                     throws Exception

Parse the elements of the web-app element used by the integration layer.

Throws:: Exception

importJBossWebXml

protected void importJBossWebXml(Element jbossWeb)
                          throws Exception

Parse the elements of the jboss-web element used by the integration layer.

Throws:: Exception

parseMetaData

public void parseMetaData(String ctxPath,
                          URL warURL)
                   throws org.jboss.deployment.DeploymentException

This method creates a context-root string from either the WEB-INF/jboss-web.xml context-root element is one exists, or the filename portion of the warURL. It is called if the DeploymentInfo webContext value is null which indicates a standalone war deployment. A war name of ROOT.war is handled as a special case of a war that should be installed as the default web context.

Throws:: org.jboss.deployment.DeploymentException