KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tapestry > web > WebSession


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     public String JavaDoc 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     public boolean isNew();
40 }
Popular Tags