Package org.atmosphere.cpr

Class AtmosphereConfig

java.lang.Object

org.atmosphere.cpr.AtmosphereConfig

public class AtmosphereConfig
extends java.lang.Object

This class contains information about the current state of the AtmosphereFramework. You can also register a AtmosphereConfig.ShutdownHook.

Author:

Sebastien Dionne : sebastien.dionne@gmail.com, Jeanfrancois Arcand

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AtmosphereConfig.ShutdownHook	A shutdown hook that will be called when the AtmosphereFramework.destroy() method gets invoked.
static interface	AtmosphereConfig.StartupHook	A Startup hook that will be called when the AtmosphereFramework.init() method complete.

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.slf4j.Logger	logger
protected java.util.List<AtmosphereConfig.ShutdownHook>	shutdownHooks
protected java.util.List<AtmosphereConfig.StartupHook>	startUpHook

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AtmosphereConfig(AtmosphereFramework framework)

Method Summary

Modifier and Type	Method	Description
protected void	destroy()	Invoke AtmosphereConfig.ShutdownHooks.
AtmosphereFramework	framework()	Return the AtmosphereFramework.
java.util.List<AtmosphereHandlerConfig>	getAtmosphereHandlerConfig()
BroadcasterFactory	getBroadcasterFactory()	Return an instance of DefaultBroadcasterFactory.
java.lang.String	getInitParameter(java.lang.String name)	Return the value of the init params defined in web.xml or application.xml.
boolean	getInitParameter(java.lang.String key, boolean defaultValue)	Return an init-param, or its default value.
int	getInitParameter(java.lang.String key, int defaultValue)	Return an init-param, or its default value.
java.lang.String	getInitParameter(java.lang.String key, java.lang.String defaultValue)	Return an init-param, or its default value.
java.util.Enumeration<java.lang.String>	getInitParameterNames()	Return all init param.
jakarta.servlet.ServletConfig	getServletConfig()	Return the ServletConfig.
jakarta.servlet.ServletContext	getServletContext()	Return the ServletContext.
java.lang.String	getWebServerName()	Return the current WebServer used.
java.util.Map<java.lang.String,AtmosphereFramework.AtmosphereHandlerWrapper>	handlers()	Return the list of AtmosphereFramework.AtmosphereHandlerWrappers.
protected void	initComplete()	Invoke AtmosphereConfig.ShutdownHooks.
boolean	isSessionTimeoutRemovalAllowed()	Allow HTTP session timeout removal when session support is active
boolean	isSupportSession()	Is HttpSession supported.
boolean	isThrowExceptionOnCloned()	Is cloned request throws exception.
MetaBroadcaster	metaBroadcaster()	Return the DefaultMetaBroadcaster
AtmosphereConfig	populate(AtmosphereConfig config)
java.util.Map<java.lang.String,java.lang.Object>	properties()	Return the Map of Applications's properties.
AtmosphereResourceFactory	resourcesFactory()	Return the AtmosphereResourceFactory
AtmosphereResourceSessionFactory	sessionFactory()	Return the AtmosphereResourceSessionFactory
void	setSessionTimeoutRemovalAllowed(boolean sessionTimeoutRemovalAllowed)	Enable/Disable HttpSession timeout removal when a connection exists.
void	setSupportSession(boolean supportSession)	Enable/Disable HttpSession.
void	setThrowExceptionOnCloned(boolean throwExceptionOnCloned)	Enable/Disable Exception on cloned request.
AtmosphereConfig	shutdownHook(AtmosphereConfig.ShutdownHook s)	Add a AtmosphereConfig.ShutdownHook.
AtmosphereConfig	startupHook(AtmosphereConfig.StartupHook s)	Add a AtmosphereConfig.StartupHook.
UUIDProvider	uuidProvider()	Return the UUIDProvider
WebSocketFactory	websocketFactory()	Return the WebSocketFactory

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

shutdownHooks

protected java.util.List<AtmosphereConfig.ShutdownHook> shutdownHooks

startUpHook

protected java.util.List<AtmosphereConfig.StartupHook> startUpHook

Constructor Detail

AtmosphereConfig

protected AtmosphereConfig(AtmosphereFramework framework)

Method Detail

getAtmosphereHandlerConfig

public java.util.List<AtmosphereHandlerConfig> getAtmosphereHandlerConfig()

framework

public AtmosphereFramework framework()

Return the AtmosphereFramework.

Returns:

the AtmosphereFramework

getServletConfig

public jakarta.servlet.ServletConfig getServletConfig()

Return the ServletConfig.

Returns:

ServletConfig

