Namespace: OpenEdge.Net.HTTP.Filter.Auth
Class
AuthenticationRequestFilter
Parent classes:
Inherits: Progress.Lang.Object
Implements: OpenEdge.Net.HTTP.IHttpMessageWriter, OpenEdge.Net.HTTP.Filter.IFilterEvents, OpenEdge.Core.ISupportInitialize
ABSTRACT

Copyright (c) 2015 by Progress Software Corporation. All rights reserved.
File:AuthenticationRequestFilter
Purpose:Filter for handling authentication credential requests.
Author(s):pjudge
Created:Fri Jan 30 11:27:01 EST 2015




Method Summary
Options Name Purpose
AddAuthentication () /** Build the actual authentication. To be implemented by concrete classes. */
Close ()
Destroy ()
Flush ()
OpenEdge.Net.HTTP.Credentials GetCredentials (character) /** Returns credentials to be used by this filter. Can be retrieved from the Request or requested via an event @param character The domain for which to get the credentials @return Credentials A set of credentials (may not be correct, of course) */
Initialize ()
OnHttpCredentialRequest (AuthenticationRequestEventArgs) /** Publishes the HttpCredentialRequest event @param AuthenticationRequestEventArgs The event args being modified/used in this event. */
Open ()
RemoveListeners () /** unsubsribes listeners from a writer, so that they can be GC'ed if needed */
SubscribeListener (Object) /** Subscribes a listener to events from the implementing filter. @param Object The prospective listener. */
UnsubscribeListener (Object) /** Unsubscribes a listener to events from the implementing filter. @param Object The prospective listener. */
Write (character) /** Write data to/from the message @param character Data to write */
Write (longchar)
Write (handle) /** Write data to/from the message @param handle Data to write */
Write (memptr)
Write (Object)

Constructor Summary
Options Name Purpose
AuthenticationRequestFilter (IAuthenticatedRequest)

Event Summary
Options Name Purpose
HttpCredentialRequest (Object, AuthenticationRequestEventArgs) /** The HttpRequest does not know where the Domain and username */

Property Summary
Options Name Purpose
Progress.Lang.Class FilterEventListenerType /** Returns the type(class or interface) that an a potential listener must implement or inherit in order to handle events from this filter. */
OpenEdge.Net.HTTP.IHttpMessage Message /** The request being authenticated */


Method Detail
Top

AddAuthentication ()

Purpose: Build the actual authentication. To be implemented by concrete classes.
Top

Close ()

Top

Destroy ()

Top

Flush ()

Top

OpenEdge.Net.HTTP.Credentials GetCredentials (character)

Purpose: Returns credentials to be used by this filter. Can be retrieved from
the Request or requested via an event
Parameters:
pcRealm CHARACTER
Returns OpenEdge.Net.HTTP.Credentials
Credentials A set of credentials (may not be correct, of course)
Top

Initialize ()

Top

OnHttpCredentialRequest (AuthenticationRequestEventArgs)

Purpose: Publishes the HttpCredentialRequest event
in this event.
Parameters:
poAuthRequestArgs OpenEdge.Net.HTTP.AuthenticationRequestEventArgs
Top

Open ()

Top

RemoveListeners ()

Purpose: unsubsribes listeners from a writer, so that they can be GC'ed if needed
Top

SubscribeListener (Object)

Purpose: Subscribes a listener to events from the implementing filter.
Parameters:
poListener Progress.Lang.Object
Top

UnsubscribeListener (Object)

Purpose: Unsubscribes a listener to events from the implementing filter.
Parameters:
poListener Progress.Lang.Object
Top

Write (character)

Purpose: Write data to/from the message
Parameters:
pcData CHARACTER
Top

Write (longchar)

Parameters:
pcData LONGCHAR
Top

Write (handle)

Purpose: Write data to/from the message
Parameters:
phData HANDLE
Top

Write (memptr)

Parameters:
pmData MEMPTR
Top

Write (Object)

Parameters:
poData Progress.Lang.Object


Constructor Detail
Top

AuthenticationRequestFilter (IAuthenticatedRequest)

Parameters:
poRequest OpenEdge.Net.HTTP.IAuthenticatedRequest


Event Detail
Top

HttpCredentialRequest (Object, AuthenticationRequestEventArgs)

Purpose: The HttpRequest does not know where the Domain and username
Parameters:
poSender Progress.Lang.Object
poEventArgs OpenEdge.Net.HTTP.AuthenticationRequestEventArgs


Property Detail
Top

Progress.Lang.Class FilterEventListenerType

Purpose: Returns the type(class or interface) that an a potential listener must
implement or inherit in order to handle events from this filter.
Returns Progress.Lang.Class
Top

OpenEdge.Net.HTTP.IHttpMessage Message

Purpose: The request being authenticated
Returns OpenEdge.Net.HTTP.IHttpMessage


Copyright © 2017 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7