Top Description Fields Constructors Methods
jakarta.servlet.http

public Class HttpSessionBindingEvent

extends HttpSessionEvent
Class Inheritance
Events of this type are either sent to an object that implements HttpSessionBindingListener when it is bound or unbound from a session, or to an HttpSessionAttributeListener that has been configured in the deployment descriptor when any attribute is bound, unbound or replaced in a session.

The session binds the object by a call to HttpSession.setAttribute and unbinds the object by a call to HttpSession.removeAttribute.

See Also
HttpSession, HttpSessionBindingListener, HttpSessionAttributeListener

Field Summary

Modifier and TypeField and Description
private final String
name

The name to which the object is being bound or unbound.

private static final long
serialVersionUID

Hides jakarta.servlet.http.HttpSessionEvent.serialVersionUID.

private final Object
value

The object is being bound or unbound.

Constructor Summary

AccessConstructor and Description
public
HttpSessionBindingEvent(HttpSession
the session to which the object is bound or unbound
session, String
the name with which the object is bound or unbound
name)

Constructs an event that notifies an object that it has been bound to or unbound from a session.

public
HttpSessionBindingEvent(HttpSession
the session to which the object is bound or unbound
session, String
the name with which the object is bound or unbound
name, Object
the object that is bound or unbound
value)

Constructs an event that notifies an object that it has been bound to or unbound from a session.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

a string specifying the name with which the object is bound to or unbound from the session
getName()

Returns the name with which the attribute is bound to or unbound from the session.

public HttpSession

Returns:

The session that changed
getSession()

Overrides jakarta.servlet.http.HttpSessionEvent.getSession.

Get the session that changed.

public Object

Returns:

If the attribute was added (or bound), this is the value of the attribute. If the attribute was removed (or unbound), this is the value of the removed attribute. If the attribute was replaced, this is the old value of the attribute.
getValue()

Returns the value of the attribute that has been added, removed or replaced.

Field Detail

nameback to summary
private final String name

The name to which the object is being bound or unbound.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides jakarta.servlet.http.HttpSessionEvent.serialVersionUID.

valueback to summary
private final Object value

The object is being bound or unbound.

Constructor Detail

HttpSessionBindingEventback to summary
public HttpSessionBindingEvent(HttpSession session, String name)

Constructs an event that notifies an object that it has been bound to or unbound from a session. To receive the event, the object must implement HttpSessionBindingListener.

Parameters
session:HttpSession

the session to which the object is bound or unbound

name:String

the name with which the object is bound or unbound

See Also
getName(), getSession()
HttpSessionBindingEventback to summary
public HttpSessionBindingEvent(HttpSession session, String name, Object value)

Constructs an event that notifies an object that it has been bound to or unbound from a session. To receive the event, the object must implement HttpSessionBindingListener.

Parameters
session:HttpSession

the session to which the object is bound or unbound

name:String

the name with which the object is bound or unbound

value:Object

the object that is bound or unbound

See Also
getName(), getSession(), getValue()

Method Detail

getNameback to summary
public String getName()

Returns the name with which the attribute is bound to or unbound from the session.

Returns:String

a string specifying the name with which the object is bound to or unbound from the session

getSessionback to summary
public HttpSession getSession()

Overrides jakarta.servlet.http.HttpSessionEvent.getSession.

Get the session that changed.

Returns:HttpSession

The session that changed

Annotations
@Override
getValueback to summary
public Object getValue()

Returns the value of the attribute that has been added, removed or replaced.

Returns:Object

If the attribute was added (or bound), this is the value of the attribute. If the attribute was removed (or unbound), this is the value of the removed attribute. If the attribute was replaced, this is the old value of the attribute.

Since
Servlet 2.3