org.apache.cxf.transport.http.Cookie Maven / Gradle / Ivy
/**
* 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.
*/
package org.apache.cxf.transport.http;
/**
* Container for HTTP cookies used to track
* session state.
*
*/
public class Cookie {
public static final String DISCARD_ATTRIBUTE = "discard";
public static final String MAX_AGE_ATTRIBUTE = "max-age";
public static final String PATH_ATTRIBUTE = "path";
/**
* The name of this cookie
*/
private String name;
/**
* The value of this cookie
*/
private String value;
/**
* The path on the server where this cookie is valid.
* Used to distinguish between identical cookies from different contexts.
*/
private String path;
/**
* The maximum age of the cookie
*/
private int maxAge = -1;
/**
* Create a new cookie with the supplied name/value pair
* @param name
* @param value
*/
public Cookie(String name, String value) {
this.name = name;
this.value = value;
}
/**
* Get the name of this cookie
* @return cookie name
*/
public String getName() {
return this.name;
}
/**
* Change the value of this cookie
* @param value
*/
public void setValue(String value) {
this.value = value;
}
/**
* Get the value of this cookie
* @return cookie value
*/
public String getValue() {
return this.value;
}
/**
* Set the path of this cookie
* @param path
*/
public void setPath(String path) {
this.path = path;
}
/**
* Get the path of this cookie
* @return cookie path
*/
public String getPath() {
return this.path;
}
/**
* Set the max-age of this cookie. If set to 0, it
* should be removed from the session.
* @param maxAge
*/
public void setMaxAge(int maxAge) {
this.maxAge = maxAge;
}
/**
* Get the max-age of this cookie
* @return
*/
public int getMaxAge() {
return this.maxAge;
}
/**
*
*/
@Override
public int hashCode() {
return (17 * this.name.hashCode())
+ ((this.path != null) ? 11 * this.path.hashCode() : 0);
}
/**
*
*/
@Override
public boolean equals(Object o) {
if (!(o instanceof Cookie)) {
return false;
}
Cookie c = (Cookie)o;
boolean result = this.name.equals(c.name)
&& ((this.path == null && c.path == null)
|| (this.path != null && this.path.equals(c.path)));
return result;
}
/**
* Convert a list of cookies into a string suitable for sending
* as a "Cookie:" header
* @return Cookie header text
*/
public String requestCookieHeader() {
StringBuilder b = new StringBuilder();
b.append("$Version=\"1\"");
b.append("; ").append(getName())
.append("=").append(getValue());
if (getPath() != null && getPath().length() > 0) {
b.append("; $Path=").append(getPath());
}
return b.toString();
}
}