Namespace: OpenEdge.Net.HTTP
Type: Class TlsConnectionAuthenticatedRequest
Parent Classes:
Inherits: OpenEdge.Net.HTTP.HttpRequestDecorator
Implements: OpenEdge.Net.HTTP.ISecureConnectionAuthenticatedRequest


Copyright (c) 2021 by Progress Software Corporation. All rights reserved.
File:TlsConnectionAuthenticatedRequest
Purpose:Decorates an HTTP request with TLS client connections credentials.
Author(s):dugrau
Created:Wed Feb 24 12:03:10 EST 2021
Purpose: Holds distinct credentials for the request



Method Summary
  Options Name Purpose
  LOGICAL AddCallback (ISocketConnectionCredentialsHandler) /** Registers an instance of ISocketConnectionCredentialsHandler as a callback for credentials. @param OpenEdge.Net.ServerConnection.ISocketConnectionCredentialsHandler @return logical If the instance is already registered, or is null, then return FALSE. Otherwise return TRUE. */
  OpenEdge.Security.ICredentials GetCredentials (IConnectionParameters) /** Returns an instance of the credentials to use for a given connection. @param OpenEdge.Core.ServerConnection.IConnectionParameters Should be a valid connection @return OpenEdge.Security.ICredentials A set of credentials to use for the connection. */
  LOGICAL HasCallback (ISocketConnectionCredentialsHandler) /** Checks if an instance of ISocketConnectionCredentialsHandler exists as a callback. @param OpenEdge.Net.ServerConnection.ISocketConnectionCredentialsHandler @return logical If the instance is already registered, then return TRUE. Otherwise return FALSE. */
  LOGICAL RemoveCallback (ISocketConnectionCredentialsHandler) /** Removes an instance of ISocketConnectionCredentialsHandler as a callback for credentials. @param OpenEdge.Net.ServerConnection.ISocketConnectionCredentialsHandler @return logical If the instance is already removed, or is null, then return TRUE. Otherwise return FALSE. */

Constructor Summary
  Options Name Purpose
  TlsConnectionAuthenticatedRequest (IHttpRequest) /** Constructor. @param OpenEdge.Net.HTTP.IHttpRequest Request being decorated */

Property Summary
  Options Name Purpose
  OpenEdge.Core.Collections.ISet Callbacks
  OpenEdge.Security.ICredentials Credentials
  INTEGER NumCallbacks


Method Detail
Top

LOGICAL AddCallback (ISocketConnectionCredentialsHandler)

Purpose: Registers an instance of ISocketConnectionCredentialsHandler as a callback for credentials.
Parameters:
pCallback OpenEdge.Net.ServerConnection.ISocketConnectionCredentialsHandler
 
Returns LOGICAL
  logical If the instance is already registered, or is null, then return FALSE. Otherwise return TRUE.
Top

OpenEdge.Security.ICredentials GetCredentials (IConnectionParameters)

Purpose: Returns an instance of the credentials to use for a given connection.
Parameters:
pConnection OpenEdge.Core.ServerConnection.IConnectionParameters
 
Returns OpenEdge.Security.ICredentials
  OpenEdge.Security.ICredentials A set of credentials to use for the connection.
Top

LOGICAL HasCallback (ISocketConnectionCredentialsHandler)

Purpose: Checks if an instance of ISocketConnectionCredentialsHandler exists as a callback.
Parameters:
pCallback OpenEdge.Net.ServerConnection.ISocketConnectionCredentialsHandler
 
Returns LOGICAL
  logical If the instance is already registered, then return TRUE. Otherwise return FALSE.
Top

LOGICAL RemoveCallback (ISocketConnectionCredentialsHandler)

Purpose: Removes an instance of ISocketConnectionCredentialsHandler as a callback for credentials.
Parameters:
pCallback OpenEdge.Net.ServerConnection.ISocketConnectionCredentialsHandler
 
Returns LOGICAL
  logical If the instance is already removed, or is null, then return TRUE. Otherwise return FALSE.


Constructor Detail
Top

TlsConnectionAuthenticatedRequest (IHttpRequest)

Purpose: Constructor.
Parameters:
poHttpRequest OpenEdge.Net.HTTP.IHttpRequest
 


Property Detail
Top

OpenEdge.Core.Collections.ISet Callbacks

Returns OpenEdge.Core.Collections.ISet
 
Top

OpenEdge.Security.ICredentials Credentials

Returns OpenEdge.Security.ICredentials
 
Top

INTEGER NumCallbacks

Returns INTEGER