org.mobicents.servlet.sip.startup.jboss
Interface JBossSipMBean

All Superinterfaces:

org.jboss.web.AbstractWebContainerMBean, org.jboss.system.Service, org.jboss.system.ServiceMBean, org.jboss.deployment.SubDeployerExtMBean, org.jboss.deployment.SubDeployerMBean

public interface JBossSipMBean
extends org.jboss.web.AbstractWebContainerMBean

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.

Version:

$Revision: 57206 $

Author:

Scott.Stark@jboss.org, Costin Manolache

See Also:

AbstractWebContainerMBean

Field Summary

static java.lang.String

TOMCAT_CONNECTORS_STARTED JMX notification type to signal after-start connector event

Fields inherited from interface org.jboss.system.ServiceMBean

CREATE_EVENT, CREATED, DESTROY_EVENT, DESTROYED, FAILED, REGISTERED, START_EVENT, STARTED, STARTING, states, STOP_EVENT, STOPPED, STOPPING, UNREGISTERED

Method Summary

java.lang.String	getCacheName() Gets the JMX object name of a shared TreeCache to be used for clustered single-sign-on.
java.lang.String	getConfigFile() Get the name of the external tomcat server configuration file.
java.lang.String	getContextMBeanCode()
java.lang.String	getDomain()
java.lang.String[]	getFilteredPackages()
java.lang.String	getManagerClass()
int	getMaxUnreplicatedInterval() Get the maximum interval between requests, in seconds, after which a request will trigger replication of the session's metadata regardless of whether the request has otherwise made the session dirty.
java.lang.String	getSessionIdAlphabet() The SessionIdAlphabet is the set of characters used to create a session Id
int	getSnapshotInterval() Get the snapshot interval
java.lang.String	getSnapshotMode() Get the snapshot mode in a clustered environment
java.lang.String	getSubjectAttributeName() Get the request attribute name under which the JAAS Subject is store
boolean	getUseJBossWebLoader() Get the JBoss UCL use flag
boolean	isAllowSelfPrivilegedWebApps() Get whether web-apps are able to control the privileged flag
boolean	isUseJK() Get the clustering code failover behaviour whether MOD_JK(2) is used or not.
boolean	isUseLocalCache() Get the clustering code cache behaviour
void	setAllowSelfPrivilegedWebApps(boolean flag) Set whether web-apps are able to control the privileged flag
void	setCacheName(java.lang.String cacheName) Gets the JMX object name of a shared TreeCache to be used for clustered single-sign-on.
void	setConfigFile(java.lang.String configFile) Set the name of the external tomcat server configuration file.
void	setContextMBeanCode(java.lang.String className)
void	setDomain(java.lang.String domainName) The most important attribute - defines the managed domain.
void	setFilteredPackages(java.lang.String[] pkgs)
void	setManagerClass(java.lang.String managerClass)
void	setMaxUnreplicatedInterval(int maxUnreplicatedInterval) Sets the maximum interval between requests, in seconds, after which a request will trigger replication of the session's metadata regardless of whether the request has otherwise made the session dirty.
void	setSecurityManagerService(org.jboss.security.plugins.JaasSecurityManagerServiceMBean mgr) Set the SecurityManagerService binding.
void	setSessionIdAlphabet(java.lang.String sessionIdAlphabet) The SessionIdAlphabet is the set of characters used to create a session Id
void	setSnapshotInterval(int interval) Set the snapshot interval in ms for the interval snapshot mode
void	setSnapshotMode(java.lang.String mode) Set the snapshot mode in a clustered environment
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.
void	setUseJBossWebLoader(boolean flag) Set the JBoss UCL use flag
void	setUseJK(boolean useJK) Set the clustering code failover behaviour whether MOD_JK(2) is used or not.
void	setUseLocalCache(boolean useLocalCache) Set the clustering code cache behaviour
void	startConnectors() Start all connectors of the Domain + ":type=Service,serviceName=jboss.web" service.
void	stopConnectors() Stop all connectors of the Domain + ":type=Service,serviceName=jboss.web" service.

Methods inherited from interface org.jboss.web.AbstractWebContainerMBean

getAcceptNonWarDirs, getConfig, getDefaultSecurityDomain, getDeployedApplications, getJava2ClassLoadingCompliance, getLenientEjbLink, getUnpackWars, isDeployed, setAcceptNonWarDirs, setConfig, setDefaultSecurityDomain, setJava2ClassLoadingCompliance, setLenientEjbLink, setUnpackWars

Methods inherited from interface org.jboss.deployment.SubDeployerExtMBean

getEnhancedSuffixes, setEnhancedSuffixes

Methods inherited from interface org.jboss.deployment.SubDeployerMBean

accepts, create, destroy, getRelativeOrder, getServiceName, getSuffixes, init, start, stop

Methods inherited from interface org.jboss.system.ServiceMBean

