org.jboss.as.web.session.notification

Interface ClusteredSessionNotificationPolicy

All Known Implementing Classes:

ClusteredSessionNotificationPolicyBase, IgnoreUndeployLegacyClusteredSessionNotificationPolicy, LegacyClusteredSessionNotificationPolicy

public interface ClusteredSessionNotificationPolicy

Policy for determining whether the servlet spec notifications related to session events are allowed to be emitted on the local cluster node.

Note: The use of the word allowed above is intentional; if a given policy implementation returns true from one of the methods in this interface, that does not mean the listener will be invoked by the container, nor does the presence of a method in this interface imply that it will be invoked by the container in all cases. The only contract this interface creates is that before invoking a listener method, the container will invoke an implementation of this policy to get permission and will not invoke the listeners if this policy returns false. If the container does not support emitting notifications in certain cases, it may not bother checking if the notification is allowed, and even if it checks, it still will not emit the notification.

An example of a case where the container may not support emitting a notification is for a session that has never been used locally.

Author:

Brian Stansberry

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isHttpSessionActivationListenerInvocationAllowed(ClusteredSessionManagementStatus status, ClusteredSessionNotificationCause cause, String attributeName) Under the given conditions, are invocations of HttpSessionActivationListener callbacks allowed?
boolean	isHttpSessionAttributeListenerInvocationAllowed(ClusteredSessionManagementStatus status, ClusteredSessionNotificationCause cause, String attributeName, boolean local) Under the given conditions, are invocations of HttpSessionAttributeListener callbacks allowed?
boolean	isHttpSessionBindingListenerInvocationAllowed(ClusteredSessionManagementStatus status, ClusteredSessionNotificationCause cause, String attributeName, boolean local) Under the given conditions, are invocations of HttpSessionBindingListener callbacks allowed?
boolean	isHttpSessionListenerInvocationAllowed(ClusteredSessionManagementStatus status, ClusteredSessionNotificationCause cause, boolean local) Are invocations of HttpSessionListener callbacks allowed under the given conditions?
void	setClusteredSessionNotificationCapability(ClusteredSessionNotificationCapability capability) Provides the policy information about the container's capabilities with respect to issuing notifications.

Method Detail

isHttpSessionListenerInvocationAllowed

boolean isHttpSessionListenerInvocationAllowed(ClusteredSessionManagementStatus status,
                                             ClusteredSessionNotificationCause cause,
                                             boolean local)

Are invocations of HttpSessionListener callbacks allowed 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 allowed, false if not

isHttpSessionAttributeListenerInvocationAllowed

boolean isHttpSessionAttributeListenerInvocationAllowed(ClusteredSessionManagementStatus status,
                                                      ClusteredSessionNotificationCause cause,
                                                      String attributeName,
                                                      boolean local)

Under the given conditions, are invocations of HttpSessionAttributeListener callbacks allowed?

Parameters:

status - the status of the session

cause - the cause of the session notification

attributeName - value that would be passed to the name param of the HttpSessionBindingEvent if the listener were invoked

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

Returns:

true if the notification is allowed, false if not

isHttpSessionBindingListenerInvocationAllowed

boolean isHttpSessionBindingListenerInvocationAllowed(ClusteredSessionManagementStatus status,
                                                    ClusteredSessionNotificationCause cause,
                                                    String attributeName,
                                                    boolean local)

Under the given conditions, are invocations of HttpSessionBindingListener callbacks allowed?

Parameters:

status - the status of the session

cause - the cause of the session notification

attributeName - value that would be passed to the name param of the HttpSessionBindingEvent if the listener were invoked

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

Returns:

true if the notification is allowed, false if not

isHttpSessionActivationListenerInvocationAllowed

boolean isHttpSessionActivationListenerInvocationAllowed(ClusteredSessionManagementStatus status,
                                                       ClusteredSessionNotificationCause cause,
                                                       String attributeName)

Under the given conditions, are invocations of HttpSessionActivationListener callbacks allowed?

Parameters:

status - the status of the session

cause - the cause of the session notification

attributeName - value that would be passed to the name param of the HttpSessionEvent if the listener were invoked

Returns:

true if the notification is allowed, false if not

setClusteredSessionNotificationCapability

void setClusteredSessionNotificationCapability(ClusteredSessionNotificationCapability capability)

Provides the policy information about the container's capabilities with respect to issuing notifications. Will be invoked by the container before the first invocation of any of the other methods in this interface.

Parameters:

capability - the capability, Will not be null.