Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||||
WebSession |
|
| 1.0;1 |
1 | // Copyright 2005 The Apache Software Foundation |
|
2 | // |
|
3 | // Licensed under the Apache License, Version 2.0 (the "License"); |
|
4 | // you may not use this file except in compliance with the License. |
|
5 | // You may obtain a copy of the License at |
|
6 | // |
|
7 | // http://www.apache.org/licenses/LICENSE-2.0 |
|
8 | // |
|
9 | // Unless required by applicable law or agreed to in writing, software |
|
10 | // distributed under the License is distributed on an "AS IS" BASIS, |
|
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|
12 | // See the License for the specific language governing permissions and |
|
13 | // limitations under the License. |
|
14 | ||
15 | package org.apache.tapestry.web; |
|
16 | ||
17 | import org.apache.tapestry.describe.Describable; |
|
18 | ||
19 | /** |
|
20 | * Primarily concerned with maintaining server-side state as attributes. |
|
21 | * |
|
22 | * @author Howard M. Lewis Ship |
|
23 | * @since 4.0 |
|
24 | */ |
|
25 | public interface WebSession extends AttributeHolder, Describable |
|
26 | { |
|
27 | /** |
|
28 | * Returns a unique string identifier used to identify the session. This value is provided by |
|
29 | * the container, and is typically incorporated into URLs, or stored as a HTTP cookie. |
|
30 | * |
|
31 | * @see org.apache.tapestry.web.WebResponse#encodeURL(String) . |
|
32 | */ |
|
33 | String getId(); |
|
34 | ||
35 | /** |
|
36 | * Returns true if the client does not yet know about the session or if the client chooses not |
|
37 | * to join the session. |
|
38 | */ |
|
39 | boolean isNew(); |
|
40 | ||
41 | /** |
|
42 | * Invalidates this session then unbinds any objects bound to it. |
|
43 | * |
|
44 | * @throws IllegalStateException |
|
45 | * if the session is already invalidated. |
|
46 | */ |
|
47 | ||
48 | void invalidate(); |
|
49 | ||
50 | /** |
|
51 | * Returns the time when this session was created, measured in milliseconds |
|
52 | * since midnight January 1, 1970 GMT. |
|
53 | * |
|
54 | * @return a long specifying when this session was created, |
|
55 | * expressed in milliseconds since 1/1/1970 GMT |
|
56 | */ |
|
57 | ||
58 | long getCreationTime(); |
|
59 | ||
60 | /** |
|
61 | * Returns the last time the client sent a request associated with this session, as |
|
62 | * the number of milliseconds since midnight January 1, 1970 GMT, and marked by the |
|
63 | * time the container recieved the request. |
|
64 | * |
|
65 | * <p> Actions that your application takes, such as getting or setting a value associated |
|
66 | * with the session, do not affect the access time.</p> |
|
67 | * |
|
68 | * @return a long representing the last time the client sent a request associated with |
|
69 | * this session, expressed in milliseconds since 1/1/1970 GMT |
|
70 | */ |
|
71 | ||
72 | long getLastAccessedTime(); |
|
73 | ||
74 | /** |
|
75 | * Returns the maximum time interval, in seconds, that the servlet container will |
|
76 | * keep this session open between client accesses. After this interval, the servlet |
|
77 | * container will invalidate the session. The maximum time interval can be set with |
|
78 | * the setMaxInactiveInterval method. A negative time indicates the session should |
|
79 | * never timeout. |
|
80 | * |
|
81 | * @return an integer specifying the number of seconds this session |
|
82 | * remains open between client requests |
|
83 | */ |
|
84 | ||
85 | int getMaxInactiveInterval(); |
|
86 | ||
87 | /** |
|
88 | * Specifies the time, in seconds, between client requests before the servlet container |
|
89 | * will invalidate this session. A negative time indicates the session should never timeout. |
|
90 | * |
|
91 | * @param interval - An integer specifying the number of seconds |
|
92 | */ |
|
93 | ||
94 | void setMaxInactiveInterval(int interval); |
|
95 | } |