rundeck-api-java-client/testapidocs/proof-read.txt

javadoc proofread file: ./proof-read.txt


=== reference/org/rundeck/api/package-descr.html ===


=== reference/org/rundeck/api/parser/package-descr.html ===


=== reference/org/rundeck/api/util/package-descr.html ===


=== reference/packages.html ===


=== org/rundeck/api/parser/SystemInfoParserTest.html ===
        Test the
        {@link/SystemInfoParser}
CONSTRUCTOR: SystemInfoParserTest
METHOD: parseProject


=== org/rundeck/api/parser/StringParserTest.html ===
        Test the
        {@link/StringParser}
CONSTRUCTOR: StringParserTest
METHOD: parseJob


=== org/rundeck/api/parser/ProjectParserTest.html ===
        Test the
        {@link/ProjectParser}
CONSTRUCTOR: ProjectParserTest
METHOD: parseProject


=== org/rundeck/api/parser/ParserHelperTest.html ===
        Test the
        {@link/ParserHelper}
CONSTRUCTOR: ParserHelperTest
METHOD: loadEmptyDocument
        XML with no result should NOT throw an exception
METHOD: loadErrorDocument
        XML with an explicit "error" result should throw an exception
METHOD: loadSuccessDocument
        XML with an explicit "success" result should NOT throw an exception


=== org/rundeck/api/parser/NodeParserTest.html ===
        Test the
        {@link/NodeParser}
CONSTRUCTOR: NodeParserTest
METHOD: parseNode


=== org/rundeck/api/parser/ListParserTest.html ===
        Test the
        {@link/ListParser}
CONSTRUCTOR: ListParserTest
METHOD: parseExecutions
METHOD: parseJobs
METHOD: parseNodes
METHOD: parseProjects


=== org/rundeck/api/parser/JobsImportResultParserTest.html ===
        Test the
        {@link/JobsImportResultParser}
CONSTRUCTOR: JobsImportResultParserTest
METHOD: parseResult


=== org/rundeck/api/parser/JobParserTest.html ===
        Test the
        {@link/JobParser}
CONSTRUCTOR: JobParserTest
METHOD: parseExecutionJob1
METHOD: parseExecutionJob2
METHOD: parseJob


=== org/rundeck/api/parser/HistoryParserTest.html ===
        Test the
        {@link/HistoryParser}
CONSTRUCTOR: HistoryParserTest
METHOD: parseHistory


=== org/rundeck/api/parser/ExecutionParserTest.html ===
        Test the
        {@link/ExecutionParser}
CONSTRUCTOR: ExecutionParserTest
METHOD: parseAdhocExecution
METHOD: parseMinimalistExecution
METHOD: parseRunningExecution
METHOD: parseSucceededExecution


=== org/rundeck/api/parser/EventParserTest.html ===
        Test the
        {@link/EventParser}
CONSTRUCTOR: EventParserTest
METHOD: parseAdhocEvent
METHOD: parseSucceededEvent


=== org/rundeck/api/parser/DeleteParserTest.html ===
        DeleteParserTest is ...
CONSTRUCTOR: DeleteParserTest
METHOD: failedResult1
METHOD: failedResult2
METHOD: failedResult3
METHOD: successfulResult


=== org/rundeck/api/parser/BulkDeleteParserTest.html ===
        BulkDeleteParserTest is ...
CONSTRUCTOR: BulkDeleteParserTest
METHOD: bulkParser
METHOD: bulkParserAllsuccessful


=== org/rundeck/api/parser/AbortParserTest.html ===
        Test the
        {@link/AbortParser}
CONSTRUCTOR: AbortParserTest
METHOD: parseFailedAbort
METHOD: parsePendingAbort


=== org/rundeck/api/RundeckClientTest.html ===
        Test the
        {@link/RundeckClient}
        . Uses betamax to unit-test HTTP requests without a live RunDeck instance.
FIELD: TEST_TOKEN_0
        Note: to add a new test, do the following:
         1) start a rundeck server, available at hostname "rundeck.local"
         2) login as test or admin user, and generate a token
         3) add the test token as a new TEST_TOKEN_X, and use that in your test
         4) run 'mvn test', and commit the new yml file generated at src/test/resources/betamax/tapes
FIELD: TEST_TOKEN_1
FIELD: TEST_TOKEN_2
FIELD: TEST_TOKEN_3
FIELD: TEST_TOKEN_4
FIELD: recorder
CONSTRUCTOR: RundeckClientTest
METHOD: abortExecution
METHOD: abortExecutionAsUser
METHOD: abortExecutionAsUserUnauthorized
METHOD: bulkDelete
METHOD: bulkDeleteFailDNE
METHOD: bulkDeleteFailUnauthorized
METHOD: getExecutions
METHOD: getExecutionsPaging
        Test paging values from results
METHOD: getHistory
METHOD: getHistoryExcludeJoblist
METHOD: getHistoryJoblist
METHOD: getHistoryUser
METHOD: getProjects
METHOD: importJobsContextProject
        Import jobs, xml contains project context
METHOD: importJobsNoProject
        Import jobs, xml no project defined
METHOD: importJobsProjectParam
        Import jobs, using project parameter
METHOD: importJobsProjectParamOverride
        Import jobs, project parameter overrides xml
METHOD: importJobsProjectParamV7
        Import jobs, project parameter v7 doesn' use parameter
METHOD: setUp
METHOD: triggerAdhocCommand
METHOD: triggerAdhocCommandAsUser
METHOD: triggerAdhocCommandAsUserUnauthorized
METHOD: triggerAdhocCommandDeprecated
METHOD: triggerAdhocCommandDeprecatedAsUser
METHOD: triggerAdhocCommandDeprecatedAsUserUnauthorized
METHOD: triggerAdhocScript
METHOD: triggerAdhocScriptAsUser
METHOD: triggerAdhocScriptAsUserUnauthorized
METHOD: triggerAdhocScriptDeprecated
METHOD: triggerAdhocScriptDeprecatedAsUser
METHOD: triggerAdhocScriptDeprecatedAsUserUnauthorized
METHOD: triggerAdhocScriptInpterpreter
METHOD: triggerJobAsUser
METHOD: triggerJobAsUserUnauthorized
METHOD: triggerJobBasic
METHOD: triggerJobDeprecatedAsUser
METHOD: triggerJobDeprecatedAsUserUnauthorized
METHOD: triggerJobDeprecatedBasic


=== org/rundeck/api/util/ParametersUtilTest.html ===
        Test the
        {@link/ParametersUtil}
CONSTRUCTOR: ParametersUtilTest
METHOD: generateArgString
METHOD: generateNodeFiltersString