/*
* ====================================================================
* 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
* <http://www.apache.org/>.
*
*/
package org.apache.http.impl.cookie;
import java.util.StringTokenizer;
import org.apache.http.annotation.Contract;
import org.apache.http.annotation.ThreadingBehavior;
import org.apache.http.cookie.ClientCookie;
import org.apache.http.cookie.CommonCookieAttributeHandler;
import org.apache.http.cookie.Cookie;
import org.apache.http.cookie.CookieOrigin;
import org.apache.http.cookie.CookieRestrictionViolationException;
import org.apache.http.cookie.MalformedCookieException;
import org.apache.http.cookie.SetCookie;
import org.apache.http.cookie.SetCookie2;
import org.apache.http.util.Args;
"Port" cookie attribute handler for RFC 2965 cookie spec. Since: 4.0
/**
* {@code "Port"} cookie attribute handler for RFC 2965 cookie spec.
*
* @since 4.0
*/
@Contract(threading = ThreadingBehavior.IMMUTABLE)
public class RFC2965PortAttributeHandler implements CommonCookieAttributeHandler {
public RFC2965PortAttributeHandler() {
super();
}
Parses the given Port attribute value (e.g. "8000,8001,8002")
into an array of ports.
Params: - portValue – port attribute value
Throws: - MalformedCookieException – if there is a problem in
parsing due to invalid portValue.
Returns: parsed array of ports
/**
* Parses the given Port attribute value (e.g. "8000,8001,8002")
* into an array of ports.
*
* @param portValue port attribute value
* @return parsed array of ports
* @throws MalformedCookieException if there is a problem in
* parsing due to invalid portValue.
*/
private static int[] parsePortAttribute(final String portValue)
throws MalformedCookieException {
final StringTokenizer st = new StringTokenizer(portValue, ",");
final int[] ports = new int[st.countTokens()];
try {
int i = 0;
while(st.hasMoreTokens()) {
ports[i] = Integer.parseInt(st.nextToken().trim());
if (ports[i] < 0) {
throw new MalformedCookieException ("Invalid Port attribute.");
}
++i;
}
} catch (final NumberFormatException e) {
throw new MalformedCookieException ("Invalid Port "
+ "attribute: " + e.getMessage());
}
return ports;
}
Returns true if the given port exists in the given ports list. Params: - port – port of host where cookie was received from or being sent to.
- ports – port list
Returns: true returns true if the given port exists in the given ports list; false otherwise.
/**
* Returns {@code true} if the given port exists in the given
* ports list.
*
* @param port port of host where cookie was received from or being sent to.
* @param ports port list
* @return true returns {@code true} if the given port exists in
* the given ports list; {@code false} otherwise.
*/
private static boolean portMatch(final int port, final int[] ports) {
boolean portInList = false;
for (final int port2 : ports) {
if (port == port2) {
portInList = true;
break;
}
}
return portInList;
}
Parse cookie port attribute.
/**
* Parse cookie port attribute.
*/
@Override
public void parse(final SetCookie cookie, final String portValue)
throws MalformedCookieException {
Args.notNull(cookie, "Cookie");
if (cookie instanceof SetCookie2) {
final SetCookie2 cookie2 = (SetCookie2) cookie;
if (portValue != null && !portValue.trim().isEmpty()) {
final int[] ports = parsePortAttribute(portValue);
cookie2.setPorts(ports);
}
}
}
Validate cookie port attribute. If the Port attribute was specified
in header, the request port must be in cookie's port list.
/**
* Validate cookie port attribute. If the Port attribute was specified
* in header, the request port must be in cookie's port list.
*/
@Override
public void validate(final Cookie cookie, final CookieOrigin origin)
throws MalformedCookieException {
Args.notNull(cookie, "Cookie");
Args.notNull(origin, "Cookie origin");
final int port = origin.getPort();
if (cookie instanceof ClientCookie
&& ((ClientCookie) cookie).containsAttribute(ClientCookie.PORT_ATTR)) {
if (!portMatch(port, cookie.getPorts())) {
throw new CookieRestrictionViolationException(
"Port attribute violates RFC 2965: "
+ "Request port not found in cookie's port list.");
}
}
}
Match cookie port attribute. If the Port attribute is not specified
in header, the cookie can be sent to any port. Otherwise, the request port
must be in the cookie's port list.
/**
* Match cookie port attribute. If the Port attribute is not specified
* in header, the cookie can be sent to any port. Otherwise, the request port
* must be in the cookie's port list.
*/
@Override
public boolean match(final Cookie cookie, final CookieOrigin origin) {
Args.notNull(cookie, "Cookie");
Args.notNull(origin, "Cookie origin");
final int port = origin.getPort();
if (cookie instanceof ClientCookie
&& ((ClientCookie) cookie).containsAttribute(ClientCookie.PORT_ATTR)) {
if (cookie.getPorts() == null) {
// Invalid cookie state: port not specified
return false;
}
if (!portMatch(port, cookie.getPorts())) {
return false;
}
}
return true;
}
@Override
public String getAttributeName() {
return ClientCookie.PORT_ATTR;
}
}