001    // Copyright 2004, 2005 The Apache Software Foundation
002    //
003    // Licensed under the Apache License, Version 2.0 (the "License");
004    // you may not use this file except in compliance with the License.
005    // You may obtain a copy of the License at
006    //
007    //     http://www.apache.org/licenses/LICENSE-2.0
008    //
009    // Unless required by applicable law or agreed to in writing, software
010    // distributed under the License is distributed on an "AS IS" BASIS,
011    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012    // See the License for the specific language governing permissions and
013    // limitations under the License.
014    
015    package org.apache.tapestry.services;
016    
017    /**
018     * Used by other services to obtain cookie values for the current request.
019     * 
020     * @author Howard Lewis Ship
021     * @since 4.0
022     */
023    public interface CookieSource
024    {
025        /**
026         * Returns the value of the first cookie whose name matches. Returns null if no such cookie
027         * exists.
028         */
029        public String readCookieValue(String name);
030    
031        /**
032         * Creates or updates a cookie value. The value is stored permanently (no timeout, not session
033         * based). TODO: add suport for timeouts and session cookies.
034         */
035    
036        public void writeCookieValue(String name, String value);
037    
038        /**
039         * Removes a previously written cookie, by writing a new cookie with a maxAge of 0.
040         */
041    
042        public void removeCookieValue(String name);
043    }