View Javadoc

1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  
28  package org.apache.http.impl.cookie;
29  
30  import org.apache.http.annotation.Immutable;
31  import org.apache.http.cookie.ClientCookie;
32  import org.apache.http.cookie.Cookie;
33  import org.apache.http.cookie.CookieAttributeHandler;
34  import org.apache.http.cookie.CookieOrigin;
35  import org.apache.http.cookie.CookieRestrictionViolationException;
36  import org.apache.http.cookie.MalformedCookieException;
37  import org.apache.http.cookie.SetCookie;
38  import org.apache.http.cookie.SetCookie2;
39  import org.apache.http.util.Args;
40  
41  /**
42   * {@code "Version"} cookie attribute handler for RFC 2965 cookie spec.
43   *
44   * @since 4.0
45   */
46  @Immutable
47  public class RFC2965VersionAttributeHandler implements CookieAttributeHandler {
48  
49      public RFC2965VersionAttributeHandler() {
50          super();
51      }
52  
53      /**
54       * Parse cookie version attribute.
55       */
56      @Override
57      public void parse(final SetCookie cookie, final String value)
58              throws MalformedCookieException {
59          Args.notNull(cookie, "Cookie");
60          if (value == null) {
61              throw new MalformedCookieException(
62                      "Missing value for version attribute");
63          }
64          int version = -1;
65          try {
66              version = Integer.parseInt(value);
67          } catch (final NumberFormatException e) {
68              version = -1;
69          }
70          if (version < 0) {
71              throw new MalformedCookieException("Invalid cookie version.");
72          }
73          cookie.setVersion(version);
74      }
75  
76      /**
77       * validate cookie version attribute. Version attribute is REQUIRED.
78       */
79      @Override
80      public void validate(final Cookie cookie, final CookieOrigin origin)
81              throws MalformedCookieException {
82          Args.notNull(cookie, "Cookie");
83          if (cookie instanceof SetCookie2) {
84              if (cookie instanceof ClientCookie
85                      && !((ClientCookie) cookie).containsAttribute(ClientCookie.VERSION_ATTR)) {
86                  throw new CookieRestrictionViolationException(
87                          "Violates RFC 2965. Version attribute is required.");
88              }
89          }
90      }
91  
92      @Override
93      public boolean match(final Cookie cookie, final CookieOrigin origin) {
94          return true;
95      }
96  
97  }