|
Oracle Fusion Middleware extensions for Logging and Diagnostics 11g Release 1 (11.1.2) E22565-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.apps.fnd.appltest.diagfwk.engine.facade.TestDefFacade oracle.apps.fnd.appltest.diagfwk.api.external.DiagnosticsTestFramework
public class DiagnosticsTestFramework
This class is the Diagnostics Test Public API. Fusion framework or application that wants that access the Application Diagnostics Framework (or Oracle Diagnostics Framework, ODF), should use this public API instead of the facade classes, such as TestDefFacade and TestRunFacade, which are meant to be internal entry points.
Method Summary | |
---|---|
static java.lang.String |
getODFDashboardURL()
Gets the URL to the Diagnostics Dashboard UI application. |
static java.lang.String |
getTestExecReportURL(java.lang.String executionId)
Gets the URL to the Execution report for the given test execution ID. |
static java.lang.String |
getTestRunReportURL(java.lang.String runId)
Gets the URL to the Run report for the given run ID. |
static TestRunStatus |
run(java.lang.String[] testNames,
java.lang.String[] products,
java.lang.String[] moduleIds,
java.lang.String[] moduleKeys,
java.lang.String[] tagNames,
java.lang.String[] tagValues,
java.lang.String runName,
java.lang.Boolean recurse,
java.lang.Boolean runPrereq,
java.lang.Integer monitorInterval,
java.lang.Integer numThreads,
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> inputParams,
java.lang.Boolean asynchronous)
Run tests specified by test names, product, module id, module key, and/or tag name/value pair (one of those must not be null) with the given settings. |
static TestRunStatus |
runByModuleId(java.lang.String[] moduleIds,
java.lang.String runName,
java.lang.Boolean recurse,
java.lang.Boolean runPrereq,
java.lang.Integer monitorInterval,
java.lang.Integer numThreads,
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> inputParams,
java.lang.Boolean asynchronous)
Run tests specified by the module id with the given settings. |
static TestRunStatus |
runByModuleKey(java.lang.String[] moduleKeys,
java.lang.String runName,
java.lang.Boolean recurse,
java.lang.Boolean runPrereq,
java.lang.Integer monitorInterval,
java.lang.Integer numThreads,
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> inputParams,
java.lang.Boolean asynchronous)
Run tests specified by the module key with the given settings. |
static TestRunStatus |
runByProduct(java.lang.String[] products,
java.lang.String runName,
java.lang.Boolean recurse,
java.lang.Boolean runPrereq,
java.lang.Integer monitorInterval,
java.lang.Integer numThreads,
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> inputParams,
java.lang.Boolean asynchronous)
Run tests specified by the product with the given settings. |
static TestRunStatus |
runByTag(java.lang.String[] tagNames,
java.lang.String[] tagValues,
java.lang.String runName,
java.lang.Boolean recurse,
java.lang.Boolean runPrereq,
java.lang.Integer monitorInterval,
java.lang.Integer numThreads,
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> inputParams,
java.lang.Boolean asynchronous)
Run tests specified by the tag name/value pair with the given settings. |
static TestRunStatus |
runByTestName(java.lang.String[] testNames,
java.lang.String runName,
java.lang.Boolean recurse,
java.lang.Boolean runPrereq,
java.lang.Integer monitorInterval,
java.lang.Integer numThreads,
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> inputParams,
java.lang.Boolean asynchronous)
Run tests specified by the test names with the given settings. |
static TestRunStatus |
statusByRunId(java.lang.String runId)
Get the status of a test run given its id |
static java.util.List<TestRunStatus> |
statusByRunName(java.lang.String runName)
Get the list of the test statuses whose run name matches the given run name |
Methods inherited from class oracle.apps.fnd.appltest.diagfwk.engine.facade.TestDefFacade |
---|
addTagToTests, computeInputsStatus, executeTestsForRun, getTestAvailabilityInfo, getWebApplicationsAvailableForTest, hasRequiredInputParams, prepareTreeNodes, queryInputOutputParams, queryInputParams, queryInputSets, queryPrereqTests, querySummary, queryTagValues, registerXMLTests, removeTagFromTests, runTests, runTests, runTests, runTests, unRegisterTests |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static TestRunStatus runByTestName(java.lang.String[] testNames, java.lang.String runName, java.lang.Boolean recurse, java.lang.Boolean runPrereq, java.lang.Integer monitorInterval, java.lang.Integer numThreads, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> inputParams, java.lang.Boolean asynchronous)
testNames
- List of one or more names of the tests to run,
must not be null or empty.runName
- The name of the test run, if null, this will be generated.recurse
- If TRUE, runs all tests associated with the specified taxonomy
modules and/or diagnostic tags. If FALSE, runs only the tests
immediately associated with the specified taxonomy modules
and/or diagnostic tags. If null, defaults to TRUE.runPrereq
- If TRUE, performs a prerequisite analysis to identify any
prerequisite tests and runs those prior to running the
specified tests. If FALSE, runs only the specified tests.
If null, defaults to FALSEmonitorInterval
- The monitoring interval in seconds. This parameter specifies
the interval in which the status of the run is uploaded to
the test repository. If null, defaults to 30 seconds.numThreads
- The number of parallel threads that should be spawned to
execute tests in this run. Specifying a value of 1 for this
parameter will execute the tests serially. The value must be
between 1 and the value specified in the system property
"oracle.odf.run.maxthreads", or 100 if the system property
is not set. If null, defaults to 5.inputParams
- For each test, a set of parameter values can be fed. Can be null.asynchronous
- If TRUE, tests are run asynchronously. Otherwise, they are run
synchronously. If null, defaults to TRUE
DiagfwkException
- if testNames is null or emptypublic static TestRunStatus runByProduct(java.lang.String[] products, java.lang.String runName, java.lang.Boolean recurse, java.lang.Boolean runPrereq, java.lang.Integer monitorInterval, java.lang.Integer numThreads, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> inputParams, java.lang.Boolean asynchronous)
products
- List of products whose associated tests to run,
must not be null or empty.runName
- The name of the test run, if null, this will be generated.recurse
- If TRUE, runs all tests associated with the specified taxonomy
modules and/or diagnostic tags. If FALSE, runs only the tests
immediately associated with the specified taxonomy modules
and/or diagnostic tags. If null, defaults to TRUE.runPrereq
- If TRUE, performs a prerequisite analysis to identify any
prerequisite tests and runs those prior to running the
specified tests. If FALSE, runs only the specified tests.
If null, defaults to FALSEmonitorInterval
- The monitoring interval in seconds. This parameter specifies
the interval in which the status of the run is uploaded to
the test repository. If null, defaults to 30 seconds.numThreads
- The number of parallel threads that should be spawned to
execute tests in this run. Specifying a value of 1 for this
parameter will execute the tests serially. The value must be
between 1 and the value specified in the system property
"oracle.odf.run.maxthreads", or 100 if the system property
is not set. If null, defaults to 5.inputParams
- For each test, a set of parameter values can be fed. Can be null.asynchronous
- If TRUE, tests are run asynchronously. Otherwise, they are run
synchronously. If null, defaults to TRUE
DiagfwkException
- if product is nullpublic static TestRunStatus runByModuleId(java.lang.String[] moduleIds, java.lang.String runName, java.lang.Boolean recurse, java.lang.Boolean runPrereq, java.lang.Integer monitorInterval, java.lang.Integer numThreads, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> inputParams, java.lang.Boolean asynchronous)
moduleIds
- List of module ids whose associated tests to run,
must not be null or empty.runName
- The name of the test run, if null, this will be generated.recurse
- If TRUE, runs all tests associated with the specified taxonomy
modules and/or diagnostic tags. If FALSE, runs only the tests
immediately associated with the specified taxonomy modules
and/or diagnostic tags. If null, defaults to TRUE.runPrereq
- If TRUE, performs a prerequisite analysis to identify any
prerequisite tests and runs those prior to running the
specified tests. If FALSE, runs only the specified tests.
If null, defaults to FALSEmonitorInterval
- The monitoring interval in seconds. This parameter specifies
the interval in which the status of the run is uploaded to
the test repository. If null, defaults to 30 seconds.numThreads
- The number of parallel threads that should be spawned to
execute tests in this run. Specifying a value of 1 for this
parameter will execute the tests serially. The value must be
between 1 and the value specified in the system property
"oracle.odf.run.maxthreads", or 100 if the system property
is not set. If null, defaults to 5.inputParams
- For each test, a set of parameter values can be fed. Can be null.asynchronous
- If TRUE, tests are run asynchronously. Otherwise, they are run
synchronously. If null, defaults to TRUE
DiagfwkException
- if moduleId is null or invalidpublic static TestRunStatus runByModuleKey(java.lang.String[] moduleKeys, java.lang.String runName, java.lang.Boolean recurse, java.lang.Boolean runPrereq, java.lang.Integer monitorInterval, java.lang.Integer numThreads, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> inputParams, java.lang.Boolean asynchronous)
moduleKeys
- List of module keys whose associated tests to run,
must not be null or empty.runName
- The name of the test run, if null, this will be generated.recurse
- If TRUE, runs all tests associated with the specified taxonomy
modules and/or diagnostic tags. If FALSE, runs only the tests
immediately associated with the specified taxonomy modules
and/or diagnostic tags. If null, defaults to TRUE.runPrereq
- If TRUE, performs a prerequisite analysis to identify any
prerequisite tests and runs those prior to running the
specified tests. If FALSE, runs only the specified tests.
If null, defaults to FALSEmonitorInterval
- The monitoring interval in seconds. This parameter specifies
the interval in which the status of the run is uploaded to
the test repository. If null, defaults to 30 seconds.numThreads
- The number of parallel threads that should be spawned to
execute tests in this run. Specifying a value of 1 for this
parameter will execute the tests serially. The value must be
between 1 and the value specified in the system property
"oracle.odf.run.maxthreads", or 100 if the system property
is not set. If null, defaults to 5.inputParams
- For each test, a set of parameter values can be fed. Can be null.asynchronous
- If TRUE, tests are run asynchronously. Otherwise, they are run
synchronously. If null, defaults to TRUE
DiagfwkException
- if moduleKey is nullpublic static TestRunStatus runByTag(java.lang.String[] tagNames, java.lang.String[] tagValues, java.lang.String runName, java.lang.Boolean recurse, java.lang.Boolean runPrereq, java.lang.Integer monitorInterval, java.lang.Integer numThreads, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> inputParams, java.lang.Boolean asynchronous)
tagNames
- List of tag names whose associated tests to run,
must not be null or empty.
The size of tagNames must be equal to that of tagValuestagValues
- List of tag value whose associated tests to run,
must not be null or empty.
The size of tagNames must be equal to that of tagValuesrunName
- The name of the test run, if null, this will be generated.recurse
- If TRUE, runs all tests associated with the specified taxonomy
modules and/or diagnostic tags. If FALSE, runs only the tests
immediately associated with the specified taxonomy modules
and/or diagnostic tags. If null, defaults to TRUE.runPrereq
- If TRUE, performs a prerequisite analysis to identify any
prerequisite tests and runs those prior to running the
specified tests. If FALSE, runs only the specified tests.
If null, defaults to FALSEmonitorInterval
- The monitoring interval in seconds. This parameter specifies
the interval in which the status of the run is uploaded to
the test repository. If null, defaults to 30 seconds.numThreads
- The number of parallel threads that should be spawned to
execute tests in this run. Specifying a value of 1 for this
parameter will execute the tests serially. The value must be
between 1 and the value specified in the system property
"oracle.odf.run.maxthreads", or 100 if the system property
is not set. If null, defaults to 5.inputParams
- For each test, a set of parameter values can be fed. Can be null.asynchronous
- If TRUE, tests are run asynchronously. Otherwise, they are run
synchronously. If null, defaults to TRUE
DiagfwkException
- if tagName or tagValue is nullpublic static TestRunStatus run(java.lang.String[] testNames, java.lang.String[] products, java.lang.String[] moduleIds, java.lang.String[] moduleKeys, java.lang.String[] tagNames, java.lang.String[] tagValues, java.lang.String runName, java.lang.Boolean recurse, java.lang.Boolean runPrereq, java.lang.Integer monitorInterval, java.lang.Integer numThreads, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> inputParams, java.lang.Boolean asynchronous)
testNames
- List of one or more names of the tests to run.products
- List of products whose associated tests to run.moduleIds
- List of module ids whose associated tests to run.moduleKeys
- List of module keys whose associated tests to run.tagNames
- List of tag names whose associated tests to run.
The size of tagNames must be equal to that of tagValuestagValues
- List of tag values whose associated tests to run.
The size of tagNames must be equal to that of tagValuesrunName
- The name of the test run, if null, this will be generated.recurse
- If TRUE, runs all tests associated with the specified taxonomy
modules and/or diagnostic tags. If FALSE, runs only the tests
immediately associated with the specified taxonomy modules
and/or diagnostic tags. If null, defaults to TRUE.runPrereq
- If TRUE, performs a prerequisite analysis to identify any
prerequisite tests and runs those prior to running the
specified tests. If FALSE, runs only the specified tests.
If null, defaults to FALSEmonitorInterval
- The monitoring interval in seconds. This parameter specifies
the interval in which the status of the run is uploaded to
the test repository. If null, defaults to 30 seconds.numThreads
- The number of parallel threads that should be spawned to
execute tests in this run. Specifying a value of 1 for this
parameter will execute the tests serially. The value must be
between 1 and the value specified in the system property
"oracle.odf.run.maxthreads", or 100 if the system property
is not set. If null, defaults to 5.inputParams
- For each test, a set of parameter values can be fed. Can be null.asynchronous
- If TRUE, tests are run asynchronously. Otherwise, they are run
synchronously. If null, defaults to TRUE
DiagfwkException
- if all of the test-specifying parameters {testNames, product,
moduleId, moduleKey, tagName/Value} are null or invalid,
or if the run name is already used,
or if the monitor interval is less than 0 or greater than 1 day
or if the number of threads is less than 0 or greater than 100public static TestRunStatus statusByRunId(java.lang.String runId)
runId
-
public static java.util.List<TestRunStatus> statusByRunName(java.lang.String runName)
runName
- the run name that can contain wild cards (i.e %)
public static java.lang.String getTestRunReportURL(java.lang.String runId)
runId
- Run ID for which to get the run report URL.
DiagfwkException
- when it is not able to construct the URL
eventhough the runId is valid. This might happen in case the
DIAGNOSTICS_DASHBOARD_URL profile option is not set or set to an invalid
value.public static java.lang.String getTestExecReportURL(java.lang.String executionId)
executionId
- ID for the test execution.
DiagfwkException
- when it is not able to construct the URL
eventhough the executionId is valid. This might happen in case the
DIAGNOSTICS_DASHBOARD_URL profile option is not set or set to an invalid
value.public static java.lang.String getODFDashboardURL()
|
Oracle Fusion Middleware extensions for Logging and Diagnostics 11g Release 1 (11.1.2) E22565-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |