IX / libservlet-0.9.2 / doc / api / Servlet / Http / HttpSessionBindingEvent.html 
<HTML>
<HEAD>
<TITLE>Servlet::Http::HttpSessionBindingEvent - session binding event class</TITLE>
<LINK REL="stylesheet" HREF="../../../libservlet.css" TYPE="text/css">
<LINK REV="made" HREF="mailto:feedback@suse.de">
</HEAD>

<BODY>

<A NAME="__index__"></A>
<!-- INDEX BEGIN -->

<UL>

	<LI><A HREF="#name">NAME</A></LI>
	<LI><A HREF="#synopsis">SYNOPSIS</A></LI>
	<LI><A HREF="#description">DESCRIPTION</A></LI>
	<LI><A HREF="#constructor">CONSTRUCTOR</A></LI>
	<LI><A HREF="#methods">METHODS</A></LI>
	<LI><A HREF="#see also">SEE ALSO</A></LI>
	<LI><A HREF="#author">AUTHOR</A></LI>
</UL>
<!-- INDEX END -->

<HR>
<P>
<HR>
<H1><A NAME="name">NAME</A></H1>
<P>Servlet::Http::HttpSessionBindingEvent - session binding event class</P>
<P>
<HR>
<H1><A NAME="synopsis">SYNOPSIS</A></H1>
<PRE>
  my $event =
      Servlet::Http::HttpSessionEvent-&gt;new($session, $attribute, $value);</PRE>
<PRE>
  my $name = $event-&gt;getName();
  my $value = $event-&gt;getValue();</PRE>
<PRE>
  my $session = $event-&gt;getSession();
  # or
  my $session = $event-&gt;getSource();</PRE>
<P>
<HR>
<H1><A NAME="description">DESCRIPTION</A></H1>
<P>This class represents event notifications for changes to session
attributes. The event is either sent to an object that implements
<STRONG>Servlet::Http::HttpSessionBindingListener</STRONG> when it is bound or
unbound from a session, or to a
<STRONG>Servlet::Http::HttpSessionAttributesListener</STRONG> that has been
configured in the deployment descriptor when any attribute is bound,
unbound or replaced in a session.</P>
<P>
<HR>
<H1><A NAME="constructor">CONSTRUCTOR</A></H1>
<DL>
<DT><STRONG><A NAME="item_new">new($session, $name, [$value])</A></STRONG><BR>
<DD>
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 <STRONG>Servlet::Http::HttpSessionBindingListener</STRONG>.
<P><STRONG>Parameters:</STRONG></P>
<DL>
<DT><STRONG><A NAME="item_%24session"><EM>$session</EM></A></STRONG><BR>
<DD>
the <STRONG>Servlet::Http::HttpSession</STRONG> instance to which the object is
bound or unbound
<P></P>
<DT><STRONG><A NAME="item_%24name"><EM>$name</EM></A></STRONG><BR>
<DD>
the name with which the object is bound or unbound
<P></P></DL>
<DT><STRONG><A NAME="item_%24object"><EM>$object</EM></A></STRONG><BR>
<DD>
the scalar or reference that is bound or unbound
<P></P></DL>
<P>
<HR>
<H1><A NAME="methods">METHODS</A></H1>
<DL>
<DT><STRONG><A NAME="item_getName"><CODE>getName()</CODE></A></STRONG><BR>
<DD>
Returns the name with which the object is bound to or unbound from the
session.
<P></P>
<DT><STRONG><A NAME="item_getSession"><CODE>getSession()</CODE></A></STRONG><BR>
<DD>
Returns the <STRONG>Servlet::Http::HttpSession</STRONG> that is the source of this event.
<P></P>
<DT><STRONG><A NAME="item_getSource"><CODE>getSource()</CODE></A></STRONG><BR>
<DD>
Returns the <STRONG>Servlet::Http::HttpSession</STRONG> that is the source of this event.
<P></P>
<DT><STRONG><A NAME="item_getValue"><CODE>getValue()</CODE></A></STRONG><BR>
<DD>
Returns the value of the attribute being added, removed or
replaced. 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.
<P></P></DL>
<P>
<HR>
<H1><A NAME="see also">SEE ALSO</A></H1>
<P><A HREF="../../../api/Servlet/Http/HttpSession.html">the Servlet::Http::HttpSession manpage</A>,
<A HREF="../../../api/Servlet/Http/HttpSessionEvent.html">the Servlet::Http::HttpSessionEvent manpage</A>,
<A HREF="../../../api/Servlet/Http/HttpSessionAttributesListener.html">the Servlet::Http::HttpSessionAttributesListener manpage</A>,
<A HREF="../../../api/Servlet/Http/HttpSessionBindingListener.html">the Servlet::Http::HttpSessionBindingListener manpage</A></P>
<P>
<HR>
<H1><A NAME="author">AUTHOR</A></H1>
<P>Brian Moseley, <A HREF="mailto:bcm@maz.org">bcm@maz.org</A></P>

</BODY>

</HTML>