org.jboss.as.web.session.notification

Class ClusteredSessionNotificationCapability

java.lang.Object

org.jboss.as.web.session.notification.ClusteredSessionNotificationCapability

public class ClusteredSessionNotificationCapability
extends Object

Encapsulates information about the container's capability to issue servlet spec notifications under different conditions. Implementations of ClusteredSessionNotificationPolicy can use this information to get a sense of the capabilities of the container.

Author:

Brian Stansberry

Constructor Summary

Constructors

Constructor and Description
ClusteredSessionNotificationCapability()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isHttpSessionAttributeListenerInvocationSupported(ClusteredSessionManagementStatus status, ClusteredSessionNotificationCause cause, boolean local) Under the given conditions, does the container support invoking HttpSessionAttributeListener callbacks?
boolean	isHttpSessionBindingListenerInvocationSupported(ClusteredSessionManagementStatus status, ClusteredSessionNotificationCause cause, boolean local) Under the given conditions, does the container support invoking HttpSessionBindingListener callbacks?
boolean	isHttpSessionListenerInvocationSupported(ClusteredSessionManagementStatus status, ClusteredSessionNotificationCause cause, boolean local) Does the container support invoking HttpSessionListener callbacks under the given conditions?
boolean	isLocallyActiveAware() Is the container able to distinguish whether a session that has been locally used is also locally active?
boolean	isLocallyOwnedAware() Is the container able to distinguish whether a session is locally owned?
boolean	isRemoteCauseAware(ClusteredSessionNotificationCause cause) Returns whether the local container is aware of events on remote nodes that could give rise to notifications.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusteredSessionNotificationCapability

public ClusteredSessionNotificationCapability()

Method Detail

isHttpSessionListenerInvocationSupported

public boolean isHttpSessionListenerInvocationSupported(ClusteredSessionManagementStatus status,
                                               ClusteredSessionNotificationCause cause,
                                               boolean local)

Does the container support invoking HttpSessionListener callbacks under the given conditions?

Parameters:

status - the status of the session

cause - the cause of the session notification

local - true if the event driving the notification originated on this node; false otherwise

Returns:

true if the notification is supported, false if not

isHttpSessionAttributeListenerInvocationSupported

public boolean isHttpSessionAttributeListenerInvocationSupported(ClusteredSessionManagementStatus status,
                                                        ClusteredSessionNotificationCause cause,
                                                        boolean local)

Under the given conditions, does the container support invoking HttpSessionAttributeListener callbacks?

Parameters:

status - the status of the session

cause - the cause of the session notification

local - true if the event driving the notification originated on this node; false otherwise

Returns:

true if the notification is supported, false if not

isHttpSessionBindingListenerInvocationSupported

public boolean isHttpSessionBindingListenerInvocationSupported(ClusteredSessionManagementStatus status,
                                                      ClusteredSessionNotificationCause cause,
                                                      boolean local)

Under the given conditions, does the container support invoking HttpSessionBindingListener callbacks?

Parameters:

status - the status of the session

cause - the cause of the session notification

local - true if the event driving the notification originated on this node; false otherwise

Returns:

true if the notification is supported, false if not

isLocallyActiveAware

public boolean isLocallyActiveAware()

Is the container able to distinguish whether a session that has been locally used is also locally active?

Returns:

true if the container is able to make this distinction; false if not

isLocallyOwnedAware

public boolean isLocallyOwnedAware()

Is the container able to distinguish whether a session is locally owned?

Returns:

true if the container is able to make this distinction; false if not

isRemoteCauseAware

public boolean isRemoteCauseAware(ClusteredSessionNotificationCause cause)

Returns whether the local container is aware of events on remote nodes that could give rise to notifications.

Parameters:

cause - the cause

Returns:

true if the local container is aware of the remote event, false if not.