Namespace: OpenEdge.Net.HTTP.Filter.Auth
Class
BasicAuthenticationFilter
Parent classes:
Progress.Lang.Object
OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
OpenEdge.Net.HTTP.Filter.Auth.BasicAuthenticationFilter

Inherits: OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter

Copyright (c) 2014, 2015, 2017, 2018 by Progress Software Corporation. All rights reserved.
File:BasicAuthenticationFilter
Purpose:Sets the credentials for the Basic challenge. These will be
encoded per http://tools.ietf.org/html/rfc2617.
Author(s):pjudge
Created:Mon Jul 07 13:30:12 EDT 2014




Method Summary
Options Name Purpose
AddAuthentication () /** Build the actual authentication. To be implemented by concrete classes. */
Overrides OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter:AddAuthentication ()
Close ()
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Destroy ()
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Flush ()
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
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) */
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Initialize ()
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
OnHttpCredentialRequest (AuthenticationRequestEventArgs) /** Publishes the HttpCredentialRequest event @param AuthenticationRequestEventArgs The event args being modified/used in this event. */
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Open ()
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
SubscribeListener (Object) /** Subscribes a listener to events from the implementing filter. @param Object The prospective listener. */
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
UnsubscribeListener (Object) /** Unsubscribes a listener to events from the implementing filter. @param Object The prospective listener. */
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Write (character) /** Write data to/from the message @param character Data to write */
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Write (longchar)
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Write (handle) /** Write data to/from the message @param handle Data to write */
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Write (memptr)
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Write (Object)
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter

Constructor Summary
Options Name Purpose
BasicAuthenticationFilter (IAuthenticatedRequest) /** Constructor @param IAuthenticatedRequest The request being authenticated. */

Event Summary
Options Name Purpose
HttpCredentialRequest (Object, AuthenticationRequestEventArgs) /** The HttpRequest does not know where the Domain and username */
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter

Property Summary
Options Name Purpose
OpenEdge.Net.HTTP.IAuthenticatedRequest AuthenticatedRequest
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Progress.Lang.Class FilterEventListenerType
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
IHttpMessage Message
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter


Method Detail
Top

PROTECTED AddAuthentication ()
Overrides OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter:AddAuthentication ()
Purpose: Build the actual authentication. To be implemented by concrete classes.
Top

PUBLIC Close ()
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Top

PUBLIC Destroy ()
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Top

PUBLIC Flush ()
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Top

PROTECTED OpenEdge.Net.HTTP.Credentials GetCredentials (character)
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
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

PUBLIC Initialize ()
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Top

PROTECTED OnHttpCredentialRequest (AuthenticationRequestEventArgs)
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Purpose: Publishes the HttpCredentialRequest event
in this event.
Parameters:
poAuthRequestArgs AuthenticationRequestEventArgs
Top

PUBLIC Open ()
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Top

PUBLIC SubscribeListener (Object)
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Purpose: Subscribes a listener to events from the implementing filter.
Parameters:
poListener Object
Top

PUBLIC UnsubscribeListener (Object)
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Purpose: Unsubscribes a listener to events from the implementing filter.
Parameters:
poListener Object
Top

PUBLIC Write (character)
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Purpose: Write data to/from the message
Parameters:
pcData CHARACTER
Top

PUBLIC Write (longchar)
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Parameters:
pcData LONGCHAR
Top

PUBLIC Write (handle)
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Purpose: Write data to/from the message
Parameters:
phData HANDLE
Top

PUBLIC Write (memptr)
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Parameters:
pmData MEMPTR
Top

PUBLIC Write (Object)
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Parameters:
poData Object


Constructor Detail
Top

PUBLIC BasicAuthenticationFilter (IAuthenticatedRequest)
Purpose: Constructor
Parameters:
poRequest OpenEdge.Net.HTTP.IAuthenticatedRequest


Event Detail
Top

PUBLIC HttpCredentialRequest (Object, AuthenticationRequestEventArgs)
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Purpose: The HttpRequest does not know where the Domain and username
Parameters:
poSender Object
poEventArgs AuthenticationRequestEventArgs


Property Detail
Top

PROTECTED OpenEdge.Net.HTTP.IAuthenticatedRequest AuthenticatedRequest
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Returns OpenEdge.Net.HTTP.IAuthenticatedRequest
Top

PUBLIC Progress.Lang.Class FilterEventListenerType
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Returns Progress.Lang.Class
Top

PUBLIC IHttpMessage Message
Inherited from OpenEdge.Net.HTTP.Filter.Auth.AuthenticationRequestFilter
Returns IHttpMessage


Copyright © 2019 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.0.0