org.jboss.web.tomcat.tc5
Interface Tomcat5MBean

All Known Implementing Classes:

Tomcat5 (src)

public interface Tomcat5MBean

An implementation of the AbstractWebContainer for the Jakarta Tomcat5 servlet container. It has no code dependency on tomcat - only the new JMX model is used.

Tomcat5 is organized as a set of mbeans - just like jboss.

See Also:

AbstractWebContainerMBean

TOMCAT_CONNECTORS_STARTED

public static final java.lang.String TOMCAT_CONNECTORS_STARTED

JMX notification type to signal after-start connector event

See Also:

Constant Field Values (src)

getDomain

public java.lang.String getDomain()

Returns:

the jmx domain for the tomcat management mbeans

setDomain

public void setDomain(java.lang.String domainName)

The most important attribute - defines the managed domain. A catalina instance (engine) corresponds to a JMX domain, that's how we know where to deploy webapps.

Parameters:

domainName - the jmx domain under which tc registers

setSnapshotMode

public void setSnapshotMode(java.lang.String mode)

Set the snapshot mode in a clustered environment

getSnapshotMode

public java.lang.String getSnapshotMode()

Get the snapshot mode in a clustered environment

setSnapshotInterval

public void setSnapshotInterval(int interval)

Set the snapshot interval in ms for the interval snapshot mode

getSnapshotInterval

public int getSnapshotInterval()

Get the snapshot interval

isUseLocalCache

public boolean isUseLocalCache()

Get the clustering code cache behaviour

setUseLocalCache

public void setUseLocalCache(boolean useLocalCache)

Set the clustering code cache behaviour

isUseJK

public boolean isUseJK()

Get the clustering code failover behaviour whether MOD_JK(2) is used or not.

setUseJK

public void setUseJK(boolean useJK)

Set the clustering code failover behaviour whether MOD_JK(2) is used or not.

setSessionIdAlphabet

public void setSessionIdAlphabet(java.lang.String sessionIdAlphabet)

The SessionIdAlphabet is the set of characters used to create a session Id

getSessionIdAlphabet

public java.lang.String getSessionIdAlphabet()

The SessionIdAlphabet is the set of characters used to create a session Id

getCacheName

public java.lang.String getCacheName()

Gets the JMX object name of a shared TreeCache to be used for clustered single-sign-on.

See Also:

TreeCacheSSOClusterManager (src)

setCacheName

public void setCacheName(java.lang.String cacheName)

Gets the JMX object name of a shared TreeCache to be used for clustered single-sign-on.

NOTE: TreeCache must be deployed before this service.

See Also:

TreeCacheSSOClusterManager (src)

getUseJBossWebLoader

public boolean getUseJBossWebLoader()

Get the JBoss UCL use flag

setUseJBossWebLoader

public void setUseJBossWebLoader(boolean flag)

Set the JBoss UCL use flag

getManagerClass

public java.lang.String getManagerClass()

setManagerClass

public void setManagerClass(java.lang.String managerClass)

getContextMBeanCode

public java.lang.String getContextMBeanCode()

setContextMBeanCode

public void setContextMBeanCode(java.lang.String className)

getConfigFile

public java.lang.String getConfigFile()

Get the name of the external tomcat server configuration file.

Returns:

the config file name, server.xml for example

setConfigFile

public void setConfigFile(java.lang.String configFile)

Set the name of the external tomcat server configuration file.

Parameters:

configFile - - the config file name, server.xml for example

getSubjectAttributeName

public java.lang.String getSubjectAttributeName()

Get the request attribute name under which the JAAS Subject is store

setSubjectAttributeName

public void setSubjectAttributeName(java.lang.String name)

Set the request attribute name under which the JAAS Subject will be stored when running with a security mgr that supports JAAS. If this is empty then the Subject will not be store in the request.

Parameters:

name - the HttpServletRequest attribute name to store the Subject

startConnectors

public void startConnectors()
                     throws java.lang.Exception

Start all connectors of the Domain + ":type=Service,serviceName=jboss.web" service.

Throws:

java.lang.Exception

stopConnectors

public void stopConnectors()
                    throws java.lang.Exception

Stop all connectors of the Domain + ":type=Service,serviceName=jboss.web" service.

Throws:

java.lang.Exception

isAllowSelfPrivilegedWebApps

public boolean isAllowSelfPrivilegedWebApps()

Get whether web-apps are able to control the privileged flag

setAllowSelfPrivilegedWebApps

public void setAllowSelfPrivilegedWebApps(boolean flag)

Set whether web-apps are able to control the privileged flag

setSecurityManagerService

public void setSecurityManagerService(JaasSecurityManagerServiceMBean (src)  mgr)

Set the SecurityManagerService binding. This is used to flush any associated authentication cache on session invalidation.

Parameters:

mgr - the JaasSecurityManagerServiceMBean

getFilteredPackages

public java.lang.String[] getFilteredPackages()

Returns:

setFilteredPackages

public void setFilteredPackages(java.lang.String[] pkgs)

Parameters:

pkgs -