Namespace: OpenEdge.Security.Provider
Type: Class ProviderConfig
Parent Classes:
Inherits: Progress.Lang.Object


/* *************************************************************************************************************************
Copyright (c) 2022 by Progress Software Corporation and/or one of its subsidiaries or affiliates. All rights reserved.
File:ProviderConfig
Purpose:Loads a providers.cfg from disk. This file MUST be in the OEAG's webapps/ROOT/WEB-INF/config folder
Author(s):pjudge
Created:2022-04-15
Notes:* PROVIDERS.CFG format
- may have named groups (per operation)
- groups are typically named for the ooabl type (concrete implementations better)
- groups have properties
{
"OpenEdge.Security.Provider.UserTableAuthProvider": {
"passwordProvider": "Sports.Security.PWProvider",
}
}



Method Summary
  Options Name Purpose
  ClearConfig () /* Removes the currently-cached config */
  Progress.Json.ObjectModel.JsonObject GetConfig (character) /* Returns the Json configuration for a provider. @param character The group name for which to get the config @return JsonObject If configuration exists for this type, return it. Return unknown value in all other cases */
  LOGICAL HasConfig (character) /* Returns the Json configuration for a provider. @param character The group name for which to get the config @return logical Returns TRUE if we have loaded config AND if that config contains this group AND if the group contains JSON object data; returns FALSE otherwise */
  LoadConfig () /* Loads configuration for this provider. The config file is checked for changes on an interval, and reloaded if there are changes to it. */

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

Property Summary
  Options Name Purpose
  INTEGER FileCheckInterval
  OpenEdge.Logging.ILogWriter Logger


Method Detail
Top

ClearConfig ()

/* Removes the currently-cached config
Top

Progress.Json.ObjectModel.JsonObject GetConfig (character)

/* Returns the Json configuration for a provider.
Parameters:
pType CHARACTER
 
Returns Progress.Json.ObjectModel.JsonObject
  JsonObject If configuration exists for this type, return it. Return unknown value in all other cases
Top

LOGICAL HasConfig (character)

/* Returns the Json configuration for a provider.
JSON object data; returns FALSE otherwise
Parameters:
pType CHARACTER
 
Returns LOGICAL
  logical Returns TRUE if we have loaded config AND if that config contains this group AND if the group contains
Top

LoadConfig ()

/* Loads configuration for this provider.
The config file is checked for changes on an interval, and reloaded if there are changes to it.


Constructor Detail
Top

ProviderConfig ()

Purpose: Default constructor
Top

STATIC ProviderConfig ()



Property Detail
Top

INTEGER FileCheckInterval

Returns INTEGER
 
Top

OpenEdge.Logging.ILogWriter Logger

Returns OpenEdge.Logging.ILogWriter