|
Oracle Fusion Middleware extensions for Logging and Diagnostic 11g Release 1 (11.1.1.6) E22565-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DiagContextExtn
This interface models the internal diagnostics execution context that is handed over to individual tests and test steps during their execution.
This interface extends the public DiagContext interface and is used internally by the diagnostics run command to interface with the diagnostics tests that it needs to run.
Field Summary | |
---|---|
static java.lang.String |
DISPLAY
|
static java.lang.String |
INPUT
|
static java.lang.String |
INPUT_NO_VALUE
|
static java.lang.String |
KEY_CURRENT_STEP_NAME
Key for the current step name |
static java.lang.String |
KEY_DB_CONNECTION
Key for the db connection |
static java.lang.String |
KEY_PARENT_STACK
Key for the stack of parent execution IDs |
static java.lang.String |
KEY_RESULT_CODE
Key for the result code |
static java.lang.String |
KEY_STEP_REPORT
Key for the step report |
static java.lang.String |
KEY_TEST_EXEC_MONITOR_TP
Key for the threadpool for monitoring individual test executions |
static java.lang.String |
KEY_TEST_REPORT
Key for the test report |
static java.lang.String |
KEY_TEST_RUN
Key for the test run |
static java.lang.String |
OUTPUT
|
static java.lang.String |
OUTPUT_NO_VALUE
|
static java.lang.String |
SCOPE_STEP
Top level scope for step level values |
static java.lang.String |
SCOPE_TEST
Scope name for the current test level values |
static java.lang.String |
SCOPE_TEST_INPUT
Scope name for test input |
static java.lang.String |
SCOPE_TEST_INPUT_NO_VALUE
Scope name for test input with no value specified |
static java.lang.String |
SCOPE_TEST_OUTPUT
Scope name for test output |
static java.lang.String |
SCOPE_TEST_OUTPUT_NO_VALUE
Scope name for test output with no value specified |
static java.lang.String |
SK_DELIM
Delimitor used internally to separate scope name from value key. |
Method Summary | |
---|---|
void |
addInputParamCurrentExec(java.lang.String pParamName,
java.lang.Object pParamValue)
Sets the value of the given input parameter for the current execution in this context as determined by calling the getCurrentTestExecId() API. |
void |
addInputParamCurrentStep(java.lang.String pParamName,
java.lang.Object pParamValue)
Sets the value of the given input parameter for the current step in this test as determined by calling the getCurrentStepName() API. |
void |
addInputParamDisplayCurrentExec(java.lang.String pParamName,
java.lang.String pParamDisplayName)
Sets the displayName value of the given input parameter for the current execution in this context as determined by calling the getCurrentTestExecId() API. |
void |
addInputParamsTest(NameValueList pParams)
Adds the given input parameters for this test into the context at the scope of the current test |
void |
addInputParamTest(java.lang.String pParamName,
java.lang.Object pParamValue)
Sets the value of the given input parameter for this test. |
void |
addOutputParam(java.lang.String pExecId,
java.lang.String pStepName,
java.lang.String pParamName,
java.lang.Object pParamValue)
Adds the given output paramter at the given execution and step scope. |
void |
addOutputParamCurrentExec(java.lang.String pParamName,
java.lang.Object pParamValue)
Sets the value of the given output parameter into the current execution scope |
void |
addOutputParamDisplayCurrentExec(java.lang.String pParamName,
java.lang.String pParamDisplayName)
Sets the displayName value of the given output parameter into the current execution scope |
void |
cleanup()
Cleans up the existing state in this context. |
java.lang.Object |
get(java.lang.String pScope,
java.lang.String pKey)
Gets an object from the context under the given scope and with the given key |
java.lang.String |
getCurrentParentExecId()
Gets the current execution's parent execution id. |
java.lang.String |
getCurrentParentStepName()
Gets the current execution's parent step name. |
java.lang.String |
getCurrentStepName()
Returns the name of the current step that is being executed for this test. |
java.lang.Object |
getCurrentStepOutputParam(java.lang.String pParamName)
Gets the given output parameter value from the current step |
java.lang.Object |
getCurrentStepScope(java.lang.String pKey)
Gets the object with the given key from the current execution and current step scope. |
TestExec |
getCurrentTestExec()
Gets the TestExec object that represents the current execution |
java.lang.String |
getCurrentTestExecId()
Gets the execution ID for the current execution |
java.lang.Object |
getCurrentTestExecScope(java.lang.String pKey)
Gets the given object from the current test execution scope |
TestRun |
getCurrentTestRun()
Returns the TestRun object that models the current test run. |
java.util.concurrent.ExecutorService |
getExecutorService()
Gets the executor service from the context |
java.lang.Object |
getGlobal(java.lang.String pParam)
Gets the value of the given parameter from the global scope |
java.lang.Object |
getInputParamCurrentExec(java.lang.String pParamName)
Gets the value of the given input parameter from the current execution scope. |
java.lang.Object |
getInputParamCurrentStep(java.lang.String pParamName)
Gets the value of the given input parameter from the current step scope. |
TestParam |
getInputParamDef(java.lang.String pParamName)
Returns the definition for the input parameter with the given name |
java.lang.String |
getInputParamDisplayCurrentExec(java.lang.String pParamName)
Gets the displayName value of the given input parameter from the current execution scope. |
java.lang.String |
getInputParamDisplayCurrentStep(java.lang.String pParamName)
Gets the displayName value of the given input parameter from the current step scope. |
java.util.List<java.lang.String> |
getInputParamNamesCurrentExec()
Returns the list of input parameter names at the current execution scope |
java.util.List<java.lang.String> |
getInputParamNamesCurrentStep()
Returns the list of input parameter names at the current step scope |
java.util.List<java.lang.String> |
getInputParamNamesTest()
Returns the list of input parameter names at the test scope |
java.lang.Object |
getInputParamTest(java.lang.String pParamName)
Gets the input parameter with the given name from the test scope |
java.lang.Object |
getOutputParamCurrentExec(java.lang.String pParamName)
Gets the value of the given output parameter from the current execution scope. |
java.lang.Object |
getOutputParamCurrentExecForStep(java.lang.String pStepName,
java.lang.String pParamName)
Gets the value of the given output parameter from the given step within the current execution scope. |
java.lang.Object |
getOutputParamCurrentStep(java.lang.String pParamName)
Gets the value of the given output parameter from the current step scope |
TestParam |
getOutputParamDef(java.lang.String pParamName)
Returns the definition for the output parameter with the given name |
java.lang.String |
getOutputParamDisplayCurrentExec(java.lang.String pParamName)
Gets the displayName value of the given output parameter from the current execution scope. |
java.lang.String |
getOutputParamDisplayCurrentStep(java.lang.String pParamName)
Gets the displayName value of the given output parameter from the current step scope |
java.util.List<java.lang.String> |
getOutputParamNamesCurrentExec()
Returns the list of output parameter names at the current execution scope |
java.util.List<java.lang.String> |
getOutputParamNamesCurrentStep()
Returns the list of output parameter names at the current step scope |
TestExec |
getRootTestExec()
Gets the TestExec objec that represents the root execution |
java.lang.String |
getRootTestExecId()
Gets the execution ID for the root execution that started this execution |
java.lang.String |
getScopeDelimitor()
Returns the value of the delimitor used by the context |
java.lang.String |
getScopeNameExec(java.lang.String pExecId)
Returns the name of the scope for the given execution id |
java.lang.String |
getScopeNameExecInput(java.lang.String pExecId)
Returns the name for the input scope for the given execution id |
java.lang.String |
getScopeNameStep(java.lang.String pExecId,
java.lang.String pStepName)
Returns the name of the scope for the given execution id and the given step in the execution id |
java.lang.String |
getScopeNameStepInput(java.lang.String pExecId,
java.lang.String pStepName)
Returns the name of the input scope for the given execution id and given step in the execution id |
java.lang.String |
getScopeNameTestInput()
Returns the name of the "test.input" scope |
java.lang.String |
getScopeNameTestOutput()
Returns the name of the "test.output" scope |
StepReportExtn |
getStepReportExtn()
Returns the internal interface to the current step report from the context. |
TestExec |
getTestExec(java.lang.String pExecId)
Gets the TestExec object from the context with the given execution id |
TestReportExtn |
getTestReportExtn()
Returns the internal interface to the current test report from the context |
java.util.List<java.lang.String> |
keys(java.lang.String pScope)
Returns the keys for all the entities within the given scope |
java.lang.String |
popParentExecId()
Pops the current parent execution Id from the stack of parent execution IDs. |
java.lang.String |
popParentStepName()
Pops the current parent step name from the stack of parent step names. |
void |
pushParentExecId(java.lang.String pParentExecId)
Pushes the given parent execution Id to the stack of parent execution Id's for the current execution. |
void |
pushParentStepName(java.lang.String pParentStepName)
Pushes the given parent step name to the stack of parent step names for the current execution. |
void |
put(java.lang.String pScope,
java.lang.String pKey,
java.lang.Object pValue)
Adds an object to the context under the given scope and with the given key. |
void |
putCurrentStepScope(java.lang.String pKey,
java.lang.Object pValue)
Puts the given object with the given key under the current execution and current step scope. |
void |
putCurrentTestExecScope(java.lang.String pKey,
java.lang.Object pVal)
Adds the given object into the current test execution scope. |
void |
putGlobal(java.lang.String pParam,
java.lang.Object pVal)
Puts the given object into the global scope of the context |
void |
remove(java.lang.String pScope,
java.lang.String pKey)
Removes an object from the context under the given scope and with the given key. |
void |
removeCurrentStepScope(java.lang.String pKey)
Removes the object with the given key from the current execution and current step scope. |
void |
removeCurrentTestExecScope(java.lang.String pKey)
Removes the object with the given key from the current test execution scope |
void |
setConnection(java.sql.Connection pConnection)
Sets the Connection to the Applications database in the context for this test. |
void |
setCurrentStepName(java.lang.String pStepName)
Sets the name of the current step that is going to be executed. |
void |
setCurrentTestExec(TestExec pExec)
Sets the given TestExec object as the currently executing test |
void |
setCurrentTestRun(TestRun pTestrun)
Sets the current run's TestRun object |
void |
setExecutorService(java.util.concurrent.ExecutorService pSvc)
Sets the given executor service into the context. |
void |
setRootTestExec(TestExec pExec)
Sets the given TestExec object as the root execution |
Methods inherited from interface oracle.apps.fnd.appltest.diagfwk.api.DiagContext |
---|
addOutputParam, getConnection, getInputParam, getInputParamNames, getStepReport, getTestReport |
Field Detail |
---|
static final java.lang.String SK_DELIM
static final java.lang.String SCOPE_TEST
static final java.lang.String SCOPE_STEP
static final java.lang.String INPUT
static final java.lang.String INPUT_NO_VALUE
static final java.lang.String OUTPUT
static final java.lang.String OUTPUT_NO_VALUE
static final java.lang.String DISPLAY
static final java.lang.String SCOPE_TEST_INPUT
static final java.lang.String SCOPE_TEST_INPUT_NO_VALUE
static final java.lang.String SCOPE_TEST_OUTPUT
static final java.lang.String SCOPE_TEST_OUTPUT_NO_VALUE
static final java.lang.String KEY_CURRENT_STEP_NAME
static final java.lang.String KEY_TEST_REPORT
static final java.lang.String KEY_STEP_REPORT
static final java.lang.String KEY_DB_CONNECTION
static final java.lang.String KEY_RESULT_CODE
static final java.lang.String KEY_TEST_RUN
static final java.lang.String KEY_TEST_EXEC_MONITOR_TP
static final java.lang.String KEY_PARENT_STACK
Method Detail |
---|
java.lang.String getCurrentStepName()
void setCurrentStepName(java.lang.String pStepName)
pStepName
- the name of the current
step that is being executed.void addInputParamsTest(NameValueList pParams)
pParams
- the list of input parameters.void addInputParamTest(java.lang.String pParamName, java.lang.Object pParamValue)
pParamName
- the name of the input parameterpParamValue
- the value for the input parameter.void addInputParamCurrentExec(java.lang.String pParamName, java.lang.Object pParamValue) throws DiagfwkException
The input parameter value is set at the scope of the current execution in the test.
pParamName
- name of the parameterpParamValue
- value of the parameter.
DiagfwkException
- if the value of the
current execution is not set prior to calling this API.void addInputParamDisplayCurrentExec(java.lang.String pParamName, java.lang.String pParamDisplayName) throws DiagfwkException
The input parameter value is set at the scope of the current execution in the test.
pParamName
- name of the parameterpParamDisplayName
- displayName value of the parameter.
DiagfwkException
- if the value of the
current execution is not set prior to calling this API.void addOutputParamCurrentExec(java.lang.String pParamName, java.lang.Object pParamValue) throws DiagfwkException
pParamName
- name of the parameterpParamValue
- value of the parameter
DiagfwkException
- in case of unsupported parameter typevoid addOutputParamDisplayCurrentExec(java.lang.String pParamName, java.lang.String pParamDisplayName) throws DiagfwkException
pParamName
- name of the parameterpParamDisplayName
- display value of the parameter
DiagfwkException
- in case of unsupported parameter typevoid addOutputParam(java.lang.String pExecId, java.lang.String pStepName, java.lang.String pParamName, java.lang.Object pParamValue)
pExecId
- ID for the execution scope to which to add the parampStepName
- name of the step scope to which to add the parampParamName
- name of the parampParamValue
- value for the paramvoid addInputParamCurrentStep(java.lang.String pParamName, java.lang.Object pParamValue) throws DiagfwkException
The input parameter value is set at the scope of the current step in the test.
pParamName
- name of the parameterpParamValue
- value of the parameter.
DiagfwkException
- if the value of the
current step is not set prior to calling this API.void put(java.lang.String pScope, java.lang.String pKey, java.lang.Object pValue)
pScope
- the name of the scope at which to set the
object.pKey
- the name of the keypValue
- the value of the input parameterjava.lang.Object get(java.lang.String pScope, java.lang.String pKey)
pScope
- scope for the object to getpKey
- key for the object to get
void remove(java.lang.String pScope, java.lang.String pKey)
pScope
- the scope name for the object to
remove.pKey
- the key for the object to remove.void setConnection(java.sql.Connection pConnection)
pConnection
- connection to the
Applications database.void cleanup()
java.lang.Object getCurrentStepOutputParam(java.lang.String pParamName)
pParamName
- name of the output parameter
java.lang.String getScopeNameTestInput()
java.lang.String getScopeNameTestOutput()
java.lang.String getScopeNameExecInput(java.lang.String pExecId)
pExecId
- execution id
java.lang.String getScopeNameExec(java.lang.String pExecId)
pExecId
- execution id
java.lang.String getScopeNameStepInput(java.lang.String pExecId, java.lang.String pStepName)
pExecId
- execution idpStepName
- name of the step
java.lang.String getScopeNameStep(java.lang.String pExecId, java.lang.String pStepName)
pExecId
- execution idpStepName
- name of the step in the execution id
java.lang.String getScopeDelimitor()
TestRun getCurrentTestRun()
void setCurrentTestRun(TestRun pTestrun)
pTestrun
- current run's TestRun objectTestExec getCurrentTestExec()
TestExec getTestExec(java.lang.String pExecId)
pExecId
- the execution id for the TestExec object to
get from the context
TestExec getRootTestExec()
java.lang.String getCurrentTestExecId()
java.lang.String getRootTestExecId()
void setRootTestExec(TestExec pExec)
pExec
- void setCurrentTestExec(TestExec pExec)
pExec
- currently executing TestExec objectjava.lang.String getCurrentParentExecId()
void pushParentExecId(java.lang.String pParentExecId)
pParentExecId
- execution Id to push to the stack
of parent execution IDs.java.lang.String popParentExecId()
java.lang.Object getGlobal(java.lang.String pParam)
pParam
- name of the parameter
void putGlobal(java.lang.String pParam, java.lang.Object pVal)
pParam
- parameter namepVal
- value for the parametervoid putCurrentTestExecScope(java.lang.String pKey, java.lang.Object pVal)
pKey
- key for the objectpVal
- object to be added into the current test execution
scope.java.lang.Object getCurrentTestExecScope(java.lang.String pKey)
pKey
- the key for the object
void removeCurrentTestExecScope(java.lang.String pKey)
pKey
- the key for the object to removevoid setExecutorService(java.util.concurrent.ExecutorService pSvc)
pSvc
- executor servicejava.util.concurrent.ExecutorService getExecutorService()
java.lang.Object getInputParamTest(java.lang.String pParamName)
pParamName
- name of the parameter
java.lang.Object getInputParamCurrentExec(java.lang.String pParamName)
pParamName
- name of the parameter
java.lang.String getInputParamDisplayCurrentExec(java.lang.String pParamName)
pParamName
- name of the parameter
java.lang.Object getInputParamCurrentStep(java.lang.String pParamName)
pParamName
- name of the parameter
java.lang.String getInputParamDisplayCurrentStep(java.lang.String pParamName)
pParamName
- name of the parameter
java.lang.Object getOutputParamCurrentExec(java.lang.String pParamName)
pParamName
- name of the output parameter
java.lang.String getOutputParamDisplayCurrentExec(java.lang.String pParamName)
pParamName
- name of the output parameter
java.lang.Object getOutputParamCurrentStep(java.lang.String pParamName)
pParamName
- name of the output parameter
java.lang.String getOutputParamDisplayCurrentStep(java.lang.String pParamName)
pParamName
- name of the output parameter
java.lang.Object getOutputParamCurrentExecForStep(java.lang.String pStepName, java.lang.String pParamName)
pStepName
- name of the step from which to get the output
parameterpParamName
- name of the output parameter
java.util.List<java.lang.String> getInputParamNamesTest()
TestParam getInputParamDef(java.lang.String pParamName)
pParamName
- name of parameter
java.util.List<java.lang.String> getInputParamNamesCurrentExec()
java.util.List<java.lang.String> getOutputParamNamesCurrentExec()
TestParam getOutputParamDef(java.lang.String pParamName)
pParamName
- name of parameter
java.util.List<java.lang.String> getInputParamNamesCurrentStep()
java.util.List<java.lang.String> getOutputParamNamesCurrentStep()
java.util.List<java.lang.String> keys(java.lang.String pScope)
pScope
- name of the scope
void putCurrentStepScope(java.lang.String pKey, java.lang.Object pValue)
pKey
- key for the objectpValue
- the object to store in the contextjava.lang.Object getCurrentStepScope(java.lang.String pKey)
pKey
- key for the object to retrieve
void removeCurrentStepScope(java.lang.String pKey)
pKey
- key for the object to removejava.lang.String getCurrentParentStepName()
void pushParentStepName(java.lang.String pParentStepName)
pParentStepName
- step name to push to the stack
of parent step namesjava.lang.String popParentStepName()
StepReportExtn getStepReportExtn()
TestReportExtn getTestReportExtn()
|
Oracle Fusion Middleware extensions for Logging and Diagnostic 11g Release 1 (11.1.1.6) E22565-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |