/* * $Header$ * $Revision: 3526 $ * $Date: 2005-06-06 17:50:03 +0000 (Mon, 06 Jun 2005) $ * * ==================================================================== * *  Copyright 2002-2004 The Apache Software Foundation * *  Licensed 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. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation.  For more * information on the Apache Software Foundation, please see * <http://www.apache.org/>. * */package org.apache.commons.httpclient.cookie;import java.util.Collection;import java.util.SortedMap;import org.apache.commons.httpclient.Header;import org.apache.commons.httpclient.NameValuePair;import org.apache.commons.httpclient.Cookie;/** * Defines the cookie management specification. * <p>Cookie management specification must define * <ul> *   <li> rules of parsing "Set-Cookie" header *   <li> rules of validation of parsed cookies *   <li>  formatting of "Cookie" header  * </ul> * for a given host, port and path of origin *  * @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a> * @author <a href="mailto:jsdever@apache.org">Jeff Dever</a> * * @since 2.0 */public interface CookieSpec {        /** Path delimiter */    static final String PATH_DELIM = "/";    /** Path delimiting charachter */    static final char PATH_DELIM_CHAR = PATH_DELIM.charAt(0);    /**      * Parse the <tt>"Set-Cookie"</tt> header value into Cookie array.      *      * @param host the host which sent the <tt>Set-Cookie</tt> header      * @param port the port which sent the <tt>Set-Cookie</tt> header      * @param path the path which sent the <tt>Set-Cookie</tt> header      * @param secure <tt>true</tt> when the <tt>Set-Cookie</tt> header       *  was received over secure conection      * @param header the <tt>Set-Cookie</tt> received from the server      * @return an array of <tt>Cookie</tt>s parsed from the Set-Cookie value      * @throws MalformedCookieException if an exception occurs during parsing      * @throws IllegalArgumentException if an input parameter is illegal      */    Cookie[] parse(String host, int port, String path, boolean secure,      final String header)      throws MalformedCookieException, IllegalArgumentException;    /**      * Parse the <tt>"Set-Cookie"</tt> Header into an array of Cookies.      *      * @param host the host which sent the <tt>Set-Cookie</tt> header      * @param port the port which sent the <tt>Set-Cookie</tt> header      * @param path the path which sent the <tt>Set-Cookie</tt> header      * @param secure <tt>true</tt> when the <tt>Set-Cookie</tt> header       *  was received over secure conection      * @param header the <tt>Set-Cookie</tt> received from the server      * @return an array of <tt>Cookie</tt>s parsed from the header      * @throws MalformedCookieException if an exception occurs during parsing      * @throws IllegalArgumentException if an input parameter is illegal      */    Cookie[] parse(String host, int port, String path, boolean secure,       final Header header)      throws MalformedCookieException, IllegalArgumentException;    /**      * Parse the cookie attribute and update the corresponsing Cookie       *  properties.      *      * @param attribute cookie attribute from the <tt>Set-Cookie</tt>      * @param cookie the to be updated      * @throws MalformedCookieException if an exception occurs during parsing      * @throws IllegalArgumentException if an input parameter is illegal      */    void parseAttribute(NameValuePair attribute, Cookie cookie)      throws MalformedCookieException, IllegalArgumentException;    /**      * Validate the cookie according to validation rules defined by the       *  cookie specification.      *      * @param host the host from which the {@link Cookie} was received      * @param port the port from which the {@link Cookie} was received      * @param path the path from which the {@link Cookie} was received      * @param secure <tt>true</tt> when the {@link Cookie} was received       *  using a secure connection      * @param cookie the Cookie to validate      * @throws MalformedCookieException if the cookie is invalid      * @throws IllegalArgumentException if an input parameter is illegal      */    void validate(String host, int port, String path, boolean secure,       final Cookie cookie)       throws MalformedCookieException, IllegalArgumentException;            /**     * Sets the {@link Collection} of date patterns used for parsing. The String patterns must be      * compatible with {@link java.text.SimpleDateFormat}.     *     * @param datepatterns collection of date patterns     */    void setValidDateFormats(Collection datepatterns);        /**     * Returns the {@link Collection} of date patterns used for parsing. The String patterns are compatible      * with the {@link java.text.SimpleDateFormat}.     *     * @return collection of date patterns     */    Collection getValidDateFormats();        /**     * Determines if a Cookie matches a location.     *     * @param host the host to which the request is being submitted     * @param port the port to which the request is being submitted     * @param path the path to which the request is being submitted     * @param secure <tt>true</tt> if the request is using a secure connection     * @param cookie the Cookie to be matched     *     * @return <tt>true</tt> if the cookie should be submitted with a request      *  with given attributes, <tt>false</tt> otherwise.     */    boolean match(String host, int port, String path, boolean secure,        final Cookie cookie);    /**     * Determines which of an array of Cookies matches a location.     *     * @param host the host to which the request is being submitted     * @param port the port to which the request is being submitted      *  (currenlty ignored)     * @param path the path to which the request is being submitted     * @param secure <tt>true</tt> if the request is using a secure protocol     * @param cookies an array of <tt>Cookie</tt>s to be matched     *     * @return <tt>true</tt> if the cookie should be submitted with a request      *  with given attributes, <tt>false</tt> otherwise.     *  // BEGIN IA CHANGES     * @deprecated use match(String, int, String, boolean, SortedMap)// END IA CHANGES     */    Cookie[] match(String host, int port, String path, boolean secure,         final Cookie cookies[]);// BEGIN IA CHANGES    /**     * Determines which of an array of Cookies matches a location.     *     * If the SortedMap comes from an HttpState and is not itself     * thread-safe, it may be necessary to synchronize on the HttpState     * instance to protect against concurrent modification.      *     * @param host the host to which the request is being submitted     * @param port the port to which the request is being submitted      *  (currenlty ignored)     * @param path the path to which the request is being submitted     * @param secure <tt>true</tt> if the request is using a secure protocol     * @param cookies SortedMap of <tt>Cookie</tt>s to be matched     *     * @return <tt>true</tt> if the cookie should be submitted with a request      *  with given attributes, <tt>false</tt> otherwise.     */    Cookie[] match(String domain, int port, String path, boolean secure, SortedMap cookiesMap);// END IA CHANGES    /**     * Performs domain-match as defined by the cookie specification.     * @param host The target host.     * @param domain The cookie domain attribute.     * @return true if the specified host matches the given domain.     *      * @since 3.0     */    boolean domainMatch(String host, String domain);    /**     * Performs path-match as defined by the cookie specification.     * @param path The target path.     * @param topmostPath The cookie path attribute.     * @return true if the paths match     *      * @since 3.0     */    boolean pathMatch(String path, String topmostPath);    /**     * Create a <tt>"Cookie"</tt> header value for an array of cookies.     *     * @param cookie the cookie to be formatted as string     * @return a string suitable for sending in a <tt>"Cookie"</tt> header.     */    String formatCookie(Cookie cookie);    /**     * Create a <tt>"Cookie"</tt> header value for an array of cookies.     *     * @param cookies the Cookies to be formatted     * @return a string suitable for sending in a Cookie header.     * @throws IllegalArgumentException if an input parameter is illegal     */    String formatCookies(Cookie[] cookies) throws IllegalArgumentException;        /**     * Create a <tt>"Cookie"</tt> Header for an array of Cookies.     *     * @param cookies the Cookies format into a Cookie header     * @return a Header for the given Cookies.     * @throws IllegalArgumentException if an input parameter is illegal     */    Header formatCookieHeader(Cookie[] cookies) throws IllegalArgumentException;    /**     * Create a <tt>"Cookie"</tt> Header for single Cookie.     *     * @param cookie the Cookie format as a <tt>Cookie</tt> header     * @return a Cookie header.     * @throws IllegalArgumentException if an input parameter is illegal     */    Header formatCookieHeader(Cookie cookie) throws IllegalArgumentException;}