getServletContext

public jakarta.servlet.ServletContext getServletContext()

Return the ServletContext.

Returns:

ServletContext

getWebServerName

public java.lang.String getWebServerName()

Return the current WebServer used.

Returns:

the current WebServer used

handlers

public java.util.Map<java.lang.String,AtmosphereFramework.AtmosphereHandlerWrapper> handlers()

Return the list of AtmosphereFramework.AtmosphereHandlerWrappers.

Returns:

the list of AtmosphereFramework.AtmosphereHandlerWrapper

getInitParameter

public java.lang.String getInitParameter(java.lang.String name)

Return the value of the init params defined in web.xml or application.xml.

Parameters:

name - the name

Returns:

the value for the init parameter if defined

getInitParameterNames

public java.util.Enumeration<java.lang.String> getInitParameterNames()

Return all init param.

Returns:

the list of init params defined in web.xml or application.xml for the servlet

isSupportSession

public boolean isSupportSession()

Is HttpSession supported.

Returns:

HttpSession supported.

setSupportSession

public void setSupportSession(boolean supportSession)

Enable/Disable HttpSession.

Parameters:

supportSession - true to enable, false to disable

isSessionTimeoutRemovalAllowed

public boolean isSessionTimeoutRemovalAllowed()

Allow HTTP session timeout removal when session support is active

Returns:

HTTP session timeout removal allowed.

setSessionTimeoutRemovalAllowed

public void setSessionTimeoutRemovalAllowed(boolean sessionTimeoutRemovalAllowed)

Enable/Disable HttpSession timeout removal when a connection exists.

Parameters:

sessionTimeoutRemovalAllowed - true to enable, false to disable

isThrowExceptionOnCloned

public boolean isThrowExceptionOnCloned()

Is cloned request throws exception.

Returns:

Cloned Request's exception supported.

setThrowExceptionOnCloned

public void setThrowExceptionOnCloned(boolean throwExceptionOnCloned)

Enable/Disable Exception on cloned request.

Parameters:

throwExceptionOnCloned -

getBroadcasterFactory

public BroadcasterFactory getBroadcasterFactory()

Return an instance of DefaultBroadcasterFactory.

Returns:

an instance of DefaultBroadcasterFactory

properties

public java.util.Map<java.lang.String,java.lang.Object> properties()

Return the Map of Applications's properties.

Returns:

the Map of Applications's properties

destroy

protected void destroy()

Invoke AtmosphereConfig.ShutdownHooks.

initComplete

protected void initComplete()

Invoke AtmosphereConfig.ShutdownHooks.

shutdownHook

public AtmosphereConfig shutdownHook(AtmosphereConfig.ShutdownHook s)

Add a AtmosphereConfig.ShutdownHook.

Parameters:

s - a AtmosphereConfig.ShutdownHook

Returns:

this

startupHook

public AtmosphereConfig startupHook(AtmosphereConfig.StartupHook s)

Add a AtmosphereConfig.StartupHook. If the AtmosphereFramework.isInit return true, the StartupHook will be executed immediately.

Parameters:

s - a AtmosphereConfig.StartupHook

Returns:

this

getInitParameter

public java.lang.String getInitParameter(java.lang.String key,
                                         java.lang.String defaultValue)

Return an init-param, or its default value.

Parameters:

key -

defaultValue -

Returns:

an init-param, or its default value.

getInitParameter

public boolean getInitParameter(java.lang.String key,
                                boolean defaultValue)

Return an init-param, or its default value.

Parameters:

key -

defaultValue -

Returns:

an init-param, or its default value.

getInitParameter

public int getInitParameter(java.lang.String key,
                            int defaultValue)

Return an init-param, or its default value.

Parameters:

key -

defaultValue -

Returns:

an init-param, or its default value.

resourcesFactory

public AtmosphereResourceFactory resourcesFactory()

Return the AtmosphereResourceFactory

Returns:

the AtmosphereResourceFactory

metaBroadcaster

public MetaBroadcaster metaBroadcaster()

Return the DefaultMetaBroadcaster

Returns:

the MetaBroadcaster

sessionFactory

public AtmosphereResourceSessionFactory sessionFactory()

Return the AtmosphereResourceSessionFactory

Returns:

the AtmosphereResourceSessionFactory

uuidProvider

public UUIDProvider uuidProvider()

Return the UUIDProvider

Returns:

UUIDProvider

websocketFactory

public WebSocketFactory websocketFactory()

Return the WebSocketFactory

Returns:

the WebSocketFactory

populate

public AtmosphereConfig populate(AtmosphereConfig config)