HttpSessionBindingListener


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   
24   
25  
26  /**
27   * Causes an object to be notified when it is bound to
28   * or unbound from a session. The object is notified
29   * by an {@link HttpSessionBindingEvent} object. This may be as a result
30   * of a servlet programmer explicitly unbinding an attribute from a session,
31   * due to a session being invalidated, or due to a session timing out.
32   *
33   *
34   * @author      Various
35   * @version     $Version$
36   *
37   * @see HttpSession
38   * @see HttpSessionBindingEvent
39   *
40   */
41  
42  public interface HttpSessionBindingListener extends EventListener   {
43  
44  
45  
46      /**
47       *
48       * Notifies the object that it is being bound to
49       * a session and identifies the session.
50       *
51       * @param event     the event that identifies the
52       *              session 
53       *
54       * @see #valueUnbound
55       *
56       */ 
57  
58      public void valueBound(HttpSessionBindingEvent   event);
59      
60      
61  
62      /**
63       *
64       * Notifies the object that it is being unbound
65       * from a session and identifies the session.
66       *
67       * @param event     the event that identifies
68       *              the session 
69       *  
70       * @see #valueBound
71       *
72       */
73  
74      public void valueUnbound(HttpSessionBindingEvent   event);
75      
76      
77  }
78  
79
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags