tfw.base.operation.step

Class A_LoggedStep<RESULT_OBJECT_TYPE>

java.lang.Object

tfw.base.operation.step.A_LoggedStep<RESULT_OBJECT_TYPE>

All Implemented Interfaces:

java.io.Serializable, I_OperationStep<RESULT_OBJECT_TYPE>

Direct Known Subclasses:

TestCase_02_Test_logged_operation_steps.BusinessStep, TestCase_02_Test_logged_operation_steps.DataOparationStep, TestCase_02_Test_logged_operation_steps.DBConnectStep, TestCase_03_Test_logged_i18n_operation_steps.BusinessStep, TestCase_03_Test_logged_i18n_operation_steps.DataOparationStep

public abstract class A_LoggedStep<RESULT_OBJECT_TYPE>
extends java.lang.Object
implements I_OperationStep<RESULT_OBJECT_TYPE>

Operation step with logging feature.

This class can use a logging component(service or another operation step):

• If there is such a component, affairs would be logged.
  
• If there is no component, affairs would be only recorded into result.
  

This type of operation step is improved from [tfw.base.operation.step.A_OperationStep<RESULT_OBJECT_TYPE>].

Author:

Typhoon.Free.Wolf

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private LoggedOperationStepHelper<RESULT_OBJECT_TYPE>	helper
private static long	serialVersionUID long serialVersionUID

Constructor Summary

Constructors

Constructor and Description
A_LoggedStep() Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	doCatch(OperationStepResult<RESULT_OBJECT_TYPE> rst, OperationContext octx, java.lang.Object[] o1dArgs, OperationStepException e) Performs catching.
protected void	doExecute(OperationStepResult<RESULT_OBJECT_TYPE> rst, OperationContext octx, java.lang.Object[] o1dArgs) Performs executing.
protected void	doPrepare(OperationStepResult<RESULT_OBJECT_TYPE> rst, OperationContext octx, java.lang.Object[] o1dArgs) Performs preparing.
OperationStepResult<RESULT_OBJECT_TYPE>	execute(OperationContext octx, java.lang.Object[] o1dArgs) /** This method is designed to synchronized, because: The log helper should not be modified or re-configured during executing. If this method of this object was jammed for some reason during a calling, the jam can also happen on another calling to this method of this object
protected LoggedOperationStepHelper<RESULT_OBJECT_TYPE>	getHelper() Gets the step helper.
static void	main(java.lang.String[] strArgs) Main method, the entrance of embedded test case.
protected void	setHelper(LoggedOperationStepHelper<RESULT_OBJECT_TYPE> helper) Sets the step helper.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

long serialVersionUID

helper

private LoggedOperationStepHelper<RESULT_OBJECT_TYPE> helper

Constructor Detail

A_LoggedStep

public A_LoggedStep()

Constructor.

Method Detail

main

public static void main(java.lang.String[] strArgs)

Main method, the entrance of embedded test case.

Parameters:

strArgs - - Command line arguments.

getHelper

protected LoggedOperationStepHelper<RESULT_OBJECT_TYPE> getHelper()

Gets the step helper.

Returns:

The step helper.

setHelper

protected void setHelper(LoggedOperationStepHelper<RESULT_OBJECT_TYPE> helper)

Sets the step helper.

Parameters:

helper - - The step helper.

execute

public final OperationStepResult<RESULT_OBJECT_TYPE> execute(OperationContext octx,
                                                             java.lang.Object[] o1dArgs)
                                                      throws java.lang.Throwable

/** This method is designed to synchronized, because:

1. The log helper should not be modified or re-configured during executing.
   
2. If this method of this object was jammed for some reason during a calling, the jam can also happen on another calling to this method of this object
   

Specified by:

execute in interface I_OperationStep<RESULT_OBJECT_TYPE>

Parameters:

octx - - Operation context. Operation step gets all long time-range parameters from operation context; puts all result data into operation context.

o1dArgs - - 1d array of arguments.

Returns:

Operation step result.

Throws:

java.lang.Throwable - .

See Also:

I_OperationStep.execute(tfw.base.operation.context.OperationContext, java.lang.Object[])

doCatch

protected void doCatch(OperationStepResult<RESULT_OBJECT_TYPE> rst,
                       OperationContext octx,
                       java.lang.Object[] o1dArgs,
                       OperationStepException e)

Performs catching.

Parameters:

rst - - Operation step result.

octx - - Operation context. Operation step gets all long time-range parameters from operation context; puts all result data into operation context.

o1dArgs - - 1d array of arguments.

e - - Operation-step exception.

doExecute

protected void doExecute(OperationStepResult<RESULT_OBJECT_TYPE> rst,
                         OperationContext octx,
                         java.lang.Object[] o1dArgs)
                  throws java.lang.Throwable

Performs executing.

Parameters:

rst - - Operation step result.

octx - - Operation context. Operation step gets all long time-range parameters from operation context; puts all result data into operation context.

o1dArgs - - 1d array of arguments.

Throws:

java.lang.Throwable - .

doPrepare

protected void doPrepare(OperationStepResult<RESULT_OBJECT_TYPE> rst,
                         OperationContext octx,
                         java.lang.Object[] o1dArgs)
                  throws java.lang.Throwable

Performs preparing.

Parameters:

rst - - Operation step result.

octx - - Operation context. Operation step gets all long time-range parameters from operation context; puts all result data into operation context.

o1dArgs - - 1d array of arguments.

Throws:

java.lang.Throwable - .