Package org.apache.catalina.ha.context

Class ReplicatedContext.ReplApplContext

java.lang.Object

org.apache.catalina.core.ApplicationContext

org.apache.catalina.ha.context.ReplicatedContext.ReplApplContext

All Implemented Interfaces:

ServletContext

Enclosing class:

ReplicatedContext

protected static class ReplicatedContext.ReplApplContext
extends ApplicationContext

Application context implementation for replicated contexts.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Map<java.lang.String,java.lang.Object>	tomcatAttributes	Map for Tomcat-specific attributes that should not be replicated.

Fields inherited from class org.apache.catalina.core.ApplicationContext

attributes

Fields inherited from interface jakarta.servlet.ServletContext

ORDERED_LIBS, TEMPDIR

Constructor Summary

Constructors

Constructor	Description
ReplApplContext(ReplicatedContext context)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
java.lang.Object	getAttribute(java.lang.String name)	Returns the servlet container attribute with the given name, or null if there is no attribute by that name.
java.util.Map<java.lang.String,java.lang.Object>	getAttributeMap()	Return the attribute map.
java.util.Enumeration<java.lang.String>	getAttributeNames()	Returns an Enumeration containing the attribute names available within this servlet context.
protected ServletContext	getFacade()	Returns the ServletContext facade.
protected ReplicatedContext	getParent()	Return the parent replicated context.
void	removeAttribute(java.lang.String name)	Removes the attribute with the given name from the servlet context.
void	setAttribute(java.lang.String name, java.lang.Object value)	Binds an object to a given attribute name in this servlet context.
void	setAttributeMap(java.util.Map<java.lang.String,java.lang.Object> map)	Set the attribute map.

Methods inherited from class org.apache.catalina.core.ApplicationContext

addFilter, addFilter, addFilter, addJspFile, addListener, addListener, addListener, addServlet, addServlet, addServlet, clearAttributes, createFilter, createListener, createServlet, declareRoles, getClassLoader, getContext, getContext, getContextPath, getDefaultSessionTrackingModes, getEffectiveMajorVersion, getEffectiveMinorVersion, getEffectiveSessionTrackingModes, getFilterRegistration, getFilterRegistrations, getInitParameter, getInitParameterNames, getJspConfigDescriptor, getMajorVersion, getMimeType, getMinorVersion, getNamedDispatcher, getRealPath, getRequestCharacterEncoding, getRequestDispatcher, getResource, getResourceAsStream, getResourcePaths, getResponseCharacterEncoding, getServerInfo, getServletContextName, getServletRegistration, getServletRegistrations, getSessionCookieConfig, getSessionTimeout, getVirtualServerName, log, log, setInitParameter, setNewServletContextListenerAllowed, setRequestCharacterEncoding, setResponseCharacterEncoding, setSessionTimeout, setSessionTrackingModes

Methods inherited from class java.lang.Object

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

Field Detail

tomcatAttributes

protected final java.util.Map<java.lang.String,java.lang.Object> tomcatAttributes

Map for Tomcat-specific attributes that should not be replicated.

Constructor Detail

ReplApplContext

public ReplApplContext(ReplicatedContext context)

Create a new instance.

Parameters:

context - the replicated context

Method Detail

getParent

protected ReplicatedContext getParent()

Return the parent replicated context.

Returns:

the parent context

getFacade

protected ServletContext getFacade()

Description copied from class: ApplicationContext

Returns the ServletContext facade.

Overrides:

getFacade in class ApplicationContext

Returns:

the facade associated with this ApplicationContext.

getAttributeMap

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

Return the attribute map.

Returns:

the attribute map

setAttributeMap

public void setAttributeMap(java.util.Map<java.lang.String,java.lang.Object> map)

Set the attribute map.

Parameters:

map - the new attribute map

removeAttribute

public void removeAttribute(java.lang.String name)

Description copied from interface: jakarta.servlet.ServletContext

Removes the attribute with the given name from the servlet context. After removal, subsequent calls to ServletContext.getAttribute(java.lang.String) to retrieve the attribute's value will return null.

If listeners are configured on the ServletContext the container notifies them accordingly.

Specified by:

removeAttribute in interface ServletContext

Overrides:

removeAttribute in class ApplicationContext

Parameters:

name - a String specifying the name of the attribute to be removed

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)

Description copied from interface: jakarta.servlet.ServletContext

Binds an object to a given attribute name in this servlet context. If the name specified is already used for an attribute, this method will replace the attribute with the new to the new attribute.

If listeners are configured on the ServletContext the container notifies them accordingly.

If a null value is passed, the effect is the same as calling removeAttribute().

Attribute names should follow the same convention as package names. The Jakarta EE platform reserves names matching jakarta.*.

Specified by:

setAttribute in interface ServletContext

Overrides:

setAttribute in class ApplicationContext

Parameters:

name - a String specifying the name of the attribute

value - an Object representing the attribute to be bound

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Description copied from interface: jakarta.servlet.ServletContext

Returns the servlet container attribute with the given name, or null if there is no attribute by that name. An attribute allows a servlet container to give the servlet additional information not already provided by this interface. See your server documentation for information about its attributes. A list of supported attributes can be retrieved using getAttributeNames.

The attribute is returned as a java.lang.Object or some subclass. Attribute names should follow the same convention as package names. The Jakarta EE platform reserves names matching jakarta.*.

Specified by:

getAttribute in interface ServletContext

Overrides:

getAttribute in class ApplicationContext

Parameters:

name - a String specifying the name of the attribute

Returns:

an Object containing the value of the attribute, or null if no attribute exists matching the given name

See Also:

ServletContext.getAttributeNames()

getAttributeNames

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

Description copied from interface: jakarta.servlet.ServletContext

Returns an Enumeration containing the attribute names available within this servlet context. Use the ServletContext.getAttribute(java.lang.String) method with an attribute name to get the value of an attribute.

Specified by:

getAttributeNames in interface ServletContext

Overrides:

getAttributeNames in class ApplicationContext

Returns:

an Enumeration of attribute names

See Also:

ServletContext.getAttribute(java.lang.String)