com.sun.appserv.management.j2ee
Interface WebModule

All Superinterfaces:
AMX, AMXMBeanLogging, ConfigProvider, Container, J2EEDeployedObject, J2EEManagedObject, J2EEModule, NotificationBroadcaster, NotificationEmitter, StateManageable

public interface WebModule
extends J2EEModule, Container

A J2EE WebModule. Extends the J2EE management model with additional product-specific Attributes and operations.
The monitoring peer as returned from getMonitoringPeer() is WebModuleVirtualServerMonitor


Field Summary
static String J2EE_TYPE
           
 
Fields inherited from interface com.sun.appserv.management.base.AMX
FULL_TYPE_DELIM, GROUP_CONFIGURATION, GROUP_JSR77, GROUP_MONITORING, GROUP_OTHER, GROUP_UTILITY, J2EE_TYPE_KEY, JMX_DOMAIN, NAME_KEY, NO_NAME, NOTIFICATION_PREFIX, NULL_NAME
 
Fields inherited from interface com.sun.appserv.management.j2ee.StateManageable
STATE_FAILED, STATE_RUNNING, STATE_STARTING, STATE_STOPPED, STATE_STOPPING
 
Fields inherited from interface com.sun.appserv.management.base.Container
ATTR_CONTAINEE_J2EE_TYPES
 
Method Summary
 boolean getAllowLinking()
          Allow symlinking to outside the webapp root directory, if the webapp is an exploded directory
 int getCacheMaxSize()
          Maximum cache size in KB
 boolean getCachingAllowed()
          Should we cache static resources for this webapp
 boolean getCaseSensitive()
          Should case sensitivity checks be performed
 String getCompilerClasspath()
          The compiler classpath to use
 boolean getCookies()
          Should we attempt to use cookies for session id communication?
 boolean getCrossContext()
          Should we allow the ServletContext.getContext() method to access the context of other web applications in this server?
 int getDebug()
          The debugging detail level for this component
 String getDefaultWebXML()
          Location of the default web.xml resource or file
 String getDocBase()
          The document root for this web application
 String[] getEndpointAddresses()
          An array of URL addresses defined in this Web Module to invoke web services endpoints implementations
 String getEngineName()
          Name of the engine domain, if different from the context domain
 boolean getHasWebServices()
          True if the web module implements web services endpoints
 int getManagerChecksFrequency()
          The frequency of the manager checks (expiration and passivation)
 boolean getOverride()
          The DefaultContext override flag for this web application
 String getPath()
          The context path for this Context
 boolean getReloadable()
          The reloadable flag for this web application
 String[] getResourceNames()
          Names of all the defined resource references for this application.
 Map<String,Servlet> getServletMap()
           
 String[] getservlets()
          Note that the Attribute name is case-sensitive "servlets" as defined by JSR 77.
 long getStartupTime()
          Startup time for this context (elapsed milliseconds).
 boolean getSwallowOutput()
          Flag to set to cause the system.out and system.err to be redirected to the logger when executing a servlet
 long getTLDScanTime()
          Time spend scanning jars for TLDs for this context
 boolean getUseNaming()
          Create a JNDI naming context for this application?
 String[] getWelcomeFiles()
          The welcome files for this context
 String getWorkDir()
          The pathname to the work directory for this context
 void reload()
           
 void setAllowLinking(boolean value)
          Allow symlinking to outside the webapp root directory, if the webapp is an exploded directory
 void setCacheMaxSize(int value)
          Maximum cache size in KB
 void setCachingAllowed(boolean value)
          Should we cache static resources for this webapp
 void setCaseSensitive(boolean value)
          Should case sensitivity checks be performed
 void setCompilerClasspath(String value)
          The compiler classpath to use
 void setCookies(boolean value)
          Should we attempt to use cookies for session id communication?
 void setCrossContext(boolean value)
          Should we allow the ServletContext.getContext() method to access the context of other web applications in this server?
 void setDebug(int value)
          The debugging detail level for this component
 void setEngineName(String value)
          Name of the engine domain, if different from the context domain
 void setManagerChecksFrequency(int value)
          The frequency of the manager checks (expiration and passivation)
 void setOverride(boolean value)
          The DefaultContext override flag for this web application
 void setPath(String value)
          The context path for this Context
 void setReloadable(boolean value)
          The reloadable flag for this web application
 void setSwallowOutput(boolean value)
          Flag to set to cause the system.out and system.err to be redirected to the logger when executing a servlet
 void setTLDScanTime(long value)
          Time spend scanning jars for TLDs for this context
 void setUseNaming(boolean value)
          Create a JNDI naming context for this application?
 
Methods inherited from interface com.sun.appserv.management.j2ee.J2EEModule
getjavaVMs, getJVM
 
Methods inherited from interface com.sun.appserv.management.j2ee.J2EEDeployedObject
getdeploymentDescriptor, getserver, getServer
 
Methods inherited from interface com.sun.appserv.management.j2ee.J2EEManagedObject
getConfigPeer, getMonitoringPeer, getobjectName, iseventProvider, isstateManageable, isstatisticProvider, isstatisticsProvider
 
Methods inherited from interface com.sun.appserv.management.base.AMX
getContainer, getDomainRoot, getFullType, getGroup, getJ2EEType, getName, isDAS
 
Methods inherited from interface javax.management.NotificationEmitter
removeNotificationListener
 
Methods inherited from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener
 
Methods inherited from interface com.sun.appserv.management.base.AMXMBeanLogging
getMBeanLoggerName, getMBeanLogLevel, setMBeanLogLevel
 
Methods inherited from interface com.sun.appserv.management.j2ee.ConfigProvider
isConfigProvider
 
Methods inherited from interface com.sun.appserv.management.j2ee.StateManageable
getstartTime, getstate, start, startRecursive, stop
 
Methods inherited from interface com.sun.appserv.management.base.Container
getByNameContaineeSet, getContainee, getContainee, getContaineeJ2EETypes, getContaineeMap, getContaineeSet, getContaineeSet, getContaineeSet, getMultiContaineeMap
 

Field Detail

J2EE_TYPE

static final String J2EE_TYPE
See Also:
Constant Field Values
Method Detail

getservlets

String[] getservlets()
Note that the Attribute name is case-sensitive "servlets" as defined by JSR 77.


getServletMap

Map<String,Servlet> getServletMap()

getAllowLinking

boolean getAllowLinking()
Allow symlinking to outside the webapp root directory, if the webapp is an exploded directory


setAllowLinking

void setAllowLinking(boolean value)
Allow symlinking to outside the webapp root directory, if the webapp is an exploded directory


getCacheMaxSize

int getCacheMaxSize()
Maximum cache size in KB


setCacheMaxSize

void setCacheMaxSize(int value)
Maximum cache size in KB


getCachingAllowed

boolean getCachingAllowed()
Should we cache static resources for this webapp


setCachingAllowed

void setCachingAllowed(boolean value)
Should we cache static resources for this webapp


getCaseSensitive

boolean getCaseSensitive()
Should case sensitivity checks be performed


setCaseSensitive

void setCaseSensitive(boolean value)
Should case sensitivity checks be performed


getCompilerClasspath

String getCompilerClasspath()
The compiler classpath to use


setCompilerClasspath

void setCompilerClasspath(String value)
The compiler classpath to use


getCookies

boolean getCookies()
Should we attempt to use cookies for session id communication?


setCookies

void setCookies(boolean value)
Should we attempt to use cookies for session id communication?


getCrossContext

boolean getCrossContext()
Should we allow the ServletContext.getContext() method to access the context of other web applications in this server?


setCrossContext

void setCrossContext(boolean value)
Should we allow the ServletContext.getContext() method to access the context of other web applications in this server?


getDebug

int getDebug()
The debugging detail level for this component


setDebug

void setDebug(int value)
The debugging detail level for this component


getDefaultWebXML

String getDefaultWebXML()
Location of the default web.xml resource or file


getDocBase

String getDocBase()
The document root for this web application


getEndpointAddresses

String[] getEndpointAddresses()
An array of URL addresses defined in this Web Module to invoke web services endpoints implementations


getEngineName

String getEngineName()
Name of the engine domain, if different from the context domain


setEngineName

void setEngineName(String value)
Name of the engine domain, if different from the context domain


getHasWebServices

boolean getHasWebServices()
True if the web module implements web services endpoints


getManagerChecksFrequency

int getManagerChecksFrequency()
The frequency of the manager checks (expiration and passivation)


setManagerChecksFrequency

void setManagerChecksFrequency(int value)
The frequency of the manager checks (expiration and passivation)


getOverride

boolean getOverride()
The DefaultContext override flag for this web application


setOverride

void setOverride(boolean value)
The DefaultContext override flag for this web application


getPath

String getPath()
The context path for this Context


setPath

void setPath(String value)
The context path for this Context


getReloadable

boolean getReloadable()
The reloadable flag for this web application


setReloadable

void setReloadable(boolean value)
The reloadable flag for this web application


getResourceNames

String[] getResourceNames()
Names of all the defined resource references for this application.


getStartupTime

long getStartupTime()
Startup time for this context (elapsed milliseconds).


getSwallowOutput

boolean getSwallowOutput()
Flag to set to cause the system.out and system.err to be redirected to the logger when executing a servlet


setSwallowOutput

void setSwallowOutput(boolean value)
Flag to set to cause the system.out and system.err to be redirected to the logger when executing a servlet


getTLDScanTime

long getTLDScanTime()
Time spend scanning jars for TLDs for this context


setTLDScanTime

void setTLDScanTime(long value)
Time spend scanning jars for TLDs for this context


getUseNaming

boolean getUseNaming()
Create a JNDI naming context for this application?


setUseNaming

void setUseNaming(boolean value)
Create a JNDI naming context for this application?


getWelcomeFiles

String[] getWelcomeFiles()
The welcome files for this context


getWorkDir

String getWorkDir()
The pathname to the work directory for this context


reload

void reload()