1069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/* 2069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/cookie/RFC2965PortAttributeHandler.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 590695 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2007-10-31 07:55:41 -0700 (Wed, 31 Oct 2007) $ 5069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 6069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 7069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one 8069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * or more contributor license agreements. See the NOTICE file 9069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * distributed with this work for additional information 10069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * regarding copyright ownership. The ASF licenses this file 11069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * to you under the Apache License, Version 2.0 (the 12069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * "License"); you may not use this file except in compliance 13069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * with the License. You may obtain a copy of the License at 14069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 15069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 16069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 17069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Unless required by applicable law or agreed to in writing, 18069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * software distributed under the License is distributed on an 19069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 20069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * KIND, either express or implied. See the License for the 21069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * specific language governing permissions and limitations 22069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * under the License. 23069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 24069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 25069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This software consists of voluntary contributions made by many 26069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * individuals on behalf of the Apache Software Foundation. For more 27069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * information on the Apache Software Foundation, please see 28069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <http://www.apache.org/>. 29069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 30069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 31069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 32069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpackage org.apache.http.impl.cookie; 33069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 34069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.StringTokenizer; 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.cookie.ClientCookie; 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.cookie.Cookie; 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.cookie.CookieAttributeHandler; 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.cookie.CookieOrigin; 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.cookie.MalformedCookieException; 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.cookie.SetCookie; 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.cookie.SetCookie2; 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <tt>"Port"</tt> cookie attribute handler for RFC 2965 cookie spec. 46d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * 47d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * @deprecated Please use {@link java.net.URL#openConnection} instead. 48d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a> 49d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * for further details. 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 51d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath@Deprecated 52069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic class RFC2965PortAttributeHandler implements CookieAttributeHandler { 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 54069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public RFC2965PortAttributeHandler() { 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project super(); 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Parses the given Port attribute value (e.g. "8000,8001,8002") 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * into an array of ports. 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param portValue port attribute value 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return parsed array of ports 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws MalformedCookieException if there is a problem in 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * parsing due to invalid portValue. 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private static int[] parsePortAttribute(final String portValue) 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throws MalformedCookieException { 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project StringTokenizer st = new StringTokenizer(portValue, ","); 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project int[] ports = new int[st.countTokens()]; 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project try { 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project int i = 0; 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project while(st.hasMoreTokens()) { 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ports[i] = Integer.parseInt(st.nextToken().trim()); 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (ports[i] < 0) { 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new MalformedCookieException ("Invalid Port attribute."); 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ++i; 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } catch (NumberFormatException e) { 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new MalformedCookieException ("Invalid Port " 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project + "attribute: " + e.getMessage()); 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return ports; 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns <tt>true</tt> if the given port exists in the given 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ports list. 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param port port of host where cookie was received from or being sent to. 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param ports port list 93069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return true returns <tt>true</tt> if the given port exists in 94069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * the given ports list; <tt>false</tt> otherwise. 95069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 96069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private static boolean portMatch(int port, int[] ports) { 97069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project boolean portInList = false; 98069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project for (int i = 0, len = ports.length; i < len; i++) { 99069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (port == ports[i]) { 100069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project portInList = true; 101069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project break; 102069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 103069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 104069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return portInList; 105069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 106069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 107069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 108069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Parse cookie port attribute. 109069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 110069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public void parse(final SetCookie cookie, final String portValue) 111069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throws MalformedCookieException { 112069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (cookie == null) { 113069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("Cookie may not be null"); 114069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 115069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (cookie instanceof SetCookie2) { 116069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project SetCookie2 cookie2 = (SetCookie2) cookie; 117069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (portValue != null && portValue.trim().length() > 0) { 118069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project int[] ports = parsePortAttribute(portValue); 119069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project cookie2.setPorts(ports); 120069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 121069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 122069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 123069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 124069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 125069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Validate cookie port attribute. If the Port attribute was specified 126069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * in header, the request port must be in cookie's port list. 127069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 128069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public void validate(final Cookie cookie, final CookieOrigin origin) 129069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throws MalformedCookieException { 130069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (cookie == null) { 131069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("Cookie may not be null"); 132069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 133069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (origin == null) { 134069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("Cookie origin may not be null"); 135069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 136069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project int port = origin.getPort(); 137069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (cookie instanceof ClientCookie 138069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project && ((ClientCookie) cookie).containsAttribute(ClientCookie.PORT_ATTR)) { 139069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (!portMatch(port, cookie.getPorts())) { 140069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new MalformedCookieException( 141069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project "Port attribute violates RFC 2965: " 142069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project + "Request port not found in cookie's port list."); 143069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 144069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 145069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 146069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 147069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 148069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Match cookie port attribute. If the Port attribute is not specified 149069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * in header, the cookie can be sent to any port. Otherwise, the request port 150069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * must be in the cookie's port list. 151069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 152069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public boolean match(final Cookie cookie, final CookieOrigin origin) { 153069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (cookie == null) { 154069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("Cookie may not be null"); 155069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 156069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (origin == null) { 157069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("Cookie origin may not be null"); 158069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 159069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project int port = origin.getPort(); 160069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (cookie instanceof ClientCookie 161069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project && ((ClientCookie) cookie).containsAttribute(ClientCookie.PORT_ATTR)) { 162069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (cookie.getPorts() == null) { 163069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // Invalid cookie state: port not specified 164069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return false; 165069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 166069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (!portMatch(port, cookie.getPorts())) { 167069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return false; 168069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 169069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 170069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return true; 171069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 172069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 173069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} 174