CookieExtensions.java

/**
 * Copyright (C) 2010 Asterios Raptis
 *
 * Licensed 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 de.alpharogroup.wicket.base.util;

import javax.servlet.http.Cookie;

import org.apache.wicket.request.cycle.RequestCycle;
import org.apache.wicket.request.http.WebRequest;
import org.apache.wicket.request.http.WebResponse;

/**
 * The Class CookieExtensions provides some methods to create, add, get or clear a cookie.
 */
public final class CookieExtensions
{

	/**
	 * Adds the given cookie.
	 *
	 * @param cookie
	 *            the cookie
	 */
	public static void addCookie(final Cookie cookie)
	{
		((WebResponse)RequestCycle.get().getResponse()).addCookie(cookie);
	}

	/**
	 * Clears the given cookie.
	 *
	 * @param cookie
	 *            the cookie to clear.
	 */
	public static void clearCookie(final Cookie cookie)
	{
		((WebResponse)RequestCycle.get().getResponse()).clearCookie(cookie);
	}

	/**
	 * Gets the cookie form the given name.
	 *
	 * @param name
	 *            the name
	 * @return the cookie
	 */
	public static Cookie getCookie(final String name)
	{
		return ((WebRequest)RequestCycle.get().getRequest()).getCookie(name);
	}

	/**
	 * Creates a new cookie.
	 *
	 * @param name
	 *            the name
	 * @param value
	 *            the value
	 * @param purpose
	 *            the purpose
	 * @param domain
	 *            the domain
	 * @param maxAge
	 *            the max age
	 * @param path
	 *            the path
	 * @param secure
	 *            the secure
	 * @return the cookie
	 */
	public static Cookie newCookie(final String name, final String value, final String purpose,
		final String domain, final int maxAge, final String path, final boolean secure)
	{
		final Cookie cookie = new Cookie(name, value);
		cookie.setComment(purpose);
		cookie.setDomain(domain);
		cookie.setMaxAge(maxAge);
		cookie.setPath(path);

		return cookie;
	}
}