com.aspc.remote.util.misc.internal

Class HttpCookieMgr

java.lang.Object

com.aspc.remote.util.misc.internal.HttpCookieMgr

public final class HttpCookieMgr
extends java.lang.Object

HttpCookieMgr - utility class for handling cookies for Http calls
THREAD MODE: SINGLE-THREADED

Since:

7 September 2006

Author:

Jason McGrath

Constructor Summary

Constructors

Constructor and Description
HttpCookieMgr() Constructor Sets the default timezone and sets up a store for the cookie values

Method Summary

Modifier and Type	Method and Description
void	addCookie(java.lang.String host, java.lang.String cookieName, java.lang.String paramValue) Sets the value of a cookie
void	addCookie(java.lang.String host, java.lang.String cookieName, java.lang.String paramName, java.lang.String paramValue) Sets the value of a cookie parameter
void	applyCookies(java.net.URLConnection conn) Prior to opening a URLConnection, calling this method will set all unexpired cookies that match the path or subpaths for thi underlying URL The connection MUST NOT have been opened or an IOException will be thrown.
java.lang.String	getCookie(java.lang.String host, java.lang.String cookieName) Retrieves the value of the cookie
void	retrieveCookies(java.net.URLConnection conn) Retrieves and stores cookies returned by the host on the other side of the the open java.net.URLConnection.
void	setTimeZone(java.util.TimeZone tz) Sets the timezone used when comparing if cookies have expired
java.lang.String	toString() Returns a string representation of stored cookies organized by domain.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpCookieMgr

public HttpCookieMgr()

Constructor Sets the default timezone and sets up a store for the cookie values

Method Detail

setTimeZone

public void setTimeZone(java.util.TimeZone tz)

Sets the timezone used when comparing if cookies have expired

Parameters:

tz - - timezone

retrieveCookies

public void retrieveCookies(java.net.URLConnection conn)
                     throws java.io.IOException

Retrieves and stores cookies returned by the host on the other side of the the open java.net.URLConnection. The connection MUST have been opened using the connect() method or a IOException will be thrown.

Parameters:

conn - a java.net.URLConnection - must be open, or IOException will be thrown

Throws:

java.io.IOException - Thrown if conn is not open.

getCookie

public java.lang.String getCookie(java.lang.String host,
                                  java.lang.String cookieName)

Retrieves the value of the cookie

Parameters:

host - - host that the cookie is related to

cookieName - - the name of the cookie

Returns:

- the value of the specified cookie or null if none was found

addCookie

public void addCookie(java.lang.String host,
                      java.lang.String cookieName,
                      java.lang.String paramValue)

Sets the value of a cookie

Parameters:

host - - the host that the cookie is related to

cookieName - - the name of the cookie

paramValue - - the value to set the cookie to

addCookie

public void addCookie(java.lang.String host,
                      java.lang.String cookieName,
                      java.lang.String paramName,
                      java.lang.String paramValue)

Sets the value of a cookie parameter

Parameters:

host - - the host that the cookie is related to

cookieName - - the name of the cookie

paramName - - parameter name

paramValue - - the value to set the cookie to

applyCookies

public void applyCookies(java.net.URLConnection conn)
                  throws java.io.IOException

Prior to opening a URLConnection, calling this method will set all unexpired cookies that match the path or subpaths for thi underlying URL The connection MUST NOT have been opened or an IOException will be thrown.

Parameters:

conn - a java.net.URLConnection - must NOT be open, or IOException will be thrown

Throws:

java.io.IOException - Thrown if conn has already been opened.

toString

@CheckReturnValue
 @Nonnull
public java.lang.String toString()

Returns a string representation of stored cookies organized by domain.

Overrides:

toString in class java.lang.Object

Returns:

the string representation