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

Inherits: OpenEdge.Net.HTTP.HttpRequestDecorator
Implements: OpenEdge.Net.HTTP.IAuthenticatedRequest

Copyright (c) 2015 by Progress Software Corporation. All rights reserved.
File:AuthenticatedRequest
Author(s):pjudge
Created:Fri Jan 30 09:35:29 EST 2015




Method Summary
Options Name Purpose
# AddAuthentication () /** Add authentication to this request. */
# AddAuthenticationCallback (IAuthFilterEventHandler) /** Adds a subscriber to the events from this request @param IAuthFilterEventHandler The EventProvider. */
# ClearCookies ()
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
# ClearHeaders ()
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
# INTEGER GetAuthenticationCallbacks (IAuthFilterEventHandler[]) /** Returns the registered listeners. @param IAuthFilterEventHandler[] An array of listeners @return integer The number of registgered listeners. */
# INTEGER GetCookies (Cookie[])
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
# HttpHeader GetHeader (character)
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
# INTEGER GetHeaders (HttpHeader[])
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
# LOGICAL HasCookie (Cookie)
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
# LOGICAL HasHeader (character)
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
# RemoveAuthenticationCallback (IAuthFilterEventHandler)
# RemoveCookie (Cookie)
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
# RemoveHeader (character)
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
# SetChallenge (character, character) /** Sets the authentication challenge information for this request. @param character The authentication method @param character The challenge text */
# SetCookie (Cookie)
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
# SetHeader (HttpHeader)
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator

Constructor Summary
Options Name Purpose
# AuthenticatedRequest (IHttpRequest)

Property Summary
Options Name Purpose
# CHARACTER AuthenticationChallenge /** The challenge text required for creating the authentication response, typically from a 401/Unauthorized response. This is usually the contents of the WWW-Authenticate header, but might also be a chunk of HTML for Forms-based authentication requests. */
# CHARACTER AuthenticationMethod /** The authentication method for this request. Defaults to none/blankNone */
# CHARACTER CharacterEncoding
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
# INTEGER ContentLength
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
# RAW ContentMD5
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
# CHARACTER ContentType
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
# OpenEdge.Net.HTTP.Credentials Credentials /** Credentials to be used for authentication */
# Progress.Lang.Object Entity
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
# CHARACTER Method
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
# CHARACTER TransferEncoding
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
# URI URI
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
# CHARACTER Version
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator


Method Detail
Top

PROTECTED AddAuthentication ()
Purpose: Add authentication to this request.
Top

PROTECTED AddAuthenticationCallback (IAuthFilterEventHandler)
Purpose: Adds a subscriber to the events from this request
Parameters:
poListener OpenEdge.Net.HTTP.Filter.Auth.IAuthFilterEventHandler
Top

PROTECTED ClearCookies ()
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
Top

PROTECTED ClearHeaders ()
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
Top

PROTECTED INTEGER GetAuthenticationCallbacks (IAuthFilterEventHandler[])
Purpose: Returns the registered listeners.
Parameters:
poListener OpenEdge.Net.HTTP.Filter.Auth.IAuthFilterEventHandler
Returns INTEGER
integer The number of registgered listeners.
Top

PROTECTED INTEGER GetCookies (Cookie[])
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
Parameters:
poCookies Cookie
Returns INTEGER
Top

PROTECTED HttpHeader GetHeader (character)
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
Parameters:
pcName CHARACTER
Returns HttpHeader
Top

PROTECTED INTEGER GetHeaders (HttpHeader[])
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
Parameters:
poHeader HttpHeader
Returns INTEGER
Top

PROTECTED LOGICAL HasCookie (Cookie)
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
Parameters:
poCookie Cookie
Returns LOGICAL
Top

PROTECTED LOGICAL HasHeader (character)
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
Parameters:
pcName CHARACTER
Returns LOGICAL
Top

PROTECTED RemoveAuthenticationCallback (IAuthFilterEventHandler)
Parameters:
poListener OpenEdge.Net.HTTP.Filter.Auth.IAuthFilterEventHandler
Top

PROTECTED RemoveCookie (Cookie)
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
Parameters:
poCookie Cookie
Top

PROTECTED RemoveHeader (character)
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
Parameters:
pcName CHARACTER
Top

PROTECTED SetChallenge (character, character)
Purpose: Sets the authentication challenge information for this request.
Parameters:
pcAuthMethod CHARACTER
pcChallenge CHARACTER
Top

PROTECTED SetCookie (Cookie)
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
Parameters:
poCookie OpenEdge.Net.HTTP.Cookie
Top

PROTECTED SetHeader (HttpHeader)
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
Parameters:
poHeader HttpHeader


Constructor Detail
Top

PROTECTED AuthenticatedRequest (IHttpRequest)
Parameters:
poHttpRequest OpenEdge.Net.HTTP.IHttpRequest


Property Detail
Top

PROTECTED CHARACTER AuthenticationChallenge
Purpose: The challenge text required for creating the authentication response,
typically from a 401/Unauthorized response. This is usually the contents
of the WWW-Authenticate header, but might also be a chunk of HTML for
Forms-based authentication requests.
Returns CHARACTER
Top

PROTECTED CHARACTER AuthenticationMethod
Purpose: The authentication method for this request. Defaults to none/blankNone
Returns CHARACTER
Top

PROTECTED CHARACTER CharacterEncoding
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
Returns CHARACTER
Top

PROTECTED INTEGER ContentLength
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
Returns INTEGER
Top

PROTECTED RAW ContentMD5
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
Returns RAW
Top

PROTECTED CHARACTER ContentType
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
Returns CHARACTER
Top

PROTECTED OpenEdge.Net.HTTP.Credentials Credentials
Purpose: Credentials to be used for authentication
Returns OpenEdge.Net.HTTP.Credentials
Top

PROTECTED Progress.Lang.Object Entity
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
Returns Progress.Lang.Object
Top

PROTECTED CHARACTER Method
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
Returns CHARACTER
Top

PROTECTED CHARACTER TransferEncoding
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
Returns CHARACTER
Top

PROTECTED URI URI
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
Returns URI
Top

PROTECTED CHARACTER Version
Inherited from OpenEdge.Net.HTTP.HttpRequestDecorator
Returns CHARACTER


10.27.2015 12:36:34