Namespace: OpenEdge.Net.HTTP
Class 
CookieJarDecorator
Parent classes:
Progress.Lang.Object
OpenEdge.Net.HTTP.CookieJarDecorator

Inherits: Progress.Lang.Object
Implements: OpenEdge.Net.HTTP.ICookieJar
ABSTRACT

Copyright (c) 2015 by Progress Software Corporation. All rights reserved.
File:CookieJarDecorator
Purpose:Decorator class for decoracting/customising Http Clients
without requiring inheritance. This allows us to construct
more complex clients (say with cookies, no proxy OR with cookies,
with proxy) without having to have individual types for all the
combinations
Author(s):pjudge
Created:Wed Jan 21 09:26:18 EST 2015
Notes:* There's a decent description of Decorator pattern in Wikipedia
at http://en.wikipedia.org/wiki/Decorator_pattern
For instance, adding support for proxies, or cookies




Method Summary
Options Name Purpose
# AddCookie (character, character, Cookie) /** Adds a cookie to the jar, for a given domain/path. This is required in cases where the @param character The domain to which this cookie applies @param character The path to which this cookie applies @param Cookie The cookie to add */
# AddCookie (Cookie) /** Adds a cookie to the jar. @param Cookie The cookie to add */
# AddCookies (Cookie[]) /** Adds a collection of cookies to the jar. @param Cookie The cookies to add */
# ClearPersistentCookies () /** Clears all persistent cookies */
# ClearSessionCookies () /** Removes all session (non-persistent) cookies from the jar */
# INTEGER GetCookies (URI, Cookie[]) /** Returns the cookies germane to the specified URI. @param URI The host/URI for which to return the cookies. @param Cookie[] Output array of the cookies @return integer The number of cookies returned */
# LOGICAL RemoveCookie (Cookie) /** Removes a cookie from the jar. @param Cookie The cookie to remove @return logical True if the cookie was deleted. */

Constructor Summary
Options Name Purpose
# CookieJarDecorator (ICookieJar)

Property Summary
Options Name Purpose
# CHARACTER CookieJarPath /** The location in which cookies are persisted */
OpenEdge.Net.HTTP.ICookieJar DecoratedCookieJar /* the decorated client. this can be a decoration or an actual http client */


Method Detail
Top

PROTECTED AddCookie (character, character, Cookie)
Purpose: Adds a cookie to the jar, for a given domain/path. This is
required in cases where the
Parameters:
pcDomain CHARACTER
pcPath CHARACTER
poCookie OpenEdge.Net.HTTP.Cookie
Top

PROTECTED AddCookie (Cookie)
Purpose: Adds a cookie to the jar.
Parameters:
poCookie OpenEdge.Net.HTTP.Cookie
Top

PROTECTED AddCookies (Cookie[])
Purpose: Adds a collection of cookies to the jar.
Parameters:
poCookies OpenEdge.Net.HTTP.Cookie
Top

PROTECTED ClearPersistentCookies ()
Purpose: Clears all persistent cookies
Top

PROTECTED ClearSessionCookies ()
Purpose: Removes all session (non-persistent) cookies from the jar
Top

PROTECTED INTEGER GetCookies (URI, Cookie[])
Purpose: Returns the cookies germane to the specified URI.
Parameters:
poUri OpenEdge.Net.URI
poCookies OpenEdge.Net.HTTP.Cookie
Returns INTEGER
integer The number of cookies returned
Top

PROTECTED LOGICAL RemoveCookie (Cookie)
Purpose: Removes a cookie from the jar.
Parameters:
poCookie OpenEdge.Net.HTTP.Cookie
Returns LOGICAL
logical True if the cookie was deleted.


Constructor Detail
Top

PROTECTED CookieJarDecorator (ICookieJar)
Parameters:
poCookieJar OpenEdge.Net.HTTP.ICookieJar


Property Detail
Top

PROTECTED CHARACTER CookieJarPath
Purpose: The location in which cookies are persisted
Returns CHARACTER
Top

OpenEdge.Net.HTTP.ICookieJar DecoratedCookieJar
/* the decorated client. this can be a decoration or an actual http client
Returns OpenEdge.Net.HTTP.ICookieJar


10.27.2015 12:36:36