Namespace: OpenEdge.Logging
Type: Class TokenResolver
Parent Classes:
Progress.Lang.Object

Inherits: Progress.Lang.Object


/* *************************************************************************************************************************
Copyright (c) 2016-2018 by Progress Software Corporation and/or one of its subsidiaries or affiliates. All rights reserved.
File:TokenResolver
Purpose:Resolves certain known token names into useful values.
Wraps calls to the OpenEdge.Core.Util.TokenResolver
Author(s):pjudge
Created:Wed Nov 16 13:02:52 EST 2016



Method Summary
  Options Name Purpose
  CHARACTER Resolve (character) /* Resolves any tokens in the file name into appropriate values @param character The source string @return character The resolved string */
  CHARACTER ResolveName (character, character) /* Resolves a NAME-based token arg, based on the type/logger name given @param character The token argument for ${NAME.*} tokens @param character The (type) name to resolve @return character The resolved string */
  CHARACTER ResolveTime (character, character[12], character[12], character[7], character[7], datetime-tz) /* Resolves a time-based token arg, based on the timestamp given @param character The token argument for ${T.*} tokens @param character[12] The long-form month names (ie January) @param character[12] The short-form month names (ie Jan) @param character[7] The long-form weekday names (ie Thursday) @param character[7] The short-form weekday names (ie Thurs) @param datetime-tz The timestamp to use to resolve the token @return character The resolved string */
  CHARACTER ResolveTime (character, datetime-tz) /* Resolves a time-based token arg, based on the timestamp given @param character The token argument for ${T.*} tokens @param datetime-tz The timestamp to use to resolve the token @return character The resolved string */
  CHARACTER ResolveUser (character, handle) /* Resolves a CP-based token arg, based on the client-principal. It is the CALLER's responsibility to clean up the C-P object represented by this handle @param character The token argument for ${CP.*} tokens @param handle A user represented by a client-principal @return character The resolved string */
  TokenResolvedHandler (Object, TokenResolverEventArgs) /* Callback to handle token replacement @param Object The sender @param OpenEdge.Core.Util.TokenResolverEventArgs The token resolution args */

Event Summary
  Options Name Purpose
  TokenResolved (Object, TokenResolverEventArgs) /* Event published after a token is resolved by this resolver. Allows a listener to override the value */

Method Detail
Top

CHARACTER Resolve (character)

/* Resolves any tokens in the file name into appropriate values
Parameters:
pcBaseString CHARACTER
 
Returns CHARACTER
  character The resolved string
Top

CHARACTER ResolveName (character, character)

/* Resolves a NAME-based token arg, based on the type/logger name given
Parameters:
pTokenArg CHARACTER
 
pName CHARACTER
 
Returns CHARACTER
  character The resolved string
Top

CHARACTER ResolveTime (character, character[12], character[12], character[7], character[7], datetime-tz)

/* Resolves a time-based token arg, based on the timestamp given
Parameters:
pTokenArg CHARACTER
 
pMonthLong CHARACTER
 
pMonthShort CHARACTER
 
pWeekdayLong CHARACTER
 
pWeekdayShort CHARACTER
 
pTimestamp DATETIME-TZ
 
Returns CHARACTER
  character The resolved string
Top

CHARACTER ResolveTime (character, datetime-tz)

/* Resolves a time-based token arg, based on the timestamp given
Parameters:
pTokenArg CHARACTER
 
pTimestamp DATETIME-TZ
 
Returns CHARACTER
  character The resolved string
Top

CHARACTER ResolveUser (character, handle)

/* Resolves a CP-based token arg, based on the client-principal.
It is the CALLER's responsibility to clean up the C-P object represented by this handle
Parameters:
pTokenArg CHARACTER
 
pUser HANDLE
 
Returns CHARACTER
  character The resolved string
Top

TokenResolvedHandler (Object, TokenResolverEventArgs)

/* Callback to handle token replacement
Parameters:
pSender Progress.Lang.Object
 
pArgs OpenEdge.Core.Util.TokenResolverEventArgs
 


Event Detail
Top

TokenResolved (Object, TokenResolverEventArgs)

/* Event published after a token is resolved by this resolver. Allows a listener to override the value
Parameters:
pSender Progress.Lang.Object
 
pArgs OpenEdge.Logging.TokenResolverEventArgs