Package org.apache.tomcat.websocket.server

Class WsHttpSessionBindingListener

java.lang.Object

org.apache.tomcat.websocket.server.WsHttpSessionBindingListener

All Implemented Interfaces:

HttpSessionBindingListener, java.io.Serializable, java.util.EventListener

public class WsHttpSessionBindingListener
extends java.lang.Object
implements HttpSessionBindingListener, java.io.Serializable

Listener used to track when an HTTP session expires and notifies the WebSocket container so any associated WebSocket session can be closed.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
WsHttpSessionBindingListener(java.lang.String key)	Create a new listener.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getKey()
void	valueUnbound(HttpSessionBindingEvent event)	Notifies the object that it is being unbound from a session and identifies the session.

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.servlet.http.HttpSessionBindingListener

valueBound

Constructor Detail

WsHttpSessionBindingListener

public WsHttpSessionBindingListener(java.lang.String key)

Create a new listener.

Parameters:

key - The key that identifies the HTTP session

Method Detail

getKey

public java.lang.String getKey()

valueUnbound

public void valueUnbound(HttpSessionBindingEvent event)

Description copied from interface: jakarta.servlet.http.HttpSessionBindingListener

Notifies the object that it is being unbound from a session and identifies the session. The default implementation is a NO-OP.

Specified by:

valueUnbound in interface HttpSessionBindingListener

Parameters:

event - the event that identifies the session

See Also:

HttpSessionBindingListener.valueBound(jakarta.servlet.http.HttpSessionBindingEvent)