1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package javax.servlet.http;
/**
*
* Events of this type are either sent to an object that implements
* {@link HttpSessionBindingListener} when it is bound or
* unbound from a session, or to a {@link HttpSessionAttributeListener}
* that has been configured in the deployment descriptor when any attribute is
* bound, unbound or replaced in a session.
*
* <p>The session binds the object by a call to
* <code>HttpSession.setAttribute</code> and unbinds the object
* by a call to <code>HttpSession.removeAttribute</code>.
*
*
*
* @author Various
* @version $Version$
*
* @see HttpSession
* @see HttpSessionBindingListener
* @see HttpSessionAttributeListener
*/
public class HttpSessionBindingEvent extends HttpSessionEvent {
/* The name to which the object is being bound or unbound */
private String name;
/* The object is being bound or unbound */
private 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
* {@link HttpSessionBindingListener}.
*
*
*
* @param session the session to which the object is bound or unbound
*
* @param name the name with which the object is bound or unbound
*
* @see #getName
* @see #getSession
*
*/
public HttpSessionBindingEvent(HttpSession session, String name) {
super(session);
this.name = 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
* {@link HttpSessionBindingListener}.
*
*
*
* @param session the session to which the object is bound or unbound
*
* @param name the name with which the object is bound or unbound
*
* @see #getName
* @see #getSession
*
*/
public HttpSessionBindingEvent(HttpSession session, String name, Object value) {
super(session);
this.name = name;
this.value = value;
}
/** Return the session that changed. */
public HttpSession getSession () {
return super.getSession();
}
/**
*
* Returns the name with which the attribute is bound to or
* unbound from the session.
*
*
* @return a string specifying the name with which
* the object is bound to or unbound from
* the session
*
*
*/
public String getName() {
return name;
}
/**
* Returns the value of the attribute that has been 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.
*
* @since 2.3
*/
public Object getValue() {
return this.value;
}
}
|
