oracle.apps.fnd.appltest.diagfwk.cli
Class HelpVerb

java.lang.Object
  oracle.apps.fnd.appltest.diagfwk.cli.BaseVerb
      oracle.apps.fnd.appltest.diagfwk.cli.HelpVerb

All Implemented Interfaces:

DiagConstants, DiagCmdConstants

public class HelpVerb
extends BaseVerb

Since:

release specific (what release of product did this appear in)

Version:

$Header: atgpf/appltest/applications/Diagnostics/Engine/src/oracle/apps/fnd/appltest/diagfwk/cli/HelpVerb.java /main/10 2009/05/29 15:33:47 ilawler Exp $

Author:

ppradhan

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.apps.fnd.appltest.diagfwk.common.DiagConstants

DiagConstants.ExecutionMode, DiagConstants.Format, DiagConstants.LinkType, DiagConstants.Status

Field Summary

Fields inherited from class oracle.apps.fnd.appltest.diagfwk.cli.BaseVerb

CMD, SH

Fields inherited from interface oracle.apps.fnd.appltest.diagfwk.engine.DiagCmdConstants

DELIM_VALUE, PARAM_APP, PARAM_CHILD_REPORTS, PARAM_CONNECT_STR, PARAM_DB_PWD, PARAM_DB_UN, PARAM_DESTDIR, PARAM_DIR, PARAM_EXEC_MODE, PARAM_EXECID, PARAM_FORMAT, PARAM_HELP, PARAM_LANG, PARAM_MAKESUBDIR, PARAM_MODID, PARAM_MODKEY, PARAM_NTHREADS, PARAM_PREREQ, PARAM_PRINTTOCONSOLE, PARAM_PRINTTREE, PARAM_PWD, PARAM_QUERY, PARAM_RECURSE, PARAM_REGISTER, PARAM_REPORT, PARAM_RUN_LOCALLY, PARAM_RUN_NAME, PARAM_RUNID, PARAM_RUNTEST, PARAM_STATUS, PARAM_TEST, PARAM_TESTFILE, PARAM_TOKEN_INPUT, PARAM_TOKEN_TAG, PARAM_TRANSLATE, PARAM_USERNAME, PARAM_VALIDATE_ONLY, PARAM_WAITFORCOMPLETION, PARAM_WRITETOFILE, PRE_POPULATED_EXECID

Fields inherited from interface oracle.apps.fnd.appltest.diagfwk.common.DiagConstants

APPS_MSG_ID_TAG_NAME, CFG_ADR_PROVIDER_CLASS, CFG_CACHE_PROVIDER_CLASS, CFG_CRED_PROVIDER_CLASS, CFG_DAO_FACTORY_CLASS, CFG_DB_CONN_INFO_PROVIDER_CLASS, CFG_DB_CONN_PROVIDER_CLASS, CFG_NLS_PROVIDER_CLASS, CFG_PLSQL_PROVIDER_CLASS, CFG_PROFILE_PROVIDER_CLASS, CFG_SECURITY_PROVIDER_CLASS, CFG_SESSION_INFO_PROVIDER_CLASS, CFG_URL_PROVIDER_FACTORY_CLASS, CFG_WLS_MBEANSRV_CONNINFO_PROVIDER_CLASS, DATA_SECURITY_PERMISSION_ALLOWED, DATA_SECURITY_PERMISSION_NOT_ALLOWED, DELIM_URL, EXEC_MODE_CLI, EXEC_MODE_ESS, EXEC_MODE_INCIDENT, EXEC_MODE_JAVA, EXEC_MODE_UI, EXECUTABLE_TYPE_JAVA, EXECUTABLE_TYPE_PLSQL, EXECUTABLE_TYPE_TESTREF, FORMAT_HTML, FORMAT_XML, GUID_ORACLE_MINUS1, GUID_ORACLE_ZERO, INPUTS_STATUS_ALL_OPT_INPUTS, INPUTS_STATUS_NO_INPUTS, INPUTS_STATUS_REQ_INPUTS_NO_DEFAULTS, INPUTS_STATUS_REQ_INPUTS_W_DEFAULTS, IO_FLAG_I, IO_FLAG_O, JMX_API_BASE_OBJECT_NAME, LINK_EXTERNAL, LINK_INTERNAL, LINK_METALINK, N, NLS_BUNDLE_JAVA_RES, NLS_BUNDLE_MSG_SVC, NLS_BUNDLE_RES_REF, NLS_BUNDLE_XLIFF, NO, NULL, ODF_MBEAN_DOMAIN_NAME, PARAM_MON_INTERVAL, PLSQL_DEBUG_ENABLED_SYSTEM_PROP, PREREQ_TYPE_TAG_VALUE, PREREQ_TYPE_TEST, SECONDS_IN_ONE_DAY, SECONDS_IN_ONE_HOUR, STATUS_CANCELED, STATUS_EXECERROR, STATUS_FAILURE, STATUS_RUNNING, STATUS_SUCCESS, STATUS_WARNING, SYS_PROP_MAX_MONITOR_INTERNVAL, SYS_PROP_MAX_NUM_THREADS, SYSPROP_APPCONNFILE, SYSPROP_DIAG_CONFIG_FILE, TAG_TYPE_DIAG, TAG_TYPE_TAXONOMY, TEST_TYPE_DECL, TEST_TYPE_JAVA, USER_NAME, WEB_APP_NAME_TAG_NAME, Y, YES

Constructor Summary

HelpVerb()

Method Summary

void	cleanup() Performs any cleanup activities required after the execution of the verb has completed.
void	execute() Overrides the execute method in order to display verb specific help.
DiagCmd	getDiagEngineCmd() Returns the diagnostics engine command to be executed for this verb.
protected java.lang.String[]	getDuplicateAllowedParamNames() Returns an array of parameter names for this verb for which multiple values are allowed.
protected java.lang.String[]	getExpectedParamNames() Returns an array of expected parameter names for this verb.
oracle.apps.fnd.appllcm.sdk.common.ResourceRef	getHelpDefinition() This API gives the user help on how to run DiagControl with the given verb.
void	processOutput(java.lang.Object o) Processes the output object produced by running the command.
protected boolean	requiresDbConn() Checks if this CLI-verb requires connection to the database.
boolean	validateArgs(NameValueList coll) This API validates the command line arguments pass to DiagControl.
boolean	validateCmdArgs()

Methods inherited from class oracle.apps.fnd.appltest.diagfwk.cli.BaseVerb

getParam, getParam, getParamList, getShellExtn, getVerbName, print, print, println, println, setParamList, setVerbName, validateDbConnectInfo, validateDuplicateParams, validateExpectedParams, validateUnPwdExist

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpVerb

public HelpVerb()

Method Detail

validateArgs

public boolean validateArgs(NameValueList coll)

Description copied from class: BaseVerb

This API validates the command line arguments pass to DiagControl.

Overrides:

validateArgs in class BaseVerb

Parameters:

coll - Collection of arguments passed to DiagControl

Returns:

A boolean flag stating whether the validation was successful or not.

validateCmdArgs

public boolean validateCmdArgs()

Specified by:

validateCmdArgs in class BaseVerb

getHelpDefinition

public oracle.apps.fnd.appllcm.sdk.common.ResourceRef getHelpDefinition()

Description copied from class: BaseVerb

This API gives the user help on how to run DiagControl with the given verb.

Specified by:

getHelpDefinition in class BaseVerb

Returns:

String with help usage for apporpiate DiagControl command.

getDiagEngineCmd

public DiagCmd getDiagEngineCmd()

Description copied from class: BaseVerb

Returns the diagnostics engine command to be executed for this verb.

Specified by:

getDiagEngineCmd in class BaseVerb

processOutput

public void processOutput(java.lang.Object o)

Description copied from class: BaseVerb

Processes the output object produced by running the command. Implementation for each verb may expected a different output object and process it accordingly.

Specified by:

processOutput in class BaseVerb

Parameters:

o - output object produced by the command for this verb.

execute

public void execute()

Overrides the execute method in order to display verb specific help.

Overrides:

execute in class BaseVerb

cleanup

public void cleanup()

Description copied from class: BaseVerb

Performs any cleanup activities required after the execution of the verb has completed.

Overrides:

cleanup in class BaseVerb

getExpectedParamNames

protected java.lang.String[] getExpectedParamNames()

Description copied from class: BaseVerb

Returns an array of expected parameter names for this verb. This list of names is used to validate the client's invocation of the verb. If the verb invocation contains any additional parameters that are not specified in this list then a validation error message is thrown.

Specified by:

getExpectedParamNames in class BaseVerb

Returns:

an array of all expected parameter names (required and optional) for this verb.

getDuplicateAllowedParamNames

protected java.lang.String[] getDuplicateAllowedParamNames()

Description copied from class: BaseVerb

Returns an array of parameter names for this verb for which multiple values are allowed. For such parameters, if clients pass multiple parameters with the same name no validation error is thrown. For parameters that are not listed in this array, if client passes in multiple instances of the same parameter name a validation error is thrown indicating that multiple occurrence of that parameter name are not allowed.

Specified by:

getDuplicateAllowedParamNames in class BaseVerb

Returns:

an array of parameter names for this verb for which multiple occurrences are allowed.

requiresDbConn

protected boolean requiresDbConn()

Description copied from class: BaseVerb

Checks if this CLI-verb requires connection to the database.

Overrides:

requiresDbConn in class BaseVerb

Returns:

true if this verb requires connection to the database. Returns false otherwise.