Namespace: OpenEdge.Net.HTTP
Interface 
IAuthenticatedRequest
Parent classes:
Inherits: OpenEdge.Net.HTTP.IHttpRequest

Copyright (c) 2015 by Progress Software Corporation. All rights reserved.
File:IAuthenticatedRequest
Author(s):pjudge
Created:Wed Jan 28 21:19:56 EST 2015




Method Summary
Options Name Purpose
# AddAuthentication () /** Add the actual authentication to this request, based on the request's challenge, credentials and authentication method. */
# AddAuthenticationCallback (IAuthFilterEventHandler) /** Adds a subscriber to the events from this request @param IAuthFilterEventHandler The EventProvider. */
# ClearCookies () /** Removes all cookies from this message */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
# ClearHeaders () /** Removes all headers from this message */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
# INTEGER GetAuthenticationCallbacks (IAuthFilterEventHandler[]) /** Returns the registered listeners. @param IAuthFilterEventHandler[] An array of listeners @return integer The number of registgered listeners. */
# INTEGER GetCookies (Cookie[]) /** Returns all the cookies for this message @param Cookie[] An array of cookies @return integer The number of cookies returned */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
# HttpHeader GetHeader (character) /** Returns a named header @param character The name of the header to retrieve @return HttpHeader The header object. Null if not exists. */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
# INTEGER GetHeaders (HttpHeader[]) /** Returns all the headers @param HttpHeader[] An array of headers @return integer The number of headers returned */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
# LOGICAL HasCookie (Cookie) /** Indicates whether a cookie exists for this message @param Cookie The cookie to check @return logical True if this message contains the cookie */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
# LOGICAL HasHeader (character) /** Indicates whether a header exists for this message or not. @param character The name of a header to check @return logical True if this message contains the header */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
# RemoveAuthenticationCallback (IAuthFilterEventHandler) /** Removes a subscriber from the events from this request @param IAuthFilterEventHandler The EventProvider. */
# RemoveCookie (Cookie) /** Removes a cookie from this message @param Cookie The cookie to remove. */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
# RemoveHeader (character) /** Removes all headers with a given name from the set of message headers. No-op if none exists. @param character The name of the header to remove */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
# SetChallenge (character, character) /** Sets the authentication challenge information for this request. @param character The authentication method @param character The challenge text */
# SetCookie (Cookie) /** Adds a cookie to this message @param Cookie The cookie to add. */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
# SetHeader (HttpHeader) /** Adds header info to this message's collection of headers. @param HttpHeader The header */
Inherited from OpenEdge.Net.HTTP.IHttpMessage

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. */
# CHARACTER CharacterEncoding /** The message's content type encoding (eg charset='utf-8'). For more detail, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7 */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
# INTEGER ContentLength /** The length (in bytes/characters) of the payload/entity. */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
# RAW ContentMD5 /** An MD5 hash of the message's content. */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
# CHARACTER ContentType /** The message's content type (eg text/html). For more detail, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7 */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
# OpenEdge.Net.HTTP.Credentials Credentials /** Credentials to be used for authentication */
# Object Entity /** Object containing the message body/entity. The object can be of any type, which may depend on the content type. The Entity is the 'programmer-readable' version of the message body: it's the formatted, strongly-typed version */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
# CHARACTER Method /** (mandatory) GET/PUT/POST etc, Maps to MethodEnum, although there are extension methods too */
Inherited from OpenEdge.Net.HTTP.IHttpRequest
# CHARACTER TransferEncoding /** The message's Transfer-Encoding. For more detail, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.6 */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
# URI URI /** (mandatory) The URI to request eg. http://progress.com/ */
Inherited from OpenEdge.Net.HTTP.IHttpRequest
# CHARACTER Version /** The HTTP version supported. Typically HTTP/1.1 */
Inherited from OpenEdge.Net.HTTP.IHttpMessage


Method Detail
Top

PROTECTED AddAuthentication ()

Purpose: Add the actual authentication to this request, based on the
request's challenge, credentials and authentication method.
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.IHttpMessage
Purpose: Removes all cookies from this message
Top

PROTECTED ClearHeaders ()

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Removes all headers from this message
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.IHttpMessage
Purpose: Returns all the cookies for this message
Parameters:
poCookies Cookie
Returns INTEGER
integer The number of cookies returned
Top

PROTECTED HttpHeader GetHeader (character)

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Returns a named header
Parameters:
pcName CHARACTER
Returns HttpHeader
HttpHeader The header object. Null if not exists.
Top

PROTECTED INTEGER GetHeaders (HttpHeader[])

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Returns all the headers
Parameters:
poHeaders HttpHeader
Returns INTEGER
integer The number of headers returned
Top

PROTECTED LOGICAL HasCookie (Cookie)

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Indicates whether a cookie exists for this message
Parameters:
poCookie Cookie
Returns LOGICAL
logical True if this message contains the cookie
Top

PROTECTED LOGICAL HasHeader (character)

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Indicates whether a header exists for this message or not.
Parameters:
pcName CHARACTER
Returns LOGICAL
logical True if this message contains the header
Top

PROTECTED RemoveAuthenticationCallback (IAuthFilterEventHandler)

Purpose: Removes a subscriber from the events from this request
Parameters:
poListener OpenEdge.Net.HTTP.Filter.Auth.IAuthFilterEventHandler
Top

PROTECTED RemoveCookie (Cookie)

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Removes a cookie from this message
Parameters:
poCookie Cookie
Top

PROTECTED RemoveHeader (character)

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Removes all headers with a given name from the set of message headers.
No-op if none exists.
Parameters:
pcName CHARACTER
Top

PROTECTED SetChallenge (character, character)

Purpose: Sets the authentication challenge information for this request.
Parameters:
poAuthMethod CHARACTER
pcChallenge CHARACTER
Top

PROTECTED SetCookie (Cookie)

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Adds a cookie to this message
Parameters:
poCookie Cookie
Top

PROTECTED SetHeader (HttpHeader)

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Adds header info to this message's collection of headers.
Parameters:
poHeader HttpHeader


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.
Returns CHARACTER
Top

PROTECTED CHARACTER CharacterEncoding

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: The message's content type encoding (eg charset='utf-8'). For more detail, see
http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7
Returns CHARACTER
Top

PROTECTED INTEGER ContentLength

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: The length (in bytes/characters) of the payload/entity.
Returns INTEGER
Top

PROTECTED RAW ContentMD5

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: An MD5 hash of the message's content.
Returns RAW
Top

PROTECTED CHARACTER ContentType

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: The message's content type (eg text/html). For more detail, see
http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7
Returns CHARACTER
Top

PROTECTED OpenEdge.Net.HTTP.Credentials Credentials

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

PROTECTED Object Entity

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Object containing the message body/entity. The object can be of any type,
which may depend on the content type.
The Entity is the 'programmer-readable' version of the message body: it's
the formatted, strongly-typed version
Returns Object
Top

PROTECTED CHARACTER Method

Inherited from OpenEdge.Net.HTTP.IHttpRequest
Purpose: (mandatory) GET/PUT/POST etc, Maps to MethodEnum, although there are extension methods too
Returns CHARACTER
Top

PROTECTED CHARACTER TransferEncoding

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: The message's Transfer-Encoding. For more detail, see
http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.6
Returns CHARACTER
Top

PROTECTED URI URI

Inherited from OpenEdge.Net.HTTP.IHttpRequest
Purpose: (mandatory) The URI to request eg. http://progress.com/
Returns URI
Top

PROTECTED CHARACTER Version

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: The HTTP version supported. Typically HTTP/1.1
Returns CHARACTER


10.27.2015 12:36:48