com.sun.webui.jsf.util.CookieUtils Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the license at
* https://woodstock.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at https://woodstock.dev.java.net/public/CDDLv1.0.html.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* you own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Copyright 2010 Sun Microsystems, Inc. All rights reserved.
*/
package com.sun.webui.jsf.util;
import javax.faces.context.FacesContext;
import javax.servlet.http.Cookie;
/**
* Methods for working with cookies.
*
* @author Ken Paulsen ([email protected])
*/
public class CookieUtils {
/**
* Gets the requested cookie name. This method will ensure invalid
* characters are not used in the name. The cooresponding
* setCookieValue call should be used to ensure proper
* setting / retrieval of your cookie. (NOTE: there is a JS version
* of these methods as well.)
*/
public static Cookie getCookieValue(FacesContext context, String name) {
name = CookieUtils.getValidCookieName(name);
return (Cookie) context.getExternalContext().getRequestCookieMap().get(name);
}
/**
* Sets the specified cookie name / value. This method will ensure
* invalid characters are not used in the name. The cooresponding
* getCookieValue call should be used to ensure proper
* setting / retrieval of your cookie. (NOTE: there is a JS version
* of these methods as well.)
*/
public static void setCookieValue(FacesContext context, String name, String value) {
// FIXME: not quite implemented...
name = CookieUtils.getValidCookieName(name);
context.getExternalContext().getRequestCookieMap().put(name, value);
}
/**
* Ensure we use a RFC 2109 compliant cookie name.
*/
public static String getValidCookieName(String name) {
for (char ch : badCookieChars) {
name = name.replace(ch, '_');
}
return name;
}
// Characters not allowed to be part of a cookie name (RFC 2109)
private static final char badCookieChars[] = {
'(', ')', '<', '>', '@', ',', ';', ':', '\\',
'\'', '/', '[', ']', '?', '=', '{', '}', ' ', '\t'};
}