/**
* Copyright 2005-2011 Noelios Technologies.
*
* The contents of this file are subject to the terms of one of the following
* open source licenses: LGPL 3.0 or LGPL 2.1 or CDDL 1.0 or EPL 1.0 (the
* "Licenses"). You can select the license that you prefer but you may not use
* this file except in compliance with one of these Licenses.
*
* You can obtain a copy of the LGPL 3.0 license at
* http://www.opensource.org/licenses/lgpl-3.0.html
*
* You can obtain a copy of the LGPL 2.1 license at
* http://www.opensource.org/licenses/lgpl-2.1.php
*
* You can obtain a copy of the CDDL 1.0 license at
* http://www.opensource.org/licenses/cddl1.php
*
* You can obtain a copy of the EPL 1.0 license at
* http://www.opensource.org/licenses/eclipse-1.0.php
*
* See the Licenses for the specific language governing permissions and
* limitations under the Licenses.
*
* Alternatively, you can obtain a royalty free commercial license with less
* limitations, transferable or non-transferable, directly at
* http://www.noelios.com/products/restlet-engine
*
* Restlet is a registered trademark of Noelios Technologies.
*/
package org.restlet.client.engine.header;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.restlet.client.data.Cookie;
/**
* Cookie header writer.
*
* @author Jerome Louvel
*/
public class CookieWriter extends HeaderWriter<Cookie> {
/**
* Gets the cookies whose name is a key in the given map. If a matching
* cookie is found, its value is put in the map.
*
* @param source
* The source list of cookies.
* @param destination
* The cookies map controlling the reading.
*/
public static void getCookies(List<Cookie> source,
Map<String, Cookie> destination) {
Cookie cookie;
for (final Iterator<Cookie> iter = source.iterator(); iter.hasNext();) {
cookie = iter.next();
if (destination.containsKey(cookie.getName())) {
destination.put(cookie.getName(), cookie);
}
}
}
/**
* Writes a cookie.
*
* @param cookie
* The cookie to format.
* @return The formatted cookie.
* @throws IllegalArgumentException
* If the Cookie contains illegal values.
*/
public static String write(Cookie cookie) throws IllegalArgumentException {
return new CookieWriter().append(cookie).toString();
}
/**
* Writes a cookie.
*
* @param cookies
* The cookies to format.
* @return The formatted cookie.
*/
public static String write(List<Cookie> cookies) {
return new CookieWriter().append(cookies).toString();
}
@Override
public CookieWriter append(Cookie cookie) throws IllegalArgumentException {
String name = cookie.getName();
String value = cookie.getValue();
int version = cookie.getVersion();
if ((name == null) || (name.length() == 0)) {
throw new IllegalArgumentException(
"Can't write cookie. Invalid name detected");
}
appendValue(name, 0).append('=');
// Append the value
if ((value != null) && (value.length() > 0)) {
appendValue(value, version);
}
if (version > 0) {
// Append the path
String path = cookie.getPath();
if ((path != null) && (path.length() > 0)) {
append("; $Path=");
appendQuotedString(path);
}
// Append the domain
String domain = cookie.getDomain();
if ((domain != null) && (domain.length() > 0)) {
append("; $Domain=");
appendQuotedString(domain);
}
}
return this;
}
/**
* Appends a list of cookies as an HTTP header.
*
* @param cookies
* The list of cookies to format.
* @return This writer.
*/
public CookieWriter append(List<Cookie> cookies) {
if ((cookies != null) && !cookies.isEmpty()) {
Cookie cookie;
for (int i = 0; i < cookies.size(); i++) {
cookie = cookies.get(i);
if (i == 0) {
if (cookie.getVersion() > 0) {
append("$Version=\"").append(cookie.getVersion())
.append("\"; ");
}
} else {
append("; ");
}
append(cookie);
}
}
return this;
}
/**
* Appends a source string as an HTTP comment.
*
* @param value
* The source string to format.
* @param version
* The cookie version.
* @return This writer.
*/
public CookieWriter appendValue(String value, int version) {
if (version == 0) {
append(value.toString());
} else {
appendQuotedString(value);
}
return this;
}
}