View Javadoc

    1   /*
    2    * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//httpclient/src/java/org/apache/commons/httpclient/cookie/IgnoreCookiesSpec.java,v 1.6 2004/09/14 20:11:31 olegk Exp $
    3    * $Revision: 5562 $
    4    * $Date: 2007-11-16 00:53:10 +0000 (Fri, 16 Nov 2007) $
    5    *
    6    * ====================================================================
    7    *
    8    *  Copyright 2002-2004 The Apache Software Foundation
    9    *
    10   *  Licensed under the Apache License, Version 2.0 (the "License");
    11   *  you may not use this file except in compliance with the License.
    12   *  You may obtain a copy of the License at
    13   *
    14   *      http://www.apache.org/licenses/LICENSE-2.0
    15   *
    16   *  Unless required by applicable law or agreed to in writing, software
    17   *  distributed under the License is distributed on an "AS IS" BASIS,
    18   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    19   *  See the License for the specific language governing permissions and
    20   *  limitations under the License.
    21   * ====================================================================
    22   *
    23   * This software consists of voluntary contributions made by many
    24   * individuals on behalf of the Apache Software Foundation.  For more
    25   * information on the Apache Software Foundation, please see
    26   * <http://www.apache.org/>.
    27   *
    28   */
    29
    30  package org.apache.commons.httpclient.cookie;
    31
    32  import java.util.Collection;
    33  import java.util.SortedMap; // <- IA/HERITRIX CHANGE
    34
    35  import org.apache.commons.httpclient.Cookie;
    36  import org.apache.commons.httpclient.Header;
    37  import org.apache.commons.httpclient.NameValuePair;
    38
    39  /***
    40   * A cookie spec that does nothing.  Cookies are neither parsed, formatted nor matched.
    41   * It can be used to effectively disable cookies altogether.
    42   *
    43   * @since 3.0
    44   */
    45  public class IgnoreCookiesSpec implements CookieSpec {
    46
    47      /***
    48       *
    49       */
    50      public IgnoreCookiesSpec() {
    51          super();
    52      }
    53
    54      /***
    55       * Returns an empty {@link Cookie cookie} array.  All parameters are ignored.
    56       */
    57      public Cookie[] parse(String host, int port, String path, boolean secure, String header)
    58          throws MalformedCookieException {
    59          return new Cookie[0];
    60      }
    61
    62      /***
    63       * @return <code>null</code>
    64       */
    65      public Collection getValidDateFormats() {
    66          return null;
    67      }
    68
    69      /***
    70       * Does nothing.
    71       */
    72      public void setValidDateFormats(Collection datepatterns) {
    73      }
    74
    75      /***
    76       * @return <code>null</code>
    77       */
    78      public String formatCookie(Cookie cookie) {
    79          return null;
    80      }
    81
    82      /***
    83       * @return <code>null</code>
    84       */
    85      public Header formatCookieHeader(Cookie cookie) throws IllegalArgumentException {
    86          return null;
    87      }
    88
    89      /***
    90       * @return <code>null</code>
    91       */
    92      public Header formatCookieHeader(Cookie[] cookies) throws IllegalArgumentException {
    93          return null;
    94      }
    95
    96      /***
    97       * @return <code>null</code>
    98       */
    99      public String formatCookies(Cookie[] cookies) throws IllegalArgumentException {
    100         return null;
    101     }
    102
    103     /***
    104      * @return <code>false</code>
    105      */
    106     public boolean match(String host, int port, String path, boolean secure, Cookie cookie) {
    107         return false;
    108     }
    109
    110     /***
    111      * Returns an empty {@link Cookie cookie} array.  All parameters are ignored.
    112      */
    113     public Cookie[] match(String host, int port, String path, boolean secure, Cookie[] cookies) {
    114         return new Cookie[0];
    115     }
    116
    117     /***
    118      * Returns an empty {@link Cookie cookie} array.  All parameters are ignored.
    119      */
    120     public Cookie[] parse(String host, int port, String path, boolean secure, Header header)
    121         throws MalformedCookieException, IllegalArgumentException {
    122         return new Cookie[0];
    123     }
    124
    125     /***
    126      * Does nothing.
    127      */
    128     public void parseAttribute(NameValuePair attribute, Cookie cookie)
    129         throws MalformedCookieException, IllegalArgumentException {
    130     }
    131
    132     /***
    133      * Does nothing.
    134      */
    135     public void validate(String host, int port, String path, boolean secure, Cookie cookie)
    136         throws MalformedCookieException, IllegalArgumentException {
    137     }
    138
    139     /***
    140      * @return <code>false</code>
    141      */
    142     public boolean domainMatch(final String host, final String domain) {
    143         return false;
    144     }
    145
    146     /***
    147      * @return <code>false</code>
    148      */
    149     public boolean pathMatch(final String path, final String topmostPath) {
    150         return false;
    151     }
    152
    153 // BEGIN IA/HERITRIX ADDITION
    154     public Cookie[] match(String domain, int port, String path, boolean secure,
    155         SortedMap cookiesMap) {
    156         return new Cookie[0];
    157     }
    158 // END IA/HERITRIX CHANGE
    159 }