Powered by Zoomin Software. For more details please contactZoomin

OpenEdge ABL API Reference

Table of Contents

OpenEdge.Security.STS.EventDispatcher

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
Print
  • Last Updated: January 15, 2026
  • 3 minute read
    • OpenEdge
    • Documentation
Namespace: OpenEdge.Security.STS
Type: Class EventDispatcher
Parent Classes:
Progress.Lang.Object
OpenEdge.Security.STS.EventDispatcher

Inherits: Progress.Lang.Object
Implements: OpenEdge.Logging.ISupportLogging

Copyright (c) 2016, 2019, 2022 by Progress Software Corporation. All rights reserved.
File:EventDispatcher
Purpose:Dispatches policy and other events from the STS to an ABL
provider.
Author(s):pjudge
Created:Thu Jan 28 11:44:45 EST 2016
Notes:*



Method Summary
  Options Name Purpose
  RAW ApplyPolicy (character, character, character, character, raw, longchar, integer, character) /* Applies some by an ABL provider. @param character (optional) The name of the STS sending this event @param character (mandatory) The ABL provider name used to process the event @param character (optional) A hash used to verify the provider's authenticity @param character (optional) The name of the event to send. @param raw (mandatory) The token currently being processed in the STS @param longchar (optional) The domain context from the STS @return raw The token/client-principal after having policy applied. */
  EmitEvent (character, character, character, character, raw, longchar) /* Emits a named event to the ABL provider. This is a one-way operation: nothing is returned from provider to the STS. @param character (optional) The name of the STS sending this event @param character (mandatory) The ABL provider name used to process the event @param character (optional) A hash used to verify the provider's authenticity @param character (optional) The name of the event to send. @param raw (optional) The token currently being processed in the STS @param longchar (optional) The domain context from the STS */
  LOGICAL HandleError (character, character, character, character, raw, character, longchar, character, character, character) /* handles/customises an error @param character (optional) The name of the STS sending this event @param character (mandatory) The ABL provider name used to process the event @param character (optional) A hash used to verify the provider's authenticity @param character (optional) The name of the event to send. @param raw (optional) The token currently being processed in the STS @param character (optional) An error string indicating the error being handled. Could be a java exception or something from an auth proivider, or empty. One of the client-principal and error-string fields SHOULD be provided @param longchar (optional) The domain context from the STS @param character out (optional) An error code per the OAuth2 and OpenId Connect specs. To return an error number a string of custom:<error_code> must be returned. If not empty or null, this value will replace the auth process's error value. @param character out (optional) If blank or unknown the response will omit the error_description field. @param character out (optional) If null the response will omit the error_uri field. @return logical TRUE if the current token should be included in the error response */
  Progress.Json.ObjectModel.JsonObject ParseContext (longchar) /* Creates useful JSON from the input context string @param longchar (optional) The domain context from the STS @return JsonObject The context in JSON form */

Constructor Summary
  Options Name Purpose
  EventDispatcher () /* Default constructor */

Property Summary
  Options Name Purpose
  OpenEdge.Logging.ILogWriter Logger


Method Detail
Top

RAW ApplyPolicy (character, character, character, character, raw, longchar, integer, character)

/* Applies some by an ABL provider.
Parameters:
pcSender CHARACTER
 
pcPolicyProvider CHARACTER
 
pcProviderHash CHARACTER
 
pcEventName CHARACTER
 
prClientPrincipal RAW
 
pcDomainCtx LONGCHAR
 
piStatus INTEGER
 
pcStatusDetail CHARACTER
 
Returns RAW
  raw The token/client-principal after having policy applied.
Top

EmitEvent (character, character, character, character, raw, longchar)

/* Emits a named event to the ABL provider. This is a one-way operation:
nothing is returned from provider to the STS.
Parameters:
pcSender CHARACTER
 
pcEventProvider CHARACTER
 
pcProviderHash CHARACTER
 
pcEventName CHARACTER
 
prClientPrincipal RAW
 
pcDomainCtx LONGCHAR
 
Top

LOGICAL HandleError (character, character, character, character, raw, character, longchar, character, character, character)

/* handles/customises an error
something from an auth proivider, or empty. One of the client-principal and error-string
fields SHOULD be provided
error number a string of custom:<error_code> must be returned. If not empty or null,
this value will replace the auth process's error value.
Parameters:
pcSender CHARACTER
 
pcErrorProvider CHARACTER
 
pcProviderHash CHARACTER
 
pcEventName CHARACTER
 
prClientPrincipal RAW
 
pcErrorString CHARACTER
 
pcDomainCtx LONGCHAR
 
pcErrorCode CHARACTER
 
pcErrorDetail CHARACTER
 
pcErrorURI CHARACTER
 
Returns LOGICAL
  logical TRUE if the current token should be included in the error response
Top

Progress.Json.ObjectModel.JsonObject ParseContext (longchar)

/* Creates useful JSON from the input context string
Parameters:
pcDomainCtx LONGCHAR
 
Returns Progress.Json.ObjectModel.JsonObject
  JsonObject The context in JSON form


Constructor Detail
Top

EventDispatcher ()

/* Default constructor


Property Detail
Top

OpenEdge.Logging.ILogWriter Logger


TitleResults for “How to create a CRG?”Also Available inAlert