KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tapestry > services > CookieSource


1 // Copyright 2004, 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.services;
16
17 /**
18  * Used by other services to obtain cookie values for the current request.
19  *
20  * @author Howard Lewis Ship
21  * @since 4.0
22  */

23 public interface CookieSource
24 {
25     /**
26      * Returns the value of the first cookie whose name matches. Returns null if no such cookie
27      * exists.
28      */

29     public String JavaDoc readCookieValue(String JavaDoc name);
30
31     /**
32      * Creates or updates a cookie value. The value is stored permanently (no timeout, not session
33      * based). TODO: add suport for timeouts and session cookies.
34      */

35
36     public void writeCookieValue(String JavaDoc name, String JavaDoc value);
37
38     /**
39      * Removes a previously written cookie, by writing a new cookie with a maxAge of 0.
40      */

41
42     public void removeCookieValue(String JavaDoc name);
43 }
Popular Tags