lib/servlet-api/javax/servlet/http/HttpSessionBindingListener.java

   1 /*
   2  * Licensed to the Apache Software Foundation (ASF) under one or more
   3  * contributor license agreements.  See the NOTICE file distributed with
   4  * this work for additional information regarding copyright ownership.
   5  * The ASF licenses this file to You under the Apache License, Version 2.0
   6  * (the "License"); you may not use this file except in compliance with
   7  * the License.  You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 package javax.servlet.http;
  19
  20 import java.util.EventListener;
  21
  22 /**
  23  * Causes an object to be notified when it is bound to or unbound from a
  24  * session. The object is notified by an {@link HttpSessionBindingEvent} object.
  25  * This may be as a result of a servlet programmer explicitly unbinding an
  26  * attribute from a session, due to a session being invalidated, or due to a
  27  * session timing out.
  28  *
  29  * @see HttpSession
  30  * @see HttpSessionBindingEvent
  31  */
  32 public interface HttpSessionBindingListener extends EventListener {
  33
  34     /**
  35      * Notifies the object that it is being bound to a session and identifies
  36      * the session.
  37      *
  38      * @param event
  39      *            the event that identifies the session
  40      * @see #valueUnbound
  41      */
  42     public void valueBound(HttpSessionBindingEvent event);
  43
  44     /**
  45      * Notifies the object that it is being unbound from a session and
  46      * identifies the session.
  47      *
  48      * @param event
  49      *            the event that identifies the session
  50      * @see #valueBound
  51      */
  52     public void valueUnbound(HttpSessionBindingEvent event);
  53 }