IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.base
Class FunctionalTraceHelper

java.lang.Object
  extended by com.ibm.btt.base.FunctionalTraceHelper

public class FunctionalTraceHelper
extends java.lang.Object

This is a helper class used to separate functional tracing code from the rest of the code.


Constructor Summary
FunctionalTraceHelper()
           
 
Method Summary
static void condition(java.lang.String expression, boolean result, java.lang.String event)
          Traces the evaluation of a condition in a condition state.
static void conditionDefaultEvent(java.lang.String defaultEvent)
          Traces the triggering of the default condition state event
static void dumpContext(Context ctx)
          Recursively traces the contents of a context.
static void flowChangeState(Processor p, State s)
          To be called when a flow changes to a new state.
static void flowEnd(Processor p)
          Traces the end of a flow
static void flowStart(Processor p)
          Traces the start of a flow
(package private) static java.lang.String getNLS(java.lang.String key)
          Returns the localized text from a key
static boolean getShowDumps()
          Returns whether exception stack traces are included in the trace or not.
static void mappingBegin(FormatElement fmt, Context inputContext, Context outputContext)
          Traces the start of a data mapping
static void mappingEnd(Context inputContext, Context outputContext)
          Traces the end of a data mapping
static void mappingItem(DataField src, DataField to)
          Traces the execution of a mapping line item
static void mappingItem(java.lang.String fromDataField, Context inputContext, java.lang.String toDataField, Context outputContext)
          Traces the execution of a mapping line item
static void mappingItem(java.lang.String fromExpression, Context inputContext, java.lang.String toDataField, Context outputContext, java.lang.Object value)
          Traces the execution of a mapping line item
static void operationAfterExecute(Operation operation)
          Trace to be called right after executing an operation
static void operationBeforeExecute(Operation operation)
          Trace to be called right before executing an operation
static void pageRender(java.lang.String jspFileName)
          Traces the rendering of a page
static void pageRequest(KeyedCollection requestData)
          Traces the arrival of a request from the client
static java.lang.String removeExtension(java.lang.String fileName, java.lang.String ext)
          Checks if a file name ends with a given extension (case insensitive), and removes it if true.
(package private) static java.lang.String removePrefix(java.lang.String s)
          If a String has one or more "
static void transitionTrigger(State s, TransitionDescriptor tranDesc)
          To be called when a transition is triggered.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FunctionalTraceHelper

public FunctionalTraceHelper()
Method Detail

getShowDumps

public static boolean getShowDumps()
Returns whether exception stack traces are included in the trace or not.

Returns:
true if stack traces are included, false otherwise.

removeExtension

public static java.lang.String removeExtension(java.lang.String fileName,
                                               java.lang.String ext)
Checks if a file name ends with a given extension (case insensitive), and removes it if true.

Parameters:
fileName - the file name containing the extension.
ext - the extension, including the "." character.
Returns:
the file name without extension.

flowStart

public static void flowStart(Processor p)
Traces the start of a flow

Parameters:
p - the flow processor instance

flowEnd

public static void flowEnd(Processor p)
Traces the end of a flow

Parameters:
p - the flow processor instance

flowChangeState

public static void flowChangeState(Processor p,
                                   State s)
To be called when a flow changes to a new state.

Parameters:
p - the flow processor instance
s - the state instance

transitionTrigger

public static void transitionTrigger(State s,
                                     TransitionDescriptor tranDesc)
To be called when a transition is triggered.

Parameters:
s - the source state
tranDesc - the transition descriptor instance

condition

public static void condition(java.lang.String expression,
                             boolean result,
                             java.lang.String event)
Traces the evaluation of a condition in a condition state.

Parameters:
expression - the condition expression
result - the result of the condition evaluation
event - the event to trigger if the condition evaluates to true

conditionDefaultEvent

public static void conditionDefaultEvent(java.lang.String defaultEvent)
Traces the triggering of the default condition state event

Parameters:
defaultEvent - the default event name

mappingBegin

public static void mappingBegin(FormatElement fmt,
                                Context inputContext,
                                Context outputContext)
Traces the start of a data mapping

Parameters:
fmt - the format element containing the mapping
inputContext - the source context
outputContext - the destination context

mappingEnd

public static void mappingEnd(Context inputContext,
                              Context outputContext)
Traces the end of a data mapping

Parameters:
inputContext - the source context
outputContext - the destination context

mappingItem

public static void mappingItem(java.lang.String fromDataField,
                               Context inputContext,
                               java.lang.String toDataField,
                               Context outputContext)
Traces the execution of a mapping line item

Parameters:
fromDataField - mapping source expression
inputContext - the source context
toDataField - mapping destination
outputContext - the destination context

mappingItem

public static void mappingItem(java.lang.String fromExpression,
                               Context inputContext,
                               java.lang.String toDataField,
                               Context outputContext,
                               java.lang.Object value)
Traces the execution of a mapping line item

Parameters:
fromDataField - mapping source expression
inputContext - the source context
toDataField - mapping destination
outputContext - the destination context

mappingItem

public static void mappingItem(DataField src,
                               DataField to)
Traces the execution of a mapping line item

Parameters:
src - source data element
to - destination data element

operationBeforeExecute

public static void operationBeforeExecute(Operation operation)
Trace to be called right before executing an operation

Parameters:
operation - the operation instance

operationAfterExecute

public static void operationAfterExecute(Operation operation)
Trace to be called right after executing an operation

Parameters:
operation - the operation instance

pageRender

public static void pageRender(java.lang.String jspFileName)
Traces the rendering of a page

Parameters:
jspFileName - the name of the JSP file to be rendered

pageRequest

public static void pageRequest(KeyedCollection requestData)
Traces the arrival of a request from the client

Parameters:
requestData - the kColl containing the request data

dumpContext

public static void dumpContext(Context ctx)
Recursively traces the contents of a context. Notice this is the only public method that uses the #FUNCDATA requester category

Parameters:
ctx - the context containing the data to trace

removePrefix

static java.lang.String removePrefix(java.lang.String s)
If a String has one or more ".", it returns the last part of the string after the last ".".

Parameters:
s - the string to use to remove the prefix
Returns:
the resulting string without the prefix

getNLS

static java.lang.String getNLS(java.lang.String key)
Returns the localized text from a key

Parameters:
key - the key to retrieve the text from the appropriate properties file
Returns:
the localized text

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2011