getName, getState, getStateString, jbossInternalLifecycle

Methods inherited from interface org.jboss.system.Service

create, destroy, start, stop

Field Detail

TOMCAT_CONNECTORS_STARTED

static final java.lang.String TOMCAT_CONNECTORS_STARTED

JMX notification type to signal after-start connector event

See Also:

Constant Field Values

Method Detail

getDomain

java.lang.String getDomain()

Returns:

the jmx domain for the tomcat management mbeans

setDomain

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

void setSnapshotMode(java.lang.String mode)

Set the snapshot mode in a clustered environment

getSnapshotMode

java.lang.String getSnapshotMode()

Get the snapshot mode in a clustered environment

setSnapshotInterval

void setSnapshotInterval(int interval)

Set the snapshot interval in ms for the interval snapshot mode

getSnapshotInterval

int getSnapshotInterval()

Get the snapshot interval

isUseLocalCache

boolean isUseLocalCache()

Get the clustering code cache behaviour

setUseLocalCache

void setUseLocalCache(boolean useLocalCache)

Set the clustering code cache behaviour

isUseJK

boolean isUseJK()

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

setUseJK

void setUseJK(boolean useJK)

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

setSessionIdAlphabet

void setSessionIdAlphabet(java.lang.String sessionIdAlphabet)

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

getSessionIdAlphabet

java.lang.String getSessionIdAlphabet()

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

getCacheName

java.lang.String getCacheName()

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

See Also:

org.jboss.web.tomcat.service.sso.TreeCacheSSOClusterManager

setCacheName

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:

org.jboss.web.tomcat.service.sso.TreeCacheSSOClusterManager

getMaxUnreplicatedInterval

int getMaxUnreplicatedInterval()

Get the maximum interval between requests, in seconds, after which a request will trigger replication of the session's metadata regardless of whether the request has otherwise made the session dirty. Such replication ensures that other nodes in the cluster are aware of a relatively recent value for the session's timestamp and won't incorrectly expire an unreplicated session upon failover.

Default value is #DEFAULT_MAX_UNREPLICATED_INTERVAL.

The cost of the metadata replication depends on the configured replication granularity. With SESSION, the sesssion's attribute map is replicated along with the metadata, so it can be fairly costly. With other granularities, the metadata object is replicated separately from the attributes and only contains a String, and a few longs, ints and booleans.

Returns:

the maximum interval since last replication after which a request will trigger session metadata replication. A value of 0 means replicate metadata on every request; a value of -1 means never replicate metadata unless the session is otherwise dirty.

setMaxUnreplicatedInterval

void setMaxUnreplicatedInterval(int maxUnreplicatedInterval)

Sets the maximum interval between requests, in seconds, after which a request will trigger replication of the session's metadata regardless of whether the request has otherwise made the session dirty.

Parameters:

maxUnreplicatedInterval - the maximum interval since last replication after which a request will trigger session metadata replication. A value of 0 means replicate metadata on every request; a value of -1 means never replicate metadata unless the session is otherwise dirty.

getUseJBossWebLoader

boolean getUseJBossWebLoader()

Get the JBoss UCL use flag

setUseJBossWebLoader

void setUseJBossWebLoader(boolean flag)

Set the JBoss UCL use flag

getManagerClass

java.lang.String getManagerClass()

setManagerClass

void setManagerClass(java.lang.String managerClass)

getContextMBeanCode

java.lang.String getContextMBeanCode()

setContextMBeanCode

void setContextMBeanCode(java.lang.String className)

getConfigFile

java.lang.String getConfigFile()

Get the name of the external tomcat server configuration file.

Returns:

the config file name, server.xml for example

setConfigFile

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

java.lang.String getSubjectAttributeName()

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

Specified by:

getSubjectAttributeName in interface org.jboss.web.AbstractWebContainerMBean

setSubjectAttributeName

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.

Specified by:

setSubjectAttributeName in interface org.jboss.web.AbstractWebContainerMBean

Parameters:

name - the HttpServletRequest attribute name to store the Subject

startConnectors

void startConnectors()
                     throws java.lang.Exception

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

Throws:

java.lang.Exception

stopConnectors

void stopConnectors()
                    throws java.lang.Exception

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

Throws:

java.lang.Exception

isAllowSelfPrivilegedWebApps

boolean isAllowSelfPrivilegedWebApps()

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

setAllowSelfPrivilegedWebApps

void setAllowSelfPrivilegedWebApps(boolean flag)

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

setSecurityManagerService

void setSecurityManagerService(org.jboss.security.plugins.JaasSecurityManagerServiceMBean mgr)

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

Parameters:

mgr - the JaasSecurityManagerServiceMBean

getFilteredPackages

java.lang.String[] getFilteredPackages()

Returns:

setFilteredPackages

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

Parameters:

pkgs -