net.officefloor.plugin.web.http.cookie

Class HttpCookieUtil

java.lang.Object

net.officefloor.plugin.web.http.cookie.HttpCookieUtil

public class HttpCookieUtil
extends Object

Utility methods for working with HttpCookie instances from the HttpRequest to the HttpResponse.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
static HttpHeader	addHttpCookie(HttpCookie cookie, HttpResponse response) Adds the HttpCookie to the HttpResponse.
static HttpCookie	extractHttpCookie(String cookieName, HttpRequest request) Extracts a specific HttpCookie from the HttpRequest.
static List<HttpCookie>	extractHttpCookies(HttpRequest request) Extracts all the HttpCookie instances from the HttpRequest.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

extractHttpCookies

public static List<HttpCookie> extractHttpCookies(HttpRequest request)

Extracts all the HttpCookie instances from the HttpRequest.

Parameters:

request - HttpRequest.

Returns:

HttpCookie instances on the HttpRequest.

extractHttpCookie

public static HttpCookie extractHttpCookie(String cookieName,
                                           HttpRequest request)

Extracts a specific HttpCookie from the HttpRequest.

Parameters:

cookieName - Name of the HttpCookie to retrieve from the HttpRequest.

request - HttpRequest.

Returns:

HttpCookie extracted from the HttpRequest or null if no HttpCookie by the name on the HttpRequest.

addHttpCookie

public static HttpHeader addHttpCookie(HttpCookie cookie,
                                       HttpResponse response)

Adds the HttpCookie to the HttpResponse.

Parameters:

cookie - HttpCookie to be added.

response - HttpResponse to have the HttpCookie added to it as a HttpHeader.

Returns:

HttpHeader added to the HttpResponse containing the HttpCookie.