org.apache.http.cookie.CookieSpec Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of httpclient Show documentation
Apache HttpComponents Client
There is a newer version: 4.5.14
/*
 * ====================================================================
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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
 * .
 *
 */

package org.apache.http.cookie;

import java.util.List;

import org.apache.http.Header;
import org.apache.http.annotation.Obsolete;

/**
 * Defines the cookie management specification.
 * Cookie management specification must define
 * 

 *    rules of parsing "Set-Cookie" header
 *   
 rules of validation of parsed cookies
 *   
  formatting of "Cookie" header
 * 
 * for a given host, port and path of origin
 * 
 * Please do not use methods marked as @Obsolete. They have been rendered
 * obsolete by RFC 6265.
 *
 * @since 4.0
 */
public interface CookieSpec {

    /**
     * Returns version of the state management this cookie specification
     * conforms to.
     *
     * @return version of the state management specification
     */
    @Obsolete
    int getVersion();

    /**
      * Parse the {@code "Set-Cookie"} Header into an array of Cookies.
      *
      * 
This method will not perform the validation of the resultant
      * {@link Cookie}s
      *
      * @see #validate
      *
      * @param header the {@code Set-Cookie} received from the server
      * @param origin details of the cookie origin
      * @return an array of {@code Cookie}s parsed from the header
      * @throws MalformedCookieException if an exception occurs during parsing
      */
    List parse(Header header, CookieOrigin origin) throws MalformedCookieException;

    /**
      * Validate the cookie according to validation rules defined by the
      *  cookie specification.
      *
      * @param cookie the Cookie to validate
      * @param origin details of the cookie origin
      * @throws MalformedCookieException if the cookie is invalid
      */
    void validate(Cookie cookie, CookieOrigin origin) throws MalformedCookieException;

    /**
     * Determines if a Cookie matches the target location.
     *
     * @param cookie the Cookie to be matched
     * @param origin the target to test against
     *
     * @return {@code true} if the cookie should be submitted with a request
     *  with given attributes, {@code false} otherwise.
     */
    boolean match(Cookie cookie, CookieOrigin origin);

    /**
     * Create {@code "Cookie"} headers 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
     */
    List formatCookies(List cookies);

    /**
     * Returns a request header identifying what version of the state management
     * specification is understood. May be {@code null} if the cookie
     * specification does not support {@code Cookie2} header.
     */
    @Obsolete
    Header getVersionHeader();

}