Namespace: OpenEdge.Net.HTTP
Type: Interface ICookieJar
Parent Classes:
Inherits: Progress.Lang.Object


Copyright (c) 2014, 2015 by Progress Software Corporation. All rights reserved.
File:ICookieJar
Purpose:Interface describing the manager of HTTP Cookies
Author(s):pjudge
Created:Wed May 21 15:19:57 EDT 2014



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. */

Property Summary
  Options Name Purpose
  CHARACTER CookieJarPath


Method Detail
Top

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

AddCookie (Cookie)

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

AddCookies (Cookie[])

Purpose: Adds a collection of cookies to the jar.
Parameters:
poCookies OpenEdge.Net.HTTP.Cookie
 
Top

ClearPersistentCookies ()

Purpose: Clears all persistent cookies
Top

ClearSessionCookies ()

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

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

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.


Property Detail
Top

CHARACTER CookieJarPath

Returns CHARACTER