From 92bfe4dbcf46349bef6685d8fda00c4215af6c26 Mon Sep 17 00:00:00 2001 From: Vincent Behar Date: Sun, 31 Jul 2011 20:02:14 +0200 Subject: [PATCH] Wagon: Deploying site to repository --- apidocs/allclasses-frame.html | 18 +- apidocs/allclasses-noframe.html | 18 +- apidocs/constant-values.html | 8 +- apidocs/deprecated-list.html | 8 +- apidocs/help-doc.html | 8 +- apidocs/index-all.html | 306 +- apidocs/index.html | 4 +- apidocs/options | 4 +- apidocs/org/rundeck/api/FileType.html | 8 +- .../org/rundeck/api/NodeFiltersBuilder.html | 8 +- apidocs/org/rundeck/api/OptionsBuilder.html | 8 +- ...ApiException.RundeckApiLoginException.html | 8 +- .../org/rundeck/api/RundeckApiException.html | 8 +- apidocs/org/rundeck/api/RundeckClient.html | 1428 ++++++- .../org/rundeck/api/class-use/FileType.html | 8 +- .../api/class-use/NodeFiltersBuilder.html | 8 +- .../rundeck/api/class-use/OptionsBuilder.html | 8 +- ...ApiException.RundeckApiLoginException.html | 382 +- .../api/class-use/RundeckApiException.html | 382 +- .../rundeck/api/class-use/RundeckClient.html | 8 +- .../api/domain/RundeckAbort.AbortStatus.html | 12 +- .../org/rundeck/api/domain/RundeckAbort.html | 8 +- .../api/domain/RundeckEvent.EventStatus.html | 346 ++ .../api/domain/RundeckEvent.NodeSummary.html | 444 ++ .../org/rundeck/api/domain/RundeckEvent.html | 941 +++++ .../RundeckExecution.ExecutionStatus.html | 12 +- .../rundeck/api/domain/RundeckExecution.html | 12 +- .../rundeck/api/domain/RundeckHistory.html | 553 +++ .../org/rundeck/api/domain/RundeckJob.html | 12 +- .../api/domain/RundeckJobsImportMethod.html | 8 +- .../api/domain/RundeckJobsImportResult.html | 8 +- .../org/rundeck/api/domain/RundeckNode.html | 8 +- .../rundeck/api/domain/RundeckProject.html | 8 +- .../rundeck/api/domain/RundeckSystemInfo.html | 8 +- .../class-use/RundeckAbort.AbortStatus.html | 8 +- .../api/domain/class-use/RundeckAbort.html | 8 +- .../class-use/RundeckEvent.EventStatus.html | 214 + .../class-use/RundeckEvent.NodeSummary.html | 197 + .../api/domain/class-use/RundeckEvent.html | 242 ++ .../RundeckExecution.ExecutionStatus.html | 8 +- .../domain/class-use/RundeckExecution.html | 282 +- .../api/domain/class-use/RundeckHistory.html | 302 ++ .../api/domain/class-use/RundeckJob.html | 8 +- .../class-use/RundeckJobsImportMethod.html | 8 +- .../class-use/RundeckJobsImportResult.html | 8 +- .../api/domain/class-use/RundeckNode.html | 8 +- .../api/domain/class-use/RundeckProject.html | 8 +- .../domain/class-use/RundeckSystemInfo.html | 8 +- .../org/rundeck/api/domain/package-frame.html | 14 +- .../rundeck/api/domain/package-summary.html | 24 +- .../org/rundeck/api/domain/package-tree.html | 13 +- .../org/rundeck/api/domain/package-use.html | 44 +- apidocs/org/rundeck/api/package-frame.html | 6 +- apidocs/org/rundeck/api/package-summary.html | 8 +- apidocs/org/rundeck/api/package-tree.html | 8 +- apidocs/org/rundeck/api/package-use.html | 8 +- .../org/rundeck/api/parser/AbortParser.html | 12 +- .../org/rundeck/api/parser/EventParser.html | 287 ++ .../rundeck/api/parser/ExecutionParser.html | 16 +- .../org/rundeck/api/parser/HistoryParser.html | 287 ++ apidocs/org/rundeck/api/parser/JobParser.html | 12 +- .../api/parser/JobsImportResultParser.html | 8 +- .../org/rundeck/api/parser/ListParser.html | 8 +- .../org/rundeck/api/parser/NodeParser.html | 8 +- .../org/rundeck/api/parser/ParserHelper.html | 8 +- .../org/rundeck/api/parser/ProjectParser.html | 8 +- .../org/rundeck/api/parser/StringParser.html | 8 +- .../rundeck/api/parser/SystemInfoParser.html | 8 +- .../org/rundeck/api/parser/XmlNodeParser.html | 10 +- .../api/parser/class-use/AbortParser.html | 8 +- .../api/parser/class-use/EventParser.html | 145 + .../api/parser/class-use/ExecutionParser.html | 8 +- .../api/parser/class-use/HistoryParser.html | 145 + .../api/parser/class-use/JobParser.html | 8 +- .../class-use/JobsImportResultParser.html | 8 +- .../api/parser/class-use/ListParser.html | 8 +- .../api/parser/class-use/NodeParser.html | 8 +- .../api/parser/class-use/ParserHelper.html | 8 +- .../api/parser/class-use/ProjectParser.html | 8 +- .../api/parser/class-use/StringParser.html | 8 +- .../parser/class-use/SystemInfoParser.html | 8 +- .../api/parser/class-use/XmlNodeParser.html | 24 +- .../org/rundeck/api/parser/package-frame.html | 10 +- .../rundeck/api/parser/package-summary.html | 16 +- .../org/rundeck/api/parser/package-tree.html | 10 +- .../org/rundeck/api/parser/package-use.html | 8 +- apidocs/org/rundeck/api/util/AssertUtil.html | 8 +- .../org/rundeck/api/util/ParametersUtil.html | 8 +- .../api/util/class-use/AssertUtil.html | 8 +- .../api/util/class-use/ParametersUtil.html | 8 +- .../org/rundeck/api/util/package-frame.html | 6 +- .../org/rundeck/api/util/package-summary.html | 8 +- .../org/rundeck/api/util/package-tree.html | 8 +- apidocs/org/rundeck/api/util/package-use.html | 8 +- apidocs/overview-frame.html | 6 +- apidocs/overview-summary.html | 10 +- apidocs/overview-tree.html | 17 +- apidocs/serialized-form.html | 254 +- changes-report.html | 13 +- cpd.html | 72 +- cpd.xml | 77 + dependencies.html | 25 +- dependency-updates-report.html | 11 +- distribution-management.html | 11 +- download.html | 11 +- faq.html | 11 +- findbugs.html | 13 +- groovy.html | 21 +- index.html | 11 +- integration.html | 11 +- issue-tracking.html | 11 +- jruby.html | 22 +- jython.html | 22 +- license.html | 11 +- mail-lists.html | 11 +- plugin-updates-report.html | 13 +- pmd.html | 11 +- pmd.xml | 2 +- project-info.html | 11 +- project-reports.html | 11 +- project-summary.html | 13 +- property-updates-report.html | 13 +- scripting.html | 11 +- source-repository.html | 11 +- status.html | 13 +- taglist.html | 11 +- team-list.html | 11 +- testapidocs/allclasses-frame.html | 10 +- testapidocs/allclasses-noframe.html | 10 +- testapidocs/constant-values.html | 8 +- testapidocs/deprecated-list.html | 8 +- testapidocs/help-doc.html | 8 +- testapidocs/index-all.html | 32 +- testapidocs/index.html | 4 +- testapidocs/options | 4 +- .../rundeck/api/parser/AbortParserTest.html | 12 +- .../rundeck/api/parser/EventParserTest.html | 286 ++ .../api/parser/ExecutionParserTest.html | 16 +- .../rundeck/api/parser/HistoryParserTest.html | 264 ++ .../org/rundeck/api/parser/JobParserTest.html | 12 +- .../parser/JobsImportResultParserTest.html | 8 +- .../rundeck/api/parser/ListParserTest.html | 8 +- .../rundeck/api/parser/NodeParserTest.html | 8 +- .../rundeck/api/parser/ParserHelperTest.html | 8 +- .../rundeck/api/parser/ProjectParserTest.html | 8 +- .../rundeck/api/parser/StringParserTest.html | 8 +- .../api/parser/SystemInfoParserTest.html | 8 +- .../api/parser/class-use/AbortParserTest.html | 8 +- .../api/parser/class-use/EventParserTest.html | 145 + .../parser/class-use/ExecutionParserTest.html | 8 +- .../parser/class-use/HistoryParserTest.html | 145 + .../api/parser/class-use/JobParserTest.html | 8 +- .../class-use/JobsImportResultParserTest.html | 8 +- .../api/parser/class-use/ListParserTest.html | 8 +- .../api/parser/class-use/NodeParserTest.html | 8 +- .../parser/class-use/ParserHelperTest.html | 8 +- .../parser/class-use/ProjectParserTest.html | 8 +- .../parser/class-use/StringParserTest.html | 8 +- .../class-use/SystemInfoParserTest.html | 8 +- .../org/rundeck/api/parser/package-frame.html | 10 +- .../rundeck/api/parser/package-summary.html | 16 +- .../org/rundeck/api/parser/package-tree.html | 10 +- .../org/rundeck/api/parser/package-use.html | 8 +- .../rundeck/api/util/ParametersUtilTest.html | 8 +- .../util/class-use/ParametersUtilTest.html | 8 +- .../org/rundeck/api/util/package-frame.html | 6 +- .../org/rundeck/api/util/package-summary.html | 8 +- .../org/rundeck/api/util/package-tree.html | 8 +- .../org/rundeck/api/util/package-use.html | 8 +- testapidocs/overview-frame.html | 6 +- testapidocs/overview-summary.html | 10 +- testapidocs/overview-tree.html | 10 +- xref-test/allclasses-frame.html | 6 + xref-test/index.html | 2 +- .../rundeck/api/parser/EventParserTest.html | 91 + .../rundeck/api/parser/HistoryParserTest.html | 92 + .../org/rundeck/api/parser/package-frame.html | 8 +- .../rundeck/api/parser/package-summary.html | 12 +- .../org/rundeck/api/util/package-frame.html | 2 +- .../org/rundeck/api/util/package-summary.html | 2 +- xref-test/overview-frame.html | 2 +- xref-test/overview-summary.html | 4 +- xref/allclasses-frame.html | 18 + xref/index.html | 2 +- xref/org/rundeck/api/ApiPathBuilder.html | 376 +- xref/org/rundeck/api/RundeckClient.html | 3565 ++++++++++------- xref/org/rundeck/api/domain/RundeckEvent.html | 386 ++ .../rundeck/api/domain/RundeckHistory.html | 144 + .../org/rundeck/api/domain/package-frame.html | 14 +- .../rundeck/api/domain/package-summary.html | 22 +- xref/org/rundeck/api/package-frame.html | 2 +- xref/org/rundeck/api/package-summary.html | 2 +- xref/org/rundeck/api/parser/EventParser.html | 101 + .../org/rundeck/api/parser/HistoryParser.html | 81 + .../org/rundeck/api/parser/package-frame.html | 8 +- .../rundeck/api/parser/package-summary.html | 12 +- xref/org/rundeck/api/util/package-frame.html | 2 +- .../org/rundeck/api/util/package-summary.html | 2 +- xref/overview-frame.html | 2 +- xref/overview-summary.html | 4 +- 200 files changed, 12371 insertions(+), 2223 deletions(-) create mode 100644 apidocs/org/rundeck/api/domain/RundeckEvent.EventStatus.html create mode 100644 apidocs/org/rundeck/api/domain/RundeckEvent.NodeSummary.html create mode 100644 apidocs/org/rundeck/api/domain/RundeckEvent.html create mode 100644 apidocs/org/rundeck/api/domain/RundeckHistory.html create mode 100644 apidocs/org/rundeck/api/domain/class-use/RundeckEvent.EventStatus.html create mode 100644 apidocs/org/rundeck/api/domain/class-use/RundeckEvent.NodeSummary.html create mode 100644 apidocs/org/rundeck/api/domain/class-use/RundeckEvent.html create mode 100644 apidocs/org/rundeck/api/domain/class-use/RundeckHistory.html create mode 100644 apidocs/org/rundeck/api/parser/EventParser.html create mode 100644 apidocs/org/rundeck/api/parser/HistoryParser.html create mode 100644 apidocs/org/rundeck/api/parser/class-use/EventParser.html create mode 100644 apidocs/org/rundeck/api/parser/class-use/HistoryParser.html create mode 100644 testapidocs/org/rundeck/api/parser/EventParserTest.html create mode 100644 testapidocs/org/rundeck/api/parser/HistoryParserTest.html create mode 100644 testapidocs/org/rundeck/api/parser/class-use/EventParserTest.html create mode 100644 testapidocs/org/rundeck/api/parser/class-use/HistoryParserTest.html create mode 100644 xref-test/org/rundeck/api/parser/EventParserTest.html create mode 100644 xref-test/org/rundeck/api/parser/HistoryParserTest.html create mode 100644 xref/org/rundeck/api/domain/RundeckEvent.html create mode 100644 xref/org/rundeck/api/domain/RundeckHistory.html create mode 100644 xref/org/rundeck/api/parser/EventParser.html create mode 100644 xref/org/rundeck/api/parser/HistoryParser.html diff --git a/apidocs/allclasses-frame.html b/apidocs/allclasses-frame.html index 12f1404..5ba36b8 100644 --- a/apidocs/allclasses-frame.html +++ b/apidocs/allclasses-frame.html @@ -2,13 +2,13 @@ - + -All Classes (RunDeck API - Java Client 1.1 API) +All Classes (RunDeck API - Java Client 1.2 API) - + @@ -26,10 +26,14 @@ All Classes (RunDeck API - Java Client 1.1 API)
AssertUtil
+EventParser +
ExecutionParser
FileType
+HistoryParser +
JobParser
JobsImportResultParser @@ -58,10 +62,18 @@ All Classes (RunDeck API - Java Client 1.1 API)
RundeckClient
+RundeckEvent +
+RundeckEvent.EventStatus +
+RundeckEvent.NodeSummary +
RundeckExecution
RundeckExecution.ExecutionStatus
+RundeckHistory +
RundeckJob
RundeckJobsImportMethod diff --git a/apidocs/allclasses-noframe.html b/apidocs/allclasses-noframe.html index 54b94a2..988dfda 100644 --- a/apidocs/allclasses-noframe.html +++ b/apidocs/allclasses-noframe.html @@ -2,13 +2,13 @@ - + -All Classes (RunDeck API - Java Client 1.1 API) +All Classes (RunDeck API - Java Client 1.2 API) - + @@ -26,10 +26,14 @@ All Classes (RunDeck API - Java Client 1.1 API)
AssertUtil
+EventParser +
ExecutionParser
FileType
+HistoryParser +
JobParser
JobsImportResultParser @@ -58,10 +62,18 @@ All Classes (RunDeck API - Java Client 1.1 API)
RundeckClient
+RundeckEvent +
+RundeckEvent.EventStatus +
+RundeckEvent.NodeSummary +
RundeckExecution
RundeckExecution.ExecutionStatus
+RundeckHistory +
RundeckJob
RundeckJobsImportMethod diff --git a/apidocs/constant-values.html b/apidocs/constant-values.html index 000f52e..d075e75 100644 --- a/apidocs/constant-values.html +++ b/apidocs/constant-values.html @@ -2,13 +2,13 @@ - + -Constant Field Values (RunDeck API - Java Client 1.1 API) +Constant Field Values (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Constant Field Values (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Constant Field Values (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Constant Field Values (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/deprecated-list.html b/apidocs/deprecated-list.html index 114bc58..1a86a18 100644 --- a/apidocs/deprecated-list.html +++ b/apidocs/deprecated-list.html @@ -2,13 +2,13 @@ - + -Deprecated List (RunDeck API - Java Client 1.1 API) +Deprecated List (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Deprecated List (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Deprecated List (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Deprecated List (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/help-doc.html b/apidocs/help-doc.html index 2cdb298..e5b4e20 100644 --- a/apidocs/help-doc.html +++ b/apidocs/help-doc.html @@ -2,13 +2,13 @@ - + -API Help (RunDeck API - Java Client 1.1 API) +API Help (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ API Help (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="API Help (RunDeck API - Java Client 1.1 API)"; + parent.document.title="API Help (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/index-all.html b/apidocs/index-all.html index d48c641..a02b732 100644 --- a/apidocs/index-all.html +++ b/apidocs/index-all.html @@ -2,13 +2,13 @@ - + -Index (RunDeck API - Java Client 1.1 API) +Index (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Index (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Index (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Index (RunDeck API - Java Client 1.2 API)"; } } @@ -92,6 +92,9 @@ Constructor for class org.rundeck.api.parser.AbortParser(String) - Constructor for class org.rundeck.api.parser.AbortParser
  +
addEvent(RundeckEvent) - +Method in class org.rundeck.api.domain.RundeckHistory +
 
addFailedJob(RundeckJob, String) - Method in class org.rundeck.api.domain.RundeckJobsImportResult
  @@ -106,10 +109,10 @@ Method in class org.rundeck.api.domain.API_ENDPOINT - Static variable in class org.rundeck.api.RundeckClient -
  +
End-point of the API
API_VERSION - Static variable in class org.rundeck.api.RundeckClient -
  +
Version of the API supported
AssertUtil - Class in org.rundeck.api.util
Utility class for assertions
AssertUtil() - Constructor for class org.rundeck.api.util.AssertUtil
  @@ -129,9 +132,18 @@ Method in class org.rundeck.api.equals(Object) - Method in class org.rundeck.api.domain.RundeckAbort
  +
equals(Object) - +Method in class org.rundeck.api.domain.RundeckEvent +
  +
equals(Object) - +Method in class org.rundeck.api.domain.RundeckEvent.NodeSummary +
 
equals(Object) - Method in class org.rundeck.api.domain.RundeckExecution
  +
equals(Object) - +Method in class org.rundeck.api.domain.RundeckHistory +
 
equals(Object) - Method in class org.rundeck.api.domain.RundeckJob
  @@ -150,6 +162,12 @@ Method in class org.rundeck.api.domain.equals(Object) - Method in class org.rundeck.api.RundeckClient
  +
EventParser - Class in org.rundeck.api.parser
Parser for a single RundeckEvent
EventParser() - +Constructor for class org.rundeck.api.parser.EventParser +
  +
EventParser(String) - +Constructor for class org.rundeck.api.parser.EventParser +
 
excludeHostname(String) - Method in class org.rundeck.api.NodeFiltersBuilder
Exclude nodes matching the given hostname @@ -242,6 +260,9 @@ Static method in class org.rundeck.api.util.generateNodeFiltersString(Properties) - Static method in class org.rundeck.api.util.ParametersUtil
Generates an url-encoded string representing the given nodeFilters. +
getAbortedBy() - +Method in class org.rundeck.api.domain.RundeckEvent +
 
getAbortedBy() - Method in class org.rundeck.api.domain.RundeckExecution
  @@ -254,6 +275,9 @@ Method in class org.rundeck.api.domain.getBuild() - Method in class org.rundeck.api.domain.RundeckSystemInfo
  +
getCount() - +Method in class org.rundeck.api.domain.RundeckHistory +
 
getCpuLoadAverage() - Method in class org.rundeck.api.domain.RundeckSystemInfo
  @@ -272,27 +296,48 @@ Method in class org.rundeck.api.domain.getDescription() - Method in class org.rundeck.api.domain.RundeckProject
  +
getDuration() - +Method in class org.rundeck.api.domain.RundeckEvent +
 
getDuration() - Method in class org.rundeck.api.domain.RundeckExecution
  +
getDurationInMillis() - +Method in class org.rundeck.api.domain.RundeckEvent +
 
getDurationInMillis() - Method in class org.rundeck.api.domain.RundeckExecution
  +
getDurationInSeconds() - +Method in class org.rundeck.api.domain.RundeckEvent +
 
getDurationInSeconds() - Method in class org.rundeck.api.domain.RundeckExecution
 
getEditUrl() - Method in class org.rundeck.api.domain.RundeckNode
  +
getEndedAt() - +Method in class org.rundeck.api.domain.RundeckEvent +
 
getEndedAt() - Method in class org.rundeck.api.domain.RundeckExecution
  +
getEvents() - +Method in class org.rundeck.api.domain.RundeckHistory +
 
getExecution() - Method in class org.rundeck.api.domain.RundeckAbort
 
getExecution(Long) - Method in class org.rundeck.api.RundeckClient
Get a single execution, identified by the given ID +
getExecutionId() - +Method in class org.rundeck.api.domain.RundeckEvent +
  +
getFailed() - +Method in class org.rundeck.api.domain.RundeckEvent.NodeSummary +
 
getFailedJobs() - Method in class org.rundeck.api.domain.RundeckJobsImportResult
  @@ -305,6 +350,33 @@ Method in class org.rundeck.api.domain.getGroup() - Method in class org.rundeck.api.domain.RundeckJob
  +
getHistory(String) - +Method in class org.rundeck.api.RundeckClient +
Get the (events) history for the given project +
getHistory(String, Long, Long) - +Method in class org.rundeck.api.RundeckClient +
Get the (events) history for the given project +
getHistory(String, String, String, String) - +Method in class org.rundeck.api.RundeckClient +
Get the (events) history for the given project +
getHistory(String, String, String, String, Long, Long) - +Method in class org.rundeck.api.RundeckClient +
Get the (events) history for the given project +
getHistory(String, String) - +Method in class org.rundeck.api.RundeckClient +
Get the (events) history for the given project +
getHistory(String, String, Long, Long) - +Method in class org.rundeck.api.RundeckClient +
Get the (events) history for the given project +
getHistory(String, Date, Date) - +Method in class org.rundeck.api.RundeckClient +
Get the (events) history for the given project +
getHistory(String, Date, Date, Long, Long) - +Method in class org.rundeck.api.RundeckClient +
Get the (events) history for the given project +
getHistory(String, String, String, String, String, Date, Date, Long, Long) - +Method in class org.rundeck.api.RundeckClient +
Get the (events) history for the given project
getHostname() - Method in class org.rundeck.api.domain.RundeckNode
  @@ -335,6 +407,9 @@ Method in class org.rundeck.api.getJobExecutions(String, RundeckExecution.ExecutionStatus, Long, Long) - Method in class org.rundeck.api.RundeckClient
Get the executions of the given job +
getJobId() - +Method in class org.rundeck.api.domain.RundeckEvent +
 
getJobs() - Method in class org.rundeck.api.RundeckClient
List all jobs (for all projects) @@ -356,6 +431,9 @@ Method in class org.rundeck.api.domain.getLogin() - Method in class org.rundeck.api.RundeckClient
  +
getMax() - +Method in class org.rundeck.api.domain.RundeckHistory +
 
getMaxMemoryInBytes() - Method in class org.rundeck.api.domain.RundeckSystemInfo
  @@ -383,6 +461,12 @@ Method in class org.rundeck.api.getNodes(String, Properties) - Method in class org.rundeck.api.RundeckClient
List nodes that belongs to the given project +
getNodeSummary() - +Method in class org.rundeck.api.domain.RundeckEvent +
  +
getOffset() - +Method in class org.rundeck.api.domain.RundeckHistory +
 
getOsArch() - Method in class org.rundeck.api.domain.RundeckNode
  @@ -407,6 +491,9 @@ Method in class org.rundeck.api.domain.getPassword() - Method in class org.rundeck.api.RundeckClient
  +
getProject() - +Method in class org.rundeck.api.domain.RundeckEvent +
 
getProject() - Method in class org.rundeck.api.domain.RundeckJob
  @@ -431,6 +518,9 @@ Method in class org.rundeck.api.getRunningJobs() - Method in class org.rundeck.api.domain.RundeckSystemInfo
  +
getShortDuration() - +Method in class org.rundeck.api.domain.RundeckEvent +
 
getShortDuration() - Method in class org.rundeck.api.domain.RundeckExecution
  @@ -440,6 +530,9 @@ Method in class org.rundeck.api.domain.getStartDate() - Method in class org.rundeck.api.domain.RundeckSystemInfo
  +
getStartedAt() - +Method in class org.rundeck.api.domain.RundeckEvent +
 
getStartedAt() - Method in class org.rundeck.api.domain.RundeckExecution
  @@ -449,18 +542,36 @@ Method in class org.rundeck.api.domain.getStatus() - Method in class org.rundeck.api.domain.RundeckAbort
  +
getStatus() - +Method in class org.rundeck.api.domain.RundeckEvent +
 
getStatus() - Method in class org.rundeck.api.domain.RundeckExecution
  +
getSucceeded() - +Method in class org.rundeck.api.domain.RundeckEvent.NodeSummary +
 
getSucceededJobs() - Method in class org.rundeck.api.domain.RundeckJobsImportResult
  +
getSummary() - +Method in class org.rundeck.api.domain.RundeckEvent +
 
getSystemInfo() - Method in class org.rundeck.api.RundeckClient
Get system informations about the RunDeck server
getTags() - Method in class org.rundeck.api.domain.RundeckNode
  +
getTitle() - +Method in class org.rundeck.api.domain.RundeckEvent +
  +
getTotal() - +Method in class org.rundeck.api.domain.RundeckEvent.NodeSummary +
  +
getTotal() - +Method in class org.rundeck.api.domain.RundeckHistory +
 
getTotalMemoryInBytes() - Method in class org.rundeck.api.domain.RundeckSystemInfo
  @@ -479,6 +590,9 @@ Method in class org.rundeck.api.domain.getUrl() - Method in class org.rundeck.api.RundeckClient
  +
getUser() - +Method in class org.rundeck.api.domain.RundeckEvent +
 
getUsername() - Method in class org.rundeck.api.domain.RundeckNode
  @@ -493,9 +607,18 @@ Method in class org.rundeck.api.domain.hashCode() - Method in class org.rundeck.api.domain.RundeckAbort
  +
hashCode() - +Method in class org.rundeck.api.domain.RundeckEvent +
  +
hashCode() - +Method in class org.rundeck.api.domain.RundeckEvent.NodeSummary +
 
hashCode() - Method in class org.rundeck.api.domain.RundeckExecution
  +
hashCode() - +Method in class org.rundeck.api.domain.RundeckHistory +
 
hashCode() - Method in class org.rundeck.api.domain.RundeckJob
  @@ -514,6 +637,12 @@ Method in class org.rundeck.api.domain.hashCode() - Method in class org.rundeck.api.RundeckClient
  +
HistoryParser - Class in org.rundeck.api.parser
Parser for a single RundeckHistory
HistoryParser() - +Constructor for class org.rundeck.api.parser.HistoryParser +
  +
HistoryParser(String) - +Constructor for class org.rundeck.api.parser.HistoryParser +
 
hostname(String) - Method in class org.rundeck.api.NodeFiltersBuilder
Include nodes matching the given hostname @@ -546,6 +675,9 @@ Method in class org.rundeck.api.importJobs(InputStream, FileType, RundeckJobsImportMethod) - Method in class org.rundeck.api.RundeckClient
Import the definitions of jobs, from the given input stream, using the given behavior +
isAdhoc() - +Method in class org.rundeck.api.domain.RundeckEvent +
 

@@ -631,9 +763,15 @@ Constructor for class org.rundeck.api.parser.parseXmlNode(Node) - Method in class org.rundeck.api.parser.AbortParser
  +
parseXmlNode(Node) - +Method in class org.rundeck.api.parser.EventParser +
 
parseXmlNode(Node) - Method in class org.rundeck.api.parser.ExecutionParser
  +
parseXmlNode(Node) - +Method in class org.rundeck.api.parser.HistoryParser +
 
parseXmlNode(Node) - Method in class org.rundeck.api.parser.JobParser
  @@ -690,6 +828,54 @@ Method in class org.rundeck.api.runAdhocCommand(String, String, Properties, Integer, Boolean, long, TimeUnit) - Method in class org.rundeck.api.RundeckClient
Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. +
runAdhocScript(String, String) - +Method in class org.rundeck.api.RundeckClient +
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. +
runAdhocScript(String, String, long, TimeUnit) - +Method in class org.rundeck.api.RundeckClient +
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. +
runAdhocScript(String, String, Properties) - +Method in class org.rundeck.api.RundeckClient +
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. +
runAdhocScript(String, String, Properties, long, TimeUnit) - +Method in class org.rundeck.api.RundeckClient +
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. +
runAdhocScript(String, String, Properties, Properties) - +Method in class org.rundeck.api.RundeckClient +
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. +
runAdhocScript(String, String, Properties, Properties, long, TimeUnit) - +Method in class org.rundeck.api.RundeckClient +
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. +
runAdhocScript(String, String, Properties, Properties, Integer, Boolean) - +Method in class org.rundeck.api.RundeckClient +
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. +
runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit) - +Method in class org.rundeck.api.RundeckClient +
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. +
runAdhocScript(String, InputStream) - +Method in class org.rundeck.api.RundeckClient +
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. +
runAdhocScript(String, InputStream, long, TimeUnit) - +Method in class org.rundeck.api.RundeckClient +
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. +
runAdhocScript(String, InputStream, Properties) - +Method in class org.rundeck.api.RundeckClient +
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. +
runAdhocScript(String, InputStream, Properties, long, TimeUnit) - +Method in class org.rundeck.api.RundeckClient +
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. +
runAdhocScript(String, InputStream, Properties, Properties) - +Method in class org.rundeck.api.RundeckClient +
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. +
runAdhocScript(String, InputStream, Properties, Properties, long, TimeUnit) - +Method in class org.rundeck.api.RundeckClient +
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. +
runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean) - +Method in class org.rundeck.api.RundeckClient +
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. +
runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit) - +Method in class org.rundeck.api.RundeckClient +
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
RundeckAbort - Class in org.rundeck.api.domain
Represents an abort of a RundeckExecution
RundeckAbort() - Constructor for class org.rundeck.api.domain.RundeckAbort
  @@ -708,10 +894,19 @@ Constructor for exception org.rundeck.api.RundeckClient - Class in org.rundeck.api
Main entry point to talk to a RunDeck instance.
RundeckClient(String, String, String) - Constructor for class org.rundeck.api.RundeckClient
Instantiate a new RundeckClient for the RunDeck instance at the given url +
RundeckEvent - Class in org.rundeck.api.domain
Represents a RunDeck event
RundeckEvent() - +Constructor for class org.rundeck.api.domain.RundeckEvent +
  +
RundeckEvent.EventStatus - Enum in org.rundeck.api.domain
The status of an event
RundeckEvent.NodeSummary - Class in org.rundeck.api.domain
Summary for nodes
RundeckEvent.NodeSummary() - +Constructor for class org.rundeck.api.domain.RundeckEvent.NodeSummary +
 
RundeckExecution - Class in org.rundeck.api.domain
Represents a RunDeck execution, usually triggered by an API call.
RundeckExecution() - Constructor for class org.rundeck.api.domain.RundeckExecution
  -
RundeckExecution.ExecutionStatus - Enum in org.rundeck.api.domain
The status of an execution
RundeckJob - Class in org.rundeck.api.domain
Represents a RunDeck job
RundeckJob() - +
RundeckExecution.ExecutionStatus - Enum in org.rundeck.api.domain
The status of an execution
RundeckHistory - Class in org.rundeck.api.domain
Represents a portion of the RunDeck (events) history
RundeckHistory() - +Constructor for class org.rundeck.api.domain.RundeckHistory +
  +
RundeckJob - Class in org.rundeck.api.domain
Represents a RunDeck job
RundeckJob() - Constructor for class org.rundeck.api.domain.RundeckJob
 
RundeckJobsImportMethod - Enum in org.rundeck.api.domain
The behavior when importing jobs (which may already exist).
RundeckJobsImportResult - Class in org.rundeck.api.domain
Result of importing some jobs into RunDeck
RundeckJobsImportResult() - @@ -746,6 +941,9 @@ Method in class org.rundeck.api.

S

+
setAbortedBy(String) - +Method in class org.rundeck.api.domain.RundeckEvent +
 
setAbortedBy(String) - Method in class org.rundeck.api.domain.RundeckExecution
  @@ -758,6 +956,9 @@ Method in class org.rundeck.api.domain.setBuild(String) - Method in class org.rundeck.api.domain.RundeckSystemInfo
  +
setCount(int) - +Method in class org.rundeck.api.domain.RundeckHistory +
 
setCpuLoadAverage(String) - Method in class org.rundeck.api.domain.RundeckSystemInfo
  @@ -779,12 +980,24 @@ Method in class org.rundeck.api.domain.setEditUrl(String) - Method in class org.rundeck.api.domain.RundeckNode
  +
setEndedAt(Date) - +Method in class org.rundeck.api.domain.RundeckEvent +
 
setEndedAt(Date) - Method in class org.rundeck.api.domain.RundeckExecution
  +
setEvents(List<RundeckEvent>) - +Method in class org.rundeck.api.domain.RundeckHistory +
 
setExecution(RundeckExecution) - Method in class org.rundeck.api.domain.RundeckAbort
  +
setExecutionId(Long) - +Method in class org.rundeck.api.domain.RundeckEvent +
  +
setFailed(int) - +Method in class org.rundeck.api.domain.RundeckEvent.NodeSummary +
 
setFreeMemoryInBytes(Long) - Method in class org.rundeck.api.domain.RundeckSystemInfo
  @@ -803,6 +1016,9 @@ Method in class org.rundeck.api.domain.setJob(RundeckJob) - Method in class org.rundeck.api.domain.RundeckExecution
  +
setJobId(String) - +Method in class org.rundeck.api.domain.RundeckEvent +
 
setJvmName(String) - Method in class org.rundeck.api.domain.RundeckSystemInfo
  @@ -812,6 +1028,9 @@ Method in class org.rundeck.api.domain.setJvmVersion(String) - Method in class org.rundeck.api.domain.RundeckSystemInfo
  +
setMax(int) - +Method in class org.rundeck.api.domain.RundeckHistory +
 
setMaxMemoryInBytes(Long) - Method in class org.rundeck.api.domain.RundeckSystemInfo
  @@ -827,6 +1046,12 @@ Method in class org.rundeck.api.domain.setNode(String) - Method in class org.rundeck.api.domain.RundeckSystemInfo
  +
setNodeSummary(RundeckEvent.NodeSummary) - +Method in class org.rundeck.api.domain.RundeckEvent +
  +
setOffset(int) - +Method in class org.rundeck.api.domain.RundeckHistory +
 
setOsArch(String) - Method in class org.rundeck.api.domain.RundeckNode
  @@ -848,6 +1073,9 @@ Method in class org.rundeck.api.domain.setOsVersion(String) - Method in class org.rundeck.api.domain.RundeckSystemInfo
  +
setProject(String) - +Method in class org.rundeck.api.domain.RundeckEvent +
 
setProject(String) - Method in class org.rundeck.api.domain.RundeckJob
  @@ -863,6 +1091,9 @@ Method in class org.rundeck.api.domain.setStartDate(Date) - Method in class org.rundeck.api.domain.RundeckSystemInfo
  +
setStartedAt(Date) - +Method in class org.rundeck.api.domain.RundeckEvent +
 
setStartedAt(Date) - Method in class org.rundeck.api.domain.RundeckExecution
  @@ -872,12 +1103,30 @@ Method in class org.rundeck.api.domain.setStatus(RundeckAbort.AbortStatus) - Method in class org.rundeck.api.domain.RundeckAbort
  +
setStatus(RundeckEvent.EventStatus) - +Method in class org.rundeck.api.domain.RundeckEvent +
 
setStatus(RundeckExecution.ExecutionStatus) - Method in class org.rundeck.api.domain.RundeckExecution
  +
setSucceeded(int) - +Method in class org.rundeck.api.domain.RundeckEvent.NodeSummary +
  +
setSummary(String) - +Method in class org.rundeck.api.domain.RundeckEvent +
 
setTags(List<String>) - Method in class org.rundeck.api.domain.RundeckNode
  +
setTitle(String) - +Method in class org.rundeck.api.domain.RundeckEvent +
  +
setTotal(int) - +Method in class org.rundeck.api.domain.RundeckEvent.NodeSummary +
  +
setTotal(int) - +Method in class org.rundeck.api.domain.RundeckHistory +
 
setTotalMemoryInBytes(Long) - Method in class org.rundeck.api.domain.RundeckSystemInfo
  @@ -890,6 +1139,9 @@ Method in class org.rundeck.api.domain.setUrl(String) - Method in class org.rundeck.api.domain.RundeckExecution
  +
setUser(String) - +Method in class org.rundeck.api.domain.RundeckEvent +
 
setUsername(String) - Method in class org.rundeck.api.domain.RundeckNode
  @@ -928,9 +1180,18 @@ Method in class org.rundeck.api.toString() - Method in class org.rundeck.api.domain.RundeckAbort
  +
toString() - +Method in class org.rundeck.api.domain.RundeckEvent.NodeSummary +
  +
toString() - +Method in class org.rundeck.api.domain.RundeckEvent +
 
toString() - Method in class org.rundeck.api.domain.RundeckExecution
  +
toString() - +Method in class org.rundeck.api.domain.RundeckHistory +
 
toString() - Method in class org.rundeck.api.domain.RundeckJob
  @@ -958,6 +1219,30 @@ Method in class org.rundeck.api.triggerAdhocCommand(String, String, Properties, Integer, Boolean) - Method in class org.rundeck.api.RundeckClient
Trigger the execution of an ad-hoc command, and return immediately (without waiting the end of the execution). +
triggerAdhocScript(String, String) - +Method in class org.rundeck.api.RundeckClient +
Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). +
triggerAdhocScript(String, String, Properties) - +Method in class org.rundeck.api.RundeckClient +
Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). +
triggerAdhocScript(String, String, Properties, Properties) - +Method in class org.rundeck.api.RundeckClient +
Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). +
triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean) - +Method in class org.rundeck.api.RundeckClient +
Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). +
triggerAdhocScript(String, InputStream) - +Method in class org.rundeck.api.RundeckClient +
Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). +
triggerAdhocScript(String, InputStream, Properties) - +Method in class org.rundeck.api.RundeckClient +
Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). +
triggerAdhocScript(String, InputStream, Properties, Properties) - +Method in class org.rundeck.api.RundeckClient +
Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). +
triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean) - +Method in class org.rundeck.api.RundeckClient +
Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).
triggerJob(String) - Method in class org.rundeck.api.RundeckClient
Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the @@ -989,6 +1274,9 @@ Static method in class org.rundeck.api.util.valueOf(String) - Static method in enum org.rundeck.api.domain.RundeckAbort.AbortStatus
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum org.rundeck.api.domain.RundeckEvent.EventStatus +
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.rundeck.api.domain.RundeckExecution.ExecutionStatus
Returns the enum constant of this type with the specified name. @@ -1002,6 +1290,10 @@ Static method in enum org.rundeck.api.RundeckAbort.AbortStatus
Returns an array containing the constants of this enum type, in the order they are declared. +
values() - +Static method in enum org.rundeck.api.domain.RundeckEvent.EventStatus +
Returns an array containing the constants of this enum type, in +the order they are declared.
values() - Static method in enum org.rundeck.api.domain.RundeckExecution.ExecutionStatus
Returns an array containing the constants of this enum type, in diff --git a/apidocs/index.html b/apidocs/index.html index 7396223..9a91583 100644 --- a/apidocs/index.html +++ b/apidocs/index.html @@ -2,10 +2,10 @@ - + -RunDeck API - Java Client 1.1 API +RunDeck API - Java Client 1.2 API diff --git a/apidocs/org/rundeck/api/NodeFiltersBuilder.html b/apidocs/org/rundeck/api/NodeFiltersBuilder.html index 1afa3cd..e81c6f7 100644 --- a/apidocs/org/rundeck/api/NodeFiltersBuilder.html +++ b/apidocs/org/rundeck/api/NodeFiltersBuilder.html @@ -2,13 +2,13 @@ - + -NodeFiltersBuilder (RunDeck API - Java Client 1.1 API) +NodeFiltersBuilder (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ NodeFiltersBuilder (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="NodeFiltersBuilder (RunDeck API - Java Client 1.1 API)"; + parent.document.title="NodeFiltersBuilder (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/OptionsBuilder.html b/apidocs/org/rundeck/api/OptionsBuilder.html index 686d162..5d9f997 100644 --- a/apidocs/org/rundeck/api/OptionsBuilder.html +++ b/apidocs/org/rundeck/api/OptionsBuilder.html @@ -2,13 +2,13 @@ - + -OptionsBuilder (RunDeck API - Java Client 1.1 API) +OptionsBuilder (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ OptionsBuilder (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="OptionsBuilder (RunDeck API - Java Client 1.1 API)"; + parent.document.title="OptionsBuilder (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/RundeckApiException.RundeckApiLoginException.html b/apidocs/org/rundeck/api/RundeckApiException.RundeckApiLoginException.html index fdee321..3130156 100644 --- a/apidocs/org/rundeck/api/RundeckApiException.RundeckApiLoginException.html +++ b/apidocs/org/rundeck/api/RundeckApiException.RundeckApiLoginException.html @@ -2,13 +2,13 @@ - + -RundeckApiException.RundeckApiLoginException (RunDeck API - Java Client 1.1 API) +RundeckApiException.RundeckApiLoginException (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ RundeckApiException.RundeckApiLoginException (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="RundeckApiException.RundeckApiLoginException (RunDeck API - Java Client 1.1 API)"; + parent.document.title="RundeckApiException.RundeckApiLoginException (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/RundeckApiException.html b/apidocs/org/rundeck/api/RundeckApiException.html index e32cf4b..517f5fa 100644 --- a/apidocs/org/rundeck/api/RundeckApiException.html +++ b/apidocs/org/rundeck/api/RundeckApiException.html @@ -2,13 +2,13 @@ - + -RundeckApiException (RunDeck API - Java Client 1.1 API) +RundeckApiException (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ RundeckApiException (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="RundeckApiException (RunDeck API - Java Client 1.1 API)"; + parent.document.title="RundeckApiException (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/RundeckClient.html b/apidocs/org/rundeck/api/RundeckClient.html index 6b22c95..713060f 100644 --- a/apidocs/org/rundeck/api/RundeckClient.html +++ b/apidocs/org/rundeck/api/RundeckClient.html @@ -2,13 +2,13 @@ - + -RundeckClient (RunDeck API - Java Client 1.1 API) +RundeckClient (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ RundeckClient (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="RundeckClient (RunDeck API - Java Client 1.1 API)"; + parent.document.title="RundeckClient (RunDeck API - Java Client 1.2 API)"; } } @@ -147,7 +147,7 @@ Main entry point to talk to a RunDeck instance.
API_ENDPOINT
-            +          End-point of the API @@ -155,7 +155,7 @@ Main entry point to talk to a RunDeck instance.
API_VERSION
-            +          Version of the API supported   @@ -359,6 +359,106 @@ Main entry point to talk to a RunDeck instance.
+ RundeckHistory +getHistory(String project) + +
+          Get the (events) history for the given project + + + + RundeckHistory +getHistory(String project, + Date begin, + Date end) + +
+          Get the (events) history for the given project + + + + RundeckHistory +getHistory(String project, + Date begin, + Date end, + Long max, + Long offset) + +
+          Get the (events) history for the given project + + + + RundeckHistory +getHistory(String project, + Long max, + Long offset) + +
+          Get the (events) history for the given project + + + + RundeckHistory +getHistory(String project, + String recent) + +
+          Get the (events) history for the given project + + + + RundeckHistory +getHistory(String project, + String recent, + Long max, + Long offset) + +
+          Get the (events) history for the given project + + + + RundeckHistory +getHistory(String project, + String jobId, + String reportId, + String user) + +
+          Get the (events) history for the given project + + + + RundeckHistory +getHistory(String project, + String jobId, + String reportId, + String user, + Long max, + Long offset) + +
+          Get the (events) history for the given project + + + + RundeckHistory +getHistory(String project, + String jobId, + String reportId, + String user, + String recent, + Date begin, + Date end, + Long max, + Long offset) + +
+          Get the (events) history for the given project + + +  RundeckJob getJob(String jobId) @@ -701,6 +801,194 @@ Main entry point to talk to a RunDeck instance.
 RundeckExecution +runAdhocScript(String project, + InputStream script) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +runAdhocScript(String project, + InputStream script, + long poolingInterval, + TimeUnit poolingUnit) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +runAdhocScript(String project, + InputStream script, + Properties options) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +runAdhocScript(String project, + InputStream script, + Properties options, + long poolingInterval, + TimeUnit poolingUnit) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +runAdhocScript(String project, + InputStream script, + Properties options, + Properties nodeFilters) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +runAdhocScript(String project, + InputStream script, + Properties options, + Properties nodeFilters, + Integer nodeThreadcount, + Boolean nodeKeepgoing) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +runAdhocScript(String project, + InputStream script, + Properties options, + Properties nodeFilters, + Integer nodeThreadcount, + Boolean nodeKeepgoing, + long poolingInterval, + TimeUnit poolingUnit) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +runAdhocScript(String project, + InputStream script, + Properties options, + Properties nodeFilters, + long poolingInterval, + TimeUnit poolingUnit) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +runAdhocScript(String project, + String scriptFilename) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +runAdhocScript(String project, + String scriptFilename, + long poolingInterval, + TimeUnit poolingUnit) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +runAdhocScript(String project, + String scriptFilename, + Properties options) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +runAdhocScript(String project, + String scriptFilename, + Properties options, + long poolingInterval, + TimeUnit poolingUnit) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +runAdhocScript(String project, + String scriptFilename, + Properties options, + Properties nodeFilters) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +runAdhocScript(String project, + String scriptFilename, + Properties options, + Properties nodeFilters, + Integer nodeThreadcount, + Boolean nodeKeepgoing) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +runAdhocScript(String project, + String scriptFilename, + Properties options, + Properties nodeFilters, + Integer nodeThreadcount, + Boolean nodeKeepgoing, + long poolingInterval, + TimeUnit poolingUnit) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +runAdhocScript(String project, + String scriptFilename, + Properties options, + Properties nodeFilters, + long poolingInterval, + TimeUnit poolingUnit) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution runJob(String jobId)
@@ -798,6 +1086,92 @@ Main entry point to talk to a RunDeck instance.
 RundeckExecution +triggerAdhocScript(String project, + InputStream script) + +
+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). + + + + RundeckExecution +triggerAdhocScript(String project, + InputStream script, + Properties options) + +
+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). + + + + RundeckExecution +triggerAdhocScript(String project, + InputStream script, + Properties options, + Properties nodeFilters) + +
+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). + + + + RundeckExecution +triggerAdhocScript(String project, + InputStream script, + Properties options, + Properties nodeFilters, + Integer nodeThreadcount, + Boolean nodeKeepgoing) + +
+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). + + + + RundeckExecution +triggerAdhocScript(String project, + String scriptFilename) + +
+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). + + + + RundeckExecution +triggerAdhocScript(String project, + String scriptFilename, + Properties options) + +
+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). + + + + RundeckExecution +triggerAdhocScript(String project, + String scriptFilename, + Properties options, + Properties nodeFilters) + +
+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). + + + + RundeckExecution +triggerAdhocScript(String project, + String scriptFilename, + Properties options, + Properties nodeFilters, + Integer nodeThreadcount, + Boolean nodeKeepgoing) + +
+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). + + + + RundeckExecution triggerJob(String jobId)
@@ -853,6 +1227,8 @@ API_VERSION

 public static final transient int API_VERSION
+
Version of the API supported +

See Also:
Constant Field Values
@@ -863,6 +1239,8 @@ API_ENDPOINT 
 public static final transient String API_ENDPOINT
+
End-point of the API +

See Also:
Constant Field Values
@@ -1676,7 +2054,7 @@ public RundeckApiException - in case of error when calling the API (non-existent job with this ID)
RundeckApiException.RundeckApiLoginException - if the login failed
IllegalArgumentException - if the jobId is blank (null, empty or whitespace)
See Also:
findJob(String, String, String), -#exportJob(String) +exportJob(String, String)
@@ -2203,6 +2581,775 @@ public

+triggerAdhocScript

+
+public RundeckExecution triggerAdhocScript(String project,
+                                           String scriptFilename)
+                                    throws RundeckApiException,
+                                           RundeckApiException.RundeckApiLoginException,
+                                           IllegalArgumentException,
+                                           IOException
+
+
Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The + script will not be dispatched to nodes, but be executed on the RunDeck server. +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
scriptFilename - filename of the script to be executed - mandatory +
Returns:
a RundeckExecution instance for the newly created (and running) execution - won't be null +
Throws: +
RundeckApiException - in case of error when calling the API (non-existent project with this name) +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project or scriptFilename is blank (null, empty or whitespace) +
IOException - if we failed to read the file
See Also:
triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean), +runAdhocScript(String, String)
+
+
+
+ +

+triggerAdhocScript

+
+public RundeckExecution triggerAdhocScript(String project,
+                                           String scriptFilename,
+                                           Properties options)
+                                    throws RundeckApiException,
+                                           RundeckApiException.RundeckApiLoginException,
+                                           IllegalArgumentException,
+                                           IOException
+
+
Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The + script will not be dispatched to nodes, but be executed on the RunDeck server. +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
scriptFilename - filename of the script to be executed - mandatory
options - of the script - optional. See OptionsBuilder. +
Returns:
a RundeckExecution instance for the newly created (and running) execution - won't be null +
Throws: +
RundeckApiException - in case of error when calling the API (non-existent project with this name) +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project or scriptFilename is blank (null, empty or whitespace) +
IOException - if we failed to read the file
See Also:
triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean), +runAdhocScript(String, String, Properties)
+
+
+
+ +

+triggerAdhocScript

+
+public RundeckExecution triggerAdhocScript(String project,
+                                           String scriptFilename,
+                                           Properties options,
+                                           Properties nodeFilters)
+                                    throws RundeckApiException,
+                                           RundeckApiException.RundeckApiLoginException,
+                                           IllegalArgumentException,
+                                           IOException
+
+
Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The + script will be dispatched to nodes, accordingly to the nodeFilters parameter. +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
scriptFilename - filename of the script to be executed - mandatory
options - of the script - optional. See OptionsBuilder.
nodeFilters - for selecting nodes on which the command will be executed. See NodeFiltersBuilder +
Returns:
a RundeckExecution instance for the newly created (and running) execution - won't be null +
Throws: +
RundeckApiException - in case of error when calling the API (non-existent project with this name) +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project or scriptFilename is blank (null, empty or whitespace) +
IOException - if we failed to read the file
See Also:
triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean), +runAdhocScript(String, String, Properties, Properties)
+
+
+
+ +

+triggerAdhocScript

+
+public RundeckExecution triggerAdhocScript(String project,
+                                           String scriptFilename,
+                                           Properties options,
+                                           Properties nodeFilters,
+                                           Integer nodeThreadcount,
+                                           Boolean nodeKeepgoing)
+                                    throws RundeckApiException,
+                                           RundeckApiException.RundeckApiLoginException,
+                                           IllegalArgumentException,
+                                           IOException
+
+
Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The + script will be dispatched to nodes, accordingly to the nodeFilters parameter. +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
scriptFilename - filename of the script to be executed - mandatory
options - of the script - optional. See OptionsBuilder.
nodeFilters - for selecting nodes on which the command will be executed. See NodeFiltersBuilder
nodeThreadcount - thread count to use (for parallelizing when running on multiple nodes) - optional
nodeKeepgoing - if true, continue executing on other nodes even if some fail - optional +
Returns:
a RundeckExecution instance for the newly created (and running) execution - won't be null +
Throws: +
RundeckApiException - in case of error when calling the API (non-existent project with this name) +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project or scriptFilename is blank (null, empty or whitespace) +
IOException - if we failed to read the file
See Also:
triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean), +runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit)
+
+
+
+ +

+triggerAdhocScript

+
+public RundeckExecution triggerAdhocScript(String project,
+                                           InputStream script)
+                                    throws RundeckApiException,
+                                           RundeckApiException.RundeckApiLoginException,
+                                           IllegalArgumentException
+
+
Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The + script will not be dispatched to nodes, but be executed on the RunDeck server. +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
script - inputStream for reading the script to be executed - mandatory +
Returns:
a RundeckExecution instance for the newly created (and running) execution - won't be null +
Throws: +
RundeckApiException - in case of error when calling the API (non-existent project with this name) +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project is blank (null, empty or whitespace) or the script is null
See Also:
triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean), +runAdhocScript(String, InputStream)
+
+
+
+ +

+triggerAdhocScript

+
+public RundeckExecution triggerAdhocScript(String project,
+                                           InputStream script,
+                                           Properties options)
+                                    throws RundeckApiException,
+                                           RundeckApiException.RundeckApiLoginException,
+                                           IllegalArgumentException
+
+
Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The + script will not be dispatched to nodes, but be executed on the RunDeck server. +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
script - inputStream for reading the script to be executed - mandatory
options - of the script - optional. See OptionsBuilder. +
Returns:
a RundeckExecution instance for the newly created (and running) execution - won't be null +
Throws: +
RundeckApiException - in case of error when calling the API (non-existent project with this name) +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project is blank (null, empty or whitespace) or the script is null
See Also:
triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean), +runAdhocScript(String, InputStream, Properties)
+
+
+
+ +

+triggerAdhocScript

+
+public RundeckExecution triggerAdhocScript(String project,
+                                           InputStream script,
+                                           Properties options,
+                                           Properties nodeFilters)
+                                    throws RundeckApiException,
+                                           RundeckApiException.RundeckApiLoginException,
+                                           IllegalArgumentException
+
+
Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The + script will be dispatched to nodes, accordingly to the nodeFilters parameter. +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
script - inputStream for reading the script to be executed - mandatory
options - of the script - optional. See OptionsBuilder.
nodeFilters - for selecting nodes on which the command will be executed. See NodeFiltersBuilder +
Returns:
a RundeckExecution instance for the newly created (and running) execution - won't be null +
Throws: +
RundeckApiException - in case of error when calling the API (non-existent project with this name) +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project is blank (null, empty or whitespace) or the script is null
See Also:
triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean), +runAdhocScript(String, InputStream, Properties, Properties)
+
+
+
+ +

+triggerAdhocScript

+
+public RundeckExecution triggerAdhocScript(String project,
+                                           InputStream script,
+                                           Properties options,
+                                           Properties nodeFilters,
+                                           Integer nodeThreadcount,
+                                           Boolean nodeKeepgoing)
+                                    throws RundeckApiException,
+                                           RundeckApiException.RundeckApiLoginException,
+                                           IllegalArgumentException
+
+
Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The + script will be dispatched to nodes, accordingly to the nodeFilters parameter. +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
script - inputStream for reading the script to be executed - mandatory
options - of the script - optional. See OptionsBuilder.
nodeFilters - for selecting nodes on which the command will be executed. See NodeFiltersBuilder
nodeThreadcount - thread count to use (for parallelizing when running on multiple nodes) - optional
nodeKeepgoing - if true, continue executing on other nodes even if some fail - optional +
Returns:
a RundeckExecution instance for the newly created (and running) execution - won't be null +
Throws: +
RundeckApiException - in case of error when calling the API (non-existent project with this name) +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project is blank (null, empty or whitespace) or the script is null
See Also:
triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean), +runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit)
+
+
+
+ +

+runAdhocScript

+
+public RundeckExecution runAdhocScript(String project,
+                                       String scriptFilename)
+                                throws RundeckApiException,
+                                       RundeckApiException.RundeckApiLoginException,
+                                       IllegalArgumentException,
+                                       IOException
+
+
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck + server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still + running. The script will not be dispatched to nodes, but be executed on the RunDeck server. +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
scriptFilename - filename of the script to be executed - mandatory +
Returns:
a RundeckExecution instance for the (finished/aborted) execution - won't be null +
Throws: +
RundeckApiException - in case of error when calling the API (non-existent project with this name) +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project or scriptFilename is blank (null, empty or whitespace) +
IOException - if we failed to read the file
See Also:
runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit), +triggerAdhocScript(String, String)
+
+
+
+ +

+runAdhocScript

+
+public RundeckExecution runAdhocScript(String project,
+                                       String scriptFilename,
+                                       long poolingInterval,
+                                       TimeUnit poolingUnit)
+                                throws RundeckApiException,
+                                       RundeckApiException.RundeckApiLoginException,
+                                       IllegalArgumentException,
+                                       IOException
+
+
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck + server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is + finished (or aborted) or is still running. The script will not be dispatched to nodes, but be executed on the + RunDeck server. +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
scriptFilename - filename of the script to be executed - mandatory
poolingInterval - for checking the status of the execution. Must be > 0.
poolingUnit - unit (seconds, milli-seconds, ...) of the interval. Default to seconds. +
Returns:
a RundeckExecution instance for the (finished/aborted) execution - won't be null +
Throws: +
RundeckApiException - in case of error when calling the API (non-existent project with this name) +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project or scriptFilename is blank (null, empty or whitespace) +
IOException - if we failed to read the file
See Also:
runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit), +triggerAdhocScript(String, String)
+
+
+
+ +

+runAdhocScript

+
+public RundeckExecution runAdhocScript(String project,
+                                       String scriptFilename,
+                                       Properties options)
+                                throws RundeckApiException,
+                                       RundeckApiException.RundeckApiLoginException,
+                                       IllegalArgumentException,
+                                       IOException
+
+
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck + server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still + running. The script will not be dispatched to nodes, but be executed on the RunDeck server. +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
scriptFilename - filename of the script to be executed - mandatory
options - of the script - optional. See OptionsBuilder. +
Returns:
a RundeckExecution instance for the (finished/aborted) execution - won't be null +
Throws: +
RundeckApiException - in case of error when calling the API (non-existent project with this name) +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project or scriptFilename is blank (null, empty or whitespace) +
IOException - if we failed to read the file
See Also:
runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit), +triggerAdhocScript(String, String, Properties)
+
+
+
+ +

+runAdhocScript

+
+public RundeckExecution runAdhocScript(String project,
+                                       String scriptFilename,
+                                       Properties options,
+                                       long poolingInterval,
+                                       TimeUnit poolingUnit)
+                                throws RundeckApiException,
+                                       RundeckApiException.RundeckApiLoginException,
+                                       IllegalArgumentException,
+                                       IOException
+
+
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck + server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is + finished (or aborted) or is still running. The script will not be dispatched to nodes, but be executed on the + RunDeck server. +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
scriptFilename - filename of the script to be executed - mandatory
options - of the script - optional. See OptionsBuilder.
poolingInterval - for checking the status of the execution. Must be > 0.
poolingUnit - unit (seconds, milli-seconds, ...) of the interval. Default to seconds. +
Returns:
a RundeckExecution instance for the (finished/aborted) execution - won't be null +
Throws: +
RundeckApiException - in case of error when calling the API (non-existent project with this name) +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project or scriptFilename is blank (null, empty or whitespace) +
IOException - if we failed to read the file
See Also:
runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit), +triggerAdhocScript(String, String, Properties)
+
+
+
+ +

+runAdhocScript

+
+public RundeckExecution runAdhocScript(String project,
+                                       String scriptFilename,
+                                       Properties options,
+                                       Properties nodeFilters)
+                                throws RundeckApiException,
+                                       RundeckApiException.RundeckApiLoginException,
+                                       IllegalArgumentException,
+                                       IOException
+
+
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck + server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still + running. The script will be dispatched to nodes, accordingly to the nodeFilters parameter. +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
scriptFilename - filename of the script to be executed - mandatory
options - of the script - optional. See OptionsBuilder.
nodeFilters - for selecting nodes on which the script will be executed. See NodeFiltersBuilder +
Returns:
a RundeckExecution instance for the (finished/aborted) execution - won't be null +
Throws: +
RundeckApiException - in case of error when calling the API (non-existent project with this name) +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project or scriptFilename is blank (null, empty or whitespace) +
IOException - if we failed to read the file
See Also:
runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit), +triggerAdhocScript(String, String, Properties, Properties)
+
+
+
+ +

+runAdhocScript

+
+public RundeckExecution runAdhocScript(String project,
+                                       String scriptFilename,
+                                       Properties options,
+                                       Properties nodeFilters,
+                                       long poolingInterval,
+                                       TimeUnit poolingUnit)
+                                throws RundeckApiException,
+                                       RundeckApiException.RundeckApiLoginException,
+                                       IllegalArgumentException,
+                                       IOException
+
+
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck + server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is + finished (or aborted) or is still running. The script will be dispatched to nodes, accordingly to the nodeFilters + parameter. +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
scriptFilename - filename of the script to be executed - mandatory
options - of the script - optional. See OptionsBuilder.
nodeFilters - for selecting nodes on which the script will be executed. See NodeFiltersBuilder
poolingInterval - for checking the status of the execution. Must be > 0.
poolingUnit - unit (seconds, milli-seconds, ...) of the interval. Default to seconds. +
Returns:
a RundeckExecution instance for the (finished/aborted) execution - won't be null +
Throws: +
RundeckApiException - in case of error when calling the API (non-existent project with this name) +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project or scriptFilename is blank (null, empty or whitespace) +
IOException - if we failed to read the file
See Also:
runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit), +triggerAdhocScript(String, String, Properties, Properties)
+
+
+
+ +

+runAdhocScript

+
+public RundeckExecution runAdhocScript(String project,
+                                       String scriptFilename,
+                                       Properties options,
+                                       Properties nodeFilters,
+                                       Integer nodeThreadcount,
+                                       Boolean nodeKeepgoing)
+                                throws RundeckApiException,
+                                       RundeckApiException.RundeckApiLoginException,
+                                       IllegalArgumentException,
+                                       IOException
+
+
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck + server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still + running. The script will be dispatched to nodes, accordingly to the nodeFilters parameter. +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
scriptFilename - filename of the script to be executed - mandatory
options - of the script - optional. See OptionsBuilder.
nodeFilters - for selecting nodes on which the script will be executed. See NodeFiltersBuilder
nodeThreadcount - thread count to use (for parallelizing when running on multiple nodes) - optional
nodeKeepgoing - if true, continue executing on other nodes even if some fail - optional +
Returns:
a RundeckExecution instance for the (finished/aborted) execution - won't be null +
Throws: +
RundeckApiException - in case of error when calling the API (non-existent project with this name) +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project or scriptFilename is blank (null, empty or whitespace) +
IOException - if we failed to read the file
See Also:
runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit), +triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean)
+
+
+
+ +

+runAdhocScript

+
+public RundeckExecution runAdhocScript(String project,
+                                       String scriptFilename,
+                                       Properties options,
+                                       Properties nodeFilters,
+                                       Integer nodeThreadcount,
+                                       Boolean nodeKeepgoing,
+                                       long poolingInterval,
+                                       TimeUnit poolingUnit)
+                                throws RundeckApiException,
+                                       RundeckApiException.RundeckApiLoginException,
+                                       IllegalArgumentException,
+                                       IOException
+
+
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck + server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is + finished (or aborted) or is still running. The script will be dispatched to nodes, accordingly to the nodeFilters + parameter. +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
scriptFilename - filename of the script to be executed - mandatory
options - of the script - optional. See OptionsBuilder.
nodeFilters - for selecting nodes on which the script will be executed. See NodeFiltersBuilder
nodeThreadcount - thread count to use (for parallelizing when running on multiple nodes) - optional
nodeKeepgoing - if true, continue executing on other nodes even if some fail - optional
poolingInterval - for checking the status of the execution. Must be > 0.
poolingUnit - unit (seconds, milli-seconds, ...) of the interval. Default to seconds. +
Returns:
a RundeckExecution instance for the (finished/aborted) execution - won't be null +
Throws: +
RundeckApiException - in case of error when calling the API (non-existent project with this name) +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project or scriptFilename is blank (null, empty or whitespace) +
IOException - if we failed to read the file
See Also:
runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit), +triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean)
+
+
+
+ +

+runAdhocScript

+
+public RundeckExecution runAdhocScript(String project,
+                                       InputStream script)
+                                throws RundeckApiException,
+                                       RundeckApiException.RundeckApiLoginException,
+                                       IllegalArgumentException,
+                                       IOException
+
+
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck + server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still + running. The script will not be dispatched to nodes, but be executed on the RunDeck server. +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
script - inputStream for reading the script to be executed - mandatory +
Returns:
a RundeckExecution instance for the (finished/aborted) execution - won't be null +
Throws: +
RundeckApiException - in case of error when calling the API (non-existent project with this name) +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project is blank (null, empty or whitespace) or the script is null +
IOException - if we failed to read the file
See Also:
runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit), +triggerAdhocScript(String, InputStream)
+
+
+
+ +

+runAdhocScript

+
+public RundeckExecution runAdhocScript(String project,
+                                       InputStream script,
+                                       long poolingInterval,
+                                       TimeUnit poolingUnit)
+                                throws RundeckApiException,
+                                       RundeckApiException.RundeckApiLoginException,
+                                       IllegalArgumentException,
+                                       IOException
+
+
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck + server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is + finished (or aborted) or is still running. The script will not be dispatched to nodes, but be executed on the + RunDeck server. +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
script - inputStream for reading the script to be executed - mandatory
poolingInterval - for checking the status of the execution. Must be > 0.
poolingUnit - unit (seconds, milli-seconds, ...) of the interval. Default to seconds. +
Returns:
a RundeckExecution instance for the (finished/aborted) execution - won't be null +
Throws: +
RundeckApiException - in case of error when calling the API (non-existent project with this name) +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project is blank (null, empty or whitespace) or the script is null +
IOException - if we failed to read the file
See Also:
runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit), +triggerAdhocScript(String, InputStream)
+
+
+
+ +

+runAdhocScript

+
+public RundeckExecution runAdhocScript(String project,
+                                       InputStream script,
+                                       Properties options)
+                                throws RundeckApiException,
+                                       RundeckApiException.RundeckApiLoginException,
+                                       IllegalArgumentException,
+                                       IOException
+
+
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck + server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still + running. The script will not be dispatched to nodes, but be executed on the RunDeck server. +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
script - inputStream for reading the script to be executed - mandatory
options - of the script - optional. See OptionsBuilder. +
Returns:
a RundeckExecution instance for the (finished/aborted) execution - won't be null +
Throws: +
RundeckApiException - in case of error when calling the API (non-existent project with this name) +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project is blank (null, empty or whitespace) or the script is null +
IOException - if we failed to read the file
See Also:
runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit), +triggerAdhocScript(String, InputStream, Properties)
+
+
+
+ +

+runAdhocScript

+
+public RundeckExecution runAdhocScript(String project,
+                                       InputStream script,
+                                       Properties options,
+                                       long poolingInterval,
+                                       TimeUnit poolingUnit)
+                                throws RundeckApiException,
+                                       RundeckApiException.RundeckApiLoginException,
+                                       IllegalArgumentException,
+                                       IOException
+
+
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck + server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is + finished (or aborted) or is still running. The script will not be dispatched to nodes, but be executed on the + RunDeck server. +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
script - inputStream for reading the script to be executed - mandatory
options - of the script - optional. See OptionsBuilder.
poolingInterval - for checking the status of the execution. Must be > 0.
poolingUnit - unit (seconds, milli-seconds, ...) of the interval. Default to seconds. +
Returns:
a RundeckExecution instance for the (finished/aborted) execution - won't be null +
Throws: +
RundeckApiException - in case of error when calling the API (non-existent project with this name) +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project is blank (null, empty or whitespace) or the script is null +
IOException - if we failed to read the file
See Also:
runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit), +triggerAdhocScript(String, InputStream, Properties)
+
+
+
+ +

+runAdhocScript

+
+public RundeckExecution runAdhocScript(String project,
+                                       InputStream script,
+                                       Properties options,
+                                       Properties nodeFilters)
+                                throws RundeckApiException,
+                                       RundeckApiException.RundeckApiLoginException,
+                                       IllegalArgumentException,
+                                       IOException
+
+
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck + server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still + running. The script will be dispatched to nodes, accordingly to the nodeFilters parameter. +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
script - inputStream for reading the script to be executed - mandatory
options - of the script - optional. See OptionsBuilder.
nodeFilters - for selecting nodes on which the script will be executed. See NodeFiltersBuilder +
Returns:
a RundeckExecution instance for the (finished/aborted) execution - won't be null +
Throws: +
RundeckApiException - in case of error when calling the API (non-existent project with this name) +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project is blank (null, empty or whitespace) or the script is null +
IOException - if we failed to read the file
See Also:
runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit), +triggerAdhocScript(String, InputStream, Properties, Properties)
+
+
+
+ +

+runAdhocScript

+
+public RundeckExecution runAdhocScript(String project,
+                                       InputStream script,
+                                       Properties options,
+                                       Properties nodeFilters,
+                                       long poolingInterval,
+                                       TimeUnit poolingUnit)
+                                throws RundeckApiException,
+                                       RundeckApiException.RundeckApiLoginException,
+                                       IllegalArgumentException,
+                                       IOException
+
+
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck + server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is + finished (or aborted) or is still running. The script will be dispatched to nodes, accordingly to the nodeFilters + parameter. +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
script - inputStream for reading the script to be executed - mandatory
options - of the script - optional. See OptionsBuilder.
nodeFilters - for selecting nodes on which the script will be executed. See NodeFiltersBuilder
poolingInterval - for checking the status of the execution. Must be > 0.
poolingUnit - unit (seconds, milli-seconds, ...) of the interval. Default to seconds. +
Returns:
a RundeckExecution instance for the (finished/aborted) execution - won't be null +
Throws: +
RundeckApiException - in case of error when calling the API (non-existent project with this name) +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project is blank (null, empty or whitespace) or the script is null +
IOException - if we failed to read the file
See Also:
runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit), +triggerAdhocScript(String, InputStream, Properties, Properties)
+
+
+
+ +

+runAdhocScript

+
+public RundeckExecution runAdhocScript(String project,
+                                       InputStream script,
+                                       Properties options,
+                                       Properties nodeFilters,
+                                       Integer nodeThreadcount,
+                                       Boolean nodeKeepgoing)
+                                throws RundeckApiException,
+                                       RundeckApiException.RundeckApiLoginException,
+                                       IllegalArgumentException,
+                                       IOException
+
+
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck + server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still + running. The script will be dispatched to nodes, accordingly to the nodeFilters parameter. +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
script - inputStream for reading the script to be executed - mandatory
options - of the script - optional. See OptionsBuilder.
nodeFilters - for selecting nodes on which the script will be executed. See NodeFiltersBuilder
nodeThreadcount - thread count to use (for parallelizing when running on multiple nodes) - optional
nodeKeepgoing - if true, continue executing on other nodes even if some fail - optional +
Returns:
a RundeckExecution instance for the (finished/aborted) execution - won't be null +
Throws: +
RundeckApiException - in case of error when calling the API (non-existent project with this name) +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project is blank (null, empty or whitespace) or the script is null +
IOException - if we failed to read the file
See Also:
runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit), +triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean)
+
+
+
+ +

+runAdhocScript

+
+public RundeckExecution runAdhocScript(String project,
+                                       InputStream script,
+                                       Properties options,
+                                       Properties nodeFilters,
+                                       Integer nodeThreadcount,
+                                       Boolean nodeKeepgoing,
+                                       long poolingInterval,
+                                       TimeUnit poolingUnit)
+                                throws RundeckApiException,
+                                       RundeckApiException.RundeckApiLoginException,
+                                       IllegalArgumentException
+
+
Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck + server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is + finished (or aborted) or is still running. The script will be dispatched to nodes, accordingly to the nodeFilters + parameter. +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
script - inputStream for reading the script to be executed - mandatory
options - of the script - optional. See OptionsBuilder.
nodeFilters - for selecting nodes on which the script will be executed. See NodeFiltersBuilder
nodeThreadcount - thread count to use (for parallelizing when running on multiple nodes) - optional
nodeKeepgoing - if true, continue executing on other nodes even if some fail - optional
poolingInterval - for checking the status of the execution. Must be > 0.
poolingUnit - unit (seconds, milli-seconds, ...) of the interval. Default to seconds. +
Returns:
a RundeckExecution instance for the (finished/aborted) execution - won't be null +
Throws: +
RundeckApiException - in case of error when calling the API (non-existent project with this name) +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project is blank (null, empty or whitespace) or the script is null +
IOException - if we failed to read the file
See Also:
runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit), +triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean)
+
+
+
+

getRunningExecutions

@@ -2268,7 +3415,7 @@ public RundeckApiException - in case of error when calling the API (non-existent job with this ID)
 
RundeckApiException.RundeckApiLoginException - if the login failed
-
IllegalArgumentException - if the jobId is blank (null, empty or whitespace)
See Also:
#getJobExecutions(String, ExecutionStatus, Long, Long)
+
IllegalArgumentException - if the jobId is blank (null, empty or whitespace)
See Also:
getJobExecutions(String, RundeckExecution.ExecutionStatus, Long, Long)
 

 
 

@@ -2294,7 +3441,7 @@ public RundeckApiException - in case of error when calling the API (non-existent job with this ID)
 
RundeckApiException.RundeckApiLoginException - if the login failed
 
IllegalArgumentException - if the jobId is blank (null, empty or whitespace), or the executionStatus is
-             invalid
See Also:
#getJobExecutions(String, ExecutionStatus, Long, Long)
+             invalid
See Also:
getJobExecutions(String, String, Long, Long)
 

 
 

@@ -2319,7 +3466,7 @@ public RundeckApiException - in case of error when calling the API (non-existent job with this ID)
 
RundeckApiException.RundeckApiLoginException - if the login failed
-
IllegalArgumentException - if the jobId is blank (null, empty or whitespace)
See Also:
#getJobExecutions(String, ExecutionStatus, Long, Long)
+
IllegalArgumentException - if the jobId is blank (null, empty or whitespace)
See Also:
getJobExecutions(String, RundeckExecution.ExecutionStatus, Long, Long)
 

 
 

@@ -2347,7 +3494,7 @@ public RundeckApiException - in case of error when calling the API (non-existent job with this ID)
 
RundeckApiException.RundeckApiLoginException - if the login failed
 
IllegalArgumentException - if the jobId is blank (null, empty or whitespace), or the executionStatus is
-             invalid
See Also:
#getJobExecutions(String, ExecutionStatus, Long, Long)
+             invalid
See Also:
getJobExecutions(String, RundeckExecution.ExecutionStatus, Long, Long)
 

 
 

@@ -2427,6 +3574,256 @@ public 

+getHistory

+
+public RundeckHistory getHistory(String project)
+                          throws RundeckApiException,
+                                 RundeckApiException.RundeckApiLoginException,
+                                 IllegalArgumentException

+

+
Get the (events) history for the given project
+

+

+

+

+

+
Parameters:
project - name of the project - mandatory
+
Returns:
a RundeckHistory instance - won't be null
+
Throws:
+
RundeckApiException - in case of error when calling the API (non-existent project with this name)
+
RundeckApiException.RundeckApiLoginException - if the login failed
+
IllegalArgumentException - if the project is blank (null, empty or whitespace)
See Also:
getHistory(String, String, String, String, String, Date, Date, Long, Long)

+

+

+

+
+

+getHistory

+
+public RundeckHistory getHistory(String project,
+                                 Long max,
+                                 Long offset)
+                          throws RundeckApiException,
+                                 RundeckApiException.RundeckApiLoginException,
+                                 IllegalArgumentException

+

+
Get the (events) history for the given project
+

+

+

+

+

+
Parameters:
project - name of the project - mandatory
max - number of results to return - optional (default to 20)
offset - the 0-indexed offset for the first result to return - optional (default to O)
+
Returns:
a RundeckHistory instance - won't be null
+
Throws:
+
RundeckApiException - in case of error when calling the API (non-existent project with this name)
+
RundeckApiException.RundeckApiLoginException - if the login failed
+
IllegalArgumentException - if the project is blank (null, empty or whitespace)
See Also:
getHistory(String, String, String, String, String, Date, Date, Long, Long)

+

+

+

+
+

+getHistory

+
+public RundeckHistory getHistory(String project,
+                                 String jobId,
+                                 String reportId,
+                                 String user)
+                          throws RundeckApiException,
+                                 RundeckApiException.RundeckApiLoginException,
+                                 IllegalArgumentException

+

+
Get the (events) history for the given project
+

+

+

+

+

+
Parameters:
project - name of the project - mandatory
jobId - include only events matching the given job ID - optional
reportId - include only events matching the given report ID - optional
user - include only events created by the given user - optional
+
Returns:
a RundeckHistory instance - won't be null
+
Throws:
+
RundeckApiException - in case of error when calling the API (non-existent project with this name)
+
RundeckApiException.RundeckApiLoginException - if the login failed
+
IllegalArgumentException - if the project is blank (null, empty or whitespace)
See Also:
getHistory(String, String, String, String, String, Date, Date, Long, Long)

+

+

+

+
+

+getHistory

+
+public RundeckHistory getHistory(String project,
+                                 String jobId,
+                                 String reportId,
+                                 String user,
+                                 Long max,
+                                 Long offset)
+                          throws RundeckApiException,
+                                 RundeckApiException.RundeckApiLoginException,
+                                 IllegalArgumentException

+

+
Get the (events) history for the given project
+

+

+

+

+

+
Parameters:
project - name of the project - mandatory
jobId - include only events matching the given job ID - optional
reportId - include only events matching the given report ID - optional
user - include only events created by the given user - optional
max - number of results to return - optional (default to 20)
offset - the 0-indexed offset for the first result to return - optional (default to O)
+
Returns:
a RundeckHistory instance - won't be null
+
Throws:
+
RundeckApiException - in case of error when calling the API (non-existent project with this name)
+
RundeckApiException.RundeckApiLoginException - if the login failed
+
IllegalArgumentException - if the project is blank (null, empty or whitespace)
See Also:
getHistory(String, String, String, String, String, Date, Date, Long, Long)

+

+

+

+
+

+getHistory

+
+public RundeckHistory getHistory(String project,
+                                 String recent)
+                          throws RundeckApiException,
+                                 RundeckApiException.RundeckApiLoginException,
+                                 IllegalArgumentException

+

+
Get the (events) history for the given project
+

+

+

+

+

+
Parameters:
project - name of the project - mandatory
recent - include only events matching the given period of time. Format : "XY", where X is an integer, and Y
+            is one of : "h" (hour), "d" (day), "w" (week), "m" (month), "y" (year). Example : "2w" (= last 2
+            weeks), "5d" (= last 5 days), etc. Optional.
+
Returns:
a RundeckHistory instance - won't be null
+
Throws:
+
RundeckApiException - in case of error when calling the API (non-existent project with this name)
+
RundeckApiException.RundeckApiLoginException - if the login failed
+
IllegalArgumentException - if the project is blank (null, empty or whitespace)
See Also:
getHistory(String, String, String, String, String, Date, Date, Long, Long)

+

+

+

+
+

+getHistory

+
+public RundeckHistory getHistory(String project,
+                                 String recent,
+                                 Long max,
+                                 Long offset)
+                          throws RundeckApiException,
+                                 RundeckApiException.RundeckApiLoginException,
+                                 IllegalArgumentException

+

+
Get the (events) history for the given project
+

+

+

+

+

+
Parameters:
project - name of the project - mandatory
recent - include only events matching the given period of time. Format : "XY", where X is an integer, and Y
+            is one of : "h" (hour), "d" (day), "w" (week), "m" (month), "y" (year). Example : "2w" (= last 2
+            weeks), "5d" (= last 5 days), etc. Optional.
max - number of results to return - optional (default to 20)
offset - the 0-indexed offset for the first result to return - optional (default to O)
+
Returns:
a RundeckHistory instance - won't be null
+
Throws:
+
RundeckApiException - in case of error when calling the API (non-existent project with this name)
+
RundeckApiException.RundeckApiLoginException - if the login failed
+
IllegalArgumentException - if the project is blank (null, empty or whitespace)
See Also:
getHistory(String, String, String, String, String, Date, Date, Long, Long)

+

+

+

+
+

+getHistory

+
+public RundeckHistory getHistory(String project,
+                                 Date begin,
+                                 Date end)
+                          throws RundeckApiException,
+                                 RundeckApiException.RundeckApiLoginException,
+                                 IllegalArgumentException

+

+
Get the (events) history for the given project
+

+

+

+

+

+
Parameters:
project - name of the project - mandatory
begin - date for the earlier events to retrieve - optional
end - date for the latest events to retrieve - optional
+
Returns:
a RundeckHistory instance - won't be null
+
Throws:
+
RundeckApiException - in case of error when calling the API (non-existent project with this name)
+
RundeckApiException.RundeckApiLoginException - if the login failed
+
IllegalArgumentException - if the project is blank (null, empty or whitespace)
See Also:
getHistory(String, String, String, String, String, Date, Date, Long, Long)

+

+

+

+
+

+getHistory

+
+public RundeckHistory getHistory(String project,
+                                 Date begin,
+                                 Date end,
+                                 Long max,
+                                 Long offset)
+                          throws RundeckApiException,
+                                 RundeckApiException.RundeckApiLoginException,
+                                 IllegalArgumentException

+

+
Get the (events) history for the given project
+

+

+

+

+

+
Parameters:
project - name of the project - mandatory
begin - date for the earlier events to retrieve - optional
end - date for the latest events to retrieve - optional
max - number of results to return - optional (default to 20)
offset - the 0-indexed offset for the first result to return - optional (default to O)
+
Returns:
a RundeckHistory instance - won't be null
+
Throws:
+
RundeckApiException - in case of error when calling the API (non-existent project with this name)
+
RundeckApiException.RundeckApiLoginException - if the login failed
+
IllegalArgumentException - if the project is blank (null, empty or whitespace)
See Also:
getHistory(String, String, String, String, String, Date, Date, Long, Long)

+

+

+

+
+

+getHistory

+
+public RundeckHistory getHistory(String project,
+                                 String jobId,
+                                 String reportId,
+                                 String user,
+                                 String recent,
+                                 Date begin,
+                                 Date end,
+                                 Long max,
+                                 Long offset)
+                          throws RundeckApiException,
+                                 RundeckApiException.RundeckApiLoginException,
+                                 IllegalArgumentException

+

+
Get the (events) history for the given project
+

+

+

+

+

+
Parameters:
project - name of the project - mandatory
jobId - include only events matching the given job ID - optional
reportId - include only events matching the given report ID - optional
user - include only events created by the given user - optional
recent - include only events matching the given period of time. Format : "XY", where X is an integer, and Y
+            is one of : "h" (hour), "d" (day), "w" (week), "m" (month), "y" (year). Example : "2w" (= last 2
+            weeks), "5d" (= last 5 days), etc. Optional.
begin - date for the earlier events to retrieve - optional
end - date for the latest events to retrieve - optional
max - number of results to return - optional (default to 20)
offset - the 0-indexed offset for the first result to return - optional (default to O)
+
Returns:
a RundeckHistory instance - won't be null
+
Throws:
+
RundeckApiException - in case of error when calling the API (non-existent project with this name)
+
RundeckApiException.RundeckApiLoginException - if the login failed
+
IllegalArgumentException - if the project is blank (null, empty or whitespace)

+

+

+

+
 

 getNodes

 
@@ -2555,7 +3952,8 @@ public 
 
 
 

@@ -2569,7 +3967,8 @@ public 
 
 

-

+
+
Returns:
the password used for authentication on the RunDeck instance
 

 
 

diff --git a/apidocs/org/rundeck/api/class-use/FileType.html b/apidocs/org/rundeck/api/class-use/FileType.html
index 054132d..9ed729f 100644
--- a/apidocs/org/rundeck/api/class-use/FileType.html
+++ b/apidocs/org/rundeck/api/class-use/FileType.html
@@ -2,13 +2,13 @@
 
 
 
-
+
 
 
-Uses of Class org.rundeck.api.FileType (RunDeck API - Java Client 1.1 API)
+Uses of Class org.rundeck.api.FileType (RunDeck API - Java Client 1.2 API)
 
 
-
+
 
 
 
@@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.FileType (RunDeck API - Java Client 1.1 API)
 function windowTitle()
 {
     if (location.href.indexOf('is-external=true') == -1) {
-        parent.document.title="Uses of Class org.rundeck.api.FileType (RunDeck API - Java Client 1.1 API)";
+        parent.document.title="Uses of Class org.rundeck.api.FileType (RunDeck API - Java Client 1.2 API)";
     }
 }
 
diff --git a/apidocs/org/rundeck/api/class-use/NodeFiltersBuilder.html b/apidocs/org/rundeck/api/class-use/NodeFiltersBuilder.html
index ae968f9..fd55723 100644
--- a/apidocs/org/rundeck/api/class-use/NodeFiltersBuilder.html
+++ b/apidocs/org/rundeck/api/class-use/NodeFiltersBuilder.html
@@ -2,13 +2,13 @@
 
 
 
-
+
 
 
-Uses of Class org.rundeck.api.NodeFiltersBuilder (RunDeck API - Java Client 1.1 API)
+Uses of Class org.rundeck.api.NodeFiltersBuilder (RunDeck API - Java Client 1.2 API)
 
 
-
+
 
 
 
@@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.NodeFiltersBuilder (RunDeck API - Java Client 1.1
 function windowTitle()
 {
     if (location.href.indexOf('is-external=true') == -1) {
-        parent.document.title="Uses of Class org.rundeck.api.NodeFiltersBuilder (RunDeck API - Java Client 1.1 API)";
+        parent.document.title="Uses of Class org.rundeck.api.NodeFiltersBuilder (RunDeck API - Java Client 1.2 API)";
     }
 }
 
diff --git a/apidocs/org/rundeck/api/class-use/OptionsBuilder.html b/apidocs/org/rundeck/api/class-use/OptionsBuilder.html
index cda3373..d9cdf11 100644
--- a/apidocs/org/rundeck/api/class-use/OptionsBuilder.html
+++ b/apidocs/org/rundeck/api/class-use/OptionsBuilder.html
@@ -2,13 +2,13 @@
 
 
 
-
+
 
 
-Uses of Class org.rundeck.api.OptionsBuilder (RunDeck API - Java Client 1.1 API)
+Uses of Class org.rundeck.api.OptionsBuilder (RunDeck API - Java Client 1.2 API)
 
 
-
+
 
 
 
@@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.OptionsBuilder (RunDeck API - Java Client 1.1 API)
 function windowTitle()
 {
     if (location.href.indexOf('is-external=true') == -1) {
-        parent.document.title="Uses of Class org.rundeck.api.OptionsBuilder (RunDeck API - Java Client 1.1 API)";
+        parent.document.title="Uses of Class org.rundeck.api.OptionsBuilder (RunDeck API - Java Client 1.2 API)";
     }
 }
 
diff --git a/apidocs/org/rundeck/api/class-use/RundeckApiException.RundeckApiLoginException.html b/apidocs/org/rundeck/api/class-use/RundeckApiException.RundeckApiLoginException.html
index 5fab596..ac126a5 100644
--- a/apidocs/org/rundeck/api/class-use/RundeckApiException.RundeckApiLoginException.html
+++ b/apidocs/org/rundeck/api/class-use/RundeckApiException.RundeckApiLoginException.html
@@ -2,13 +2,13 @@
 
 
 
-
+
 
 
-Uses of Class org.rundeck.api.RundeckApiException.RundeckApiLoginException (RunDeck API - Java Client 1.1 API)
+Uses of Class org.rundeck.api.RundeckApiException.RundeckApiLoginException (RunDeck API - Java Client 1.2 API)
 
 
-
+
 
 
 
@@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.RundeckApiException.RundeckApiLoginException (RunD
 function windowTitle()
 {
     if (location.href.indexOf('is-external=true') == -1) {
-        parent.document.title="Uses of Class org.rundeck.api.RundeckApiException.RundeckApiLoginException (RunDeck API - Java Client 1.1 API)";
+        parent.document.title="Uses of Class org.rundeck.api.RundeckApiException.RundeckApiLoginException (RunDeck API - Java Client 1.2 API)";
     }
 }
 
@@ -277,6 +277,106 @@ Uses of 
 
+ RundeckHistory
+RundeckClient.getHistory(String project)
+
+

+          Get the (events) history for the given project
+
+
+
+ RundeckHistory
+RundeckClient.getHistory(String project,
+           Date begin,
+           Date end)
+
+

+          Get the (events) history for the given project
+
+
+
+ RundeckHistory
+RundeckClient.getHistory(String project,
+           Date begin,
+           Date end,
+           Long max,
+           Long offset)
+
+

+          Get the (events) history for the given project
+
+
+
+ RundeckHistory
+RundeckClient.getHistory(String project,
+           Long max,
+           Long offset)
+
+

+          Get the (events) history for the given project
+
+
+
+ RundeckHistory
+RundeckClient.getHistory(String project,
+           String recent)
+
+

+          Get the (events) history for the given project
+
+
+
+ RundeckHistory
+RundeckClient.getHistory(String project,
+           String recent,
+           Long max,
+           Long offset)
+
+

+          Get the (events) history for the given project
+
+
+
+ RundeckHistory
+RundeckClient.getHistory(String project,
+           String jobId,
+           String reportId,
+           String user)
+
+

+          Get the (events) history for the given project
+
+
+
+ RundeckHistory
+RundeckClient.getHistory(String project,
+           String jobId,
+           String reportId,
+           String user,
+           Long max,
+           Long offset)
+
+

+          Get the (events) history for the given project
+
+
+
+ RundeckHistory
+RundeckClient.getHistory(String project,
+           String jobId,
+           String reportId,
+           String user,
+           String recent,
+           Date begin,
+           Date end,
+           Long max,
+           Long offset)
+
+

+          Get the (events) history for the given project
+
+
+
  RundeckJob
 RundeckClient.getJob(String jobId)
 
@@ -579,6 +679,194 @@ Uses of 
 
  RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               InputStream script)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               InputStream script,
+               long poolingInterval,
+               TimeUnit poolingUnit)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               InputStream script,
+               Properties options)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               InputStream script,
+               Properties options,
+               long poolingInterval,
+               TimeUnit poolingUnit)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               InputStream script,
+               Properties options,
+               Properties nodeFilters)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               InputStream script,
+               Properties options,
+               Properties nodeFilters,
+               Integer nodeThreadcount,
+               Boolean nodeKeepgoing)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               InputStream script,
+               Properties options,
+               Properties nodeFilters,
+               Integer nodeThreadcount,
+               Boolean nodeKeepgoing,
+               long poolingInterval,
+               TimeUnit poolingUnit)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               InputStream script,
+               Properties options,
+               Properties nodeFilters,
+               long poolingInterval,
+               TimeUnit poolingUnit)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               String scriptFilename)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               String scriptFilename,
+               long poolingInterval,
+               TimeUnit poolingUnit)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               String scriptFilename,
+               Properties options)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               String scriptFilename,
+               Properties options,
+               long poolingInterval,
+               TimeUnit poolingUnit)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               String scriptFilename,
+               Properties options,
+               Properties nodeFilters)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               String scriptFilename,
+               Properties options,
+               Properties nodeFilters,
+               Integer nodeThreadcount,
+               Boolean nodeKeepgoing)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               String scriptFilename,
+               Properties options,
+               Properties nodeFilters,
+               Integer nodeThreadcount,
+               Boolean nodeKeepgoing,
+               long poolingInterval,
+               TimeUnit poolingUnit)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               String scriptFilename,
+               Properties options,
+               Properties nodeFilters,
+               long poolingInterval,
+               TimeUnit poolingUnit)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
 RundeckClient.runJob(String jobId)
 
 

@@ -668,6 +956,92 @@ Uses of 
 
  RundeckExecution
+RundeckClient.triggerAdhocScript(String project,
+                   InputStream script)
+
+

+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).
+
+
+
+ RundeckExecution
+RundeckClient.triggerAdhocScript(String project,
+                   InputStream script,
+                   Properties options)
+
+

+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).
+
+
+
+ RundeckExecution
+RundeckClient.triggerAdhocScript(String project,
+                   InputStream script,
+                   Properties options,
+                   Properties nodeFilters)
+
+

+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).
+
+
+
+ RundeckExecution
+RundeckClient.triggerAdhocScript(String project,
+                   InputStream script,
+                   Properties options,
+                   Properties nodeFilters,
+                   Integer nodeThreadcount,
+                   Boolean nodeKeepgoing)
+
+

+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).
+
+
+
+ RundeckExecution
+RundeckClient.triggerAdhocScript(String project,
+                   String scriptFilename)
+
+

+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).
+
+
+
+ RundeckExecution
+RundeckClient.triggerAdhocScript(String project,
+                   String scriptFilename,
+                   Properties options)
+
+

+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).
+
+
+
+ RundeckExecution
+RundeckClient.triggerAdhocScript(String project,
+                   String scriptFilename,
+                   Properties options,
+                   Properties nodeFilters)
+
+

+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).
+
+
+
+ RundeckExecution
+RundeckClient.triggerAdhocScript(String project,
+                   String scriptFilename,
+                   Properties options,
+                   Properties nodeFilters,
+                   Integer nodeThreadcount,
+                   Boolean nodeKeepgoing)
+
+

+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).
+
+
+
+ RundeckExecution
 RundeckClient.triggerJob(String jobId)
 
 

diff --git a/apidocs/org/rundeck/api/class-use/RundeckApiException.html b/apidocs/org/rundeck/api/class-use/RundeckApiException.html
index b510e25..90cf357 100644
--- a/apidocs/org/rundeck/api/class-use/RundeckApiException.html
+++ b/apidocs/org/rundeck/api/class-use/RundeckApiException.html
@@ -2,13 +2,13 @@
 
 
 
-
+
 
 
-Uses of Class org.rundeck.api.RundeckApiException (RunDeck API - Java Client 1.1 API)
+Uses of Class org.rundeck.api.RundeckApiException (RunDeck API - Java Client 1.2 API)
 
 
-
+
 
 
 
@@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.RundeckApiException (RunDeck API - Java Client 1.1
 function windowTitle()
 {
     if (location.href.indexOf('is-external=true') == -1) {
-        parent.document.title="Uses of Class org.rundeck.api.RundeckApiException (RunDeck API - Java Client 1.1 API)";
+        parent.document.title="Uses of Class org.rundeck.api.RundeckApiException (RunDeck API - Java Client 1.2 API)";
     }
 }
 
@@ -297,6 +297,106 @@ Uses of 
 
+ RundeckHistory
+RundeckClient.getHistory(String project)
+
+

+          Get the (events) history for the given project
+
+
+
+ RundeckHistory
+RundeckClient.getHistory(String project,
+           Date begin,
+           Date end)
+
+

+          Get the (events) history for the given project
+
+
+
+ RundeckHistory
+RundeckClient.getHistory(String project,
+           Date begin,
+           Date end,
+           Long max,
+           Long offset)
+
+

+          Get the (events) history for the given project
+
+
+
+ RundeckHistory
+RundeckClient.getHistory(String project,
+           Long max,
+           Long offset)
+
+

+          Get the (events) history for the given project
+
+
+
+ RundeckHistory
+RundeckClient.getHistory(String project,
+           String recent)
+
+

+          Get the (events) history for the given project
+
+
+
+ RundeckHistory
+RundeckClient.getHistory(String project,
+           String recent,
+           Long max,
+           Long offset)
+
+

+          Get the (events) history for the given project
+
+
+
+ RundeckHistory
+RundeckClient.getHistory(String project,
+           String jobId,
+           String reportId,
+           String user)
+
+

+          Get the (events) history for the given project
+
+
+
+ RundeckHistory
+RundeckClient.getHistory(String project,
+           String jobId,
+           String reportId,
+           String user,
+           Long max,
+           Long offset)
+
+

+          Get the (events) history for the given project
+
+
+
+ RundeckHistory
+RundeckClient.getHistory(String project,
+           String jobId,
+           String reportId,
+           String user,
+           String recent,
+           Date begin,
+           Date end,
+           Long max,
+           Long offset)
+
+

+          Get the (events) history for the given project
+
+
+
  RundeckJob
 RundeckClient.getJob(String jobId)
 
@@ -607,6 +707,194 @@ Uses of 
 
  RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               InputStream script)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               InputStream script,
+               long poolingInterval,
+               TimeUnit poolingUnit)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               InputStream script,
+               Properties options)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               InputStream script,
+               Properties options,
+               long poolingInterval,
+               TimeUnit poolingUnit)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               InputStream script,
+               Properties options,
+               Properties nodeFilters)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               InputStream script,
+               Properties options,
+               Properties nodeFilters,
+               Integer nodeThreadcount,
+               Boolean nodeKeepgoing)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               InputStream script,
+               Properties options,
+               Properties nodeFilters,
+               Integer nodeThreadcount,
+               Boolean nodeKeepgoing,
+               long poolingInterval,
+               TimeUnit poolingUnit)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               InputStream script,
+               Properties options,
+               Properties nodeFilters,
+               long poolingInterval,
+               TimeUnit poolingUnit)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               String scriptFilename)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               String scriptFilename,
+               long poolingInterval,
+               TimeUnit poolingUnit)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               String scriptFilename,
+               Properties options)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               String scriptFilename,
+               Properties options,
+               long poolingInterval,
+               TimeUnit poolingUnit)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               String scriptFilename,
+               Properties options,
+               Properties nodeFilters)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               String scriptFilename,
+               Properties options,
+               Properties nodeFilters,
+               Integer nodeThreadcount,
+               Boolean nodeKeepgoing)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               String scriptFilename,
+               Properties options,
+               Properties nodeFilters,
+               Integer nodeThreadcount,
+               Boolean nodeKeepgoing,
+               long poolingInterval,
+               TimeUnit poolingUnit)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
+RundeckClient.runAdhocScript(String project,
+               String scriptFilename,
+               Properties options,
+               Properties nodeFilters,
+               long poolingInterval,
+               TimeUnit poolingUnit)
+
+

+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.
+
+
+
+ RundeckExecution
 RundeckClient.runJob(String jobId)
 
 

@@ -688,6 +976,92 @@ Uses of 
 
  RundeckExecution
+RundeckClient.triggerAdhocScript(String project,
+                   InputStream script)
+
+

+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).
+
+
+
+ RundeckExecution
+RundeckClient.triggerAdhocScript(String project,
+                   InputStream script,
+                   Properties options)
+
+

+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).
+
+
+
+ RundeckExecution
+RundeckClient.triggerAdhocScript(String project,
+                   InputStream script,
+                   Properties options,
+                   Properties nodeFilters)
+
+

+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).
+
+
+
+ RundeckExecution
+RundeckClient.triggerAdhocScript(String project,
+                   InputStream script,
+                   Properties options,
+                   Properties nodeFilters,
+                   Integer nodeThreadcount,
+                   Boolean nodeKeepgoing)
+
+

+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).
+
+
+
+ RundeckExecution
+RundeckClient.triggerAdhocScript(String project,
+                   String scriptFilename)
+
+

+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).
+
+
+
+ RundeckExecution
+RundeckClient.triggerAdhocScript(String project,
+                   String scriptFilename,
+                   Properties options)
+
+

+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).
+
+
+
+ RundeckExecution
+RundeckClient.triggerAdhocScript(String project,
+                   String scriptFilename,
+                   Properties options,
+                   Properties nodeFilters)
+
+

+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).
+
+
+
+ RundeckExecution
+RundeckClient.triggerAdhocScript(String project,
+                   String scriptFilename,
+                   Properties options,
+                   Properties nodeFilters,
+                   Integer nodeThreadcount,
+                   Boolean nodeKeepgoing)
+
+

+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).
+
+
+
+ RundeckExecution
 RundeckClient.triggerJob(String jobId)
 
 

diff --git a/apidocs/org/rundeck/api/class-use/RundeckClient.html b/apidocs/org/rundeck/api/class-use/RundeckClient.html
index 458dd67..0174702 100644
--- a/apidocs/org/rundeck/api/class-use/RundeckClient.html
+++ b/apidocs/org/rundeck/api/class-use/RundeckClient.html
@@ -2,13 +2,13 @@
 
 
 
-
+
 
 
-Uses of Class org.rundeck.api.RundeckClient (RunDeck API - Java Client 1.1 API)
+Uses of Class org.rundeck.api.RundeckClient (RunDeck API - Java Client 1.2 API)
 
 
-
+
 
 
 
@@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.RundeckClient (RunDeck API - Java Client 1.1 API)
 function windowTitle()
 {
     if (location.href.indexOf('is-external=true') == -1) {
-        parent.document.title="Uses of Class org.rundeck.api.RundeckClient (RunDeck API - Java Client 1.1 API)";
+        parent.document.title="Uses of Class org.rundeck.api.RundeckClient (RunDeck API - Java Client 1.2 API)";
     }
 }
 
diff --git a/apidocs/org/rundeck/api/domain/RundeckAbort.AbortStatus.html b/apidocs/org/rundeck/api/domain/RundeckAbort.AbortStatus.html
index 7dbda2b..ab05d2b 100644
--- a/apidocs/org/rundeck/api/domain/RundeckAbort.AbortStatus.html
+++ b/apidocs/org/rundeck/api/domain/RundeckAbort.AbortStatus.html
@@ -2,13 +2,13 @@
 
 
 
-
+
 
 
-RundeckAbort.AbortStatus (RunDeck API - Java Client 1.1 API)
+RundeckAbort.AbortStatus (RunDeck API - Java Client 1.2 API)
 
 
-
+
 
 
 
@@ -16,7 +16,7 @@ RundeckAbort.AbortStatus (RunDeck API - Java Client 1.1 API)
 function windowTitle()
 {
     if (location.href.indexOf('is-external=true') == -1) {
-        parent.document.title="RundeckAbort.AbortStatus (RunDeck API - Java Client 1.1 API)";
+        parent.document.title="RundeckAbort.AbortStatus (RunDeck API - Java Client 1.2 API)";
     }
 }
 
@@ -57,7 +57,7 @@ function windowTitle()
 
 
  PREV CLASS 
- NEXT CLASS
+ NEXT CLASS
 
   FRAMES   
  NO FRAMES   
@@ -312,7 +312,7 @@ with the specified name
 
 
  PREV CLASS 
- NEXT CLASS
+ NEXT CLASS
 
   FRAMES   
  NO FRAMES   
diff --git a/apidocs/org/rundeck/api/domain/RundeckAbort.html b/apidocs/org/rundeck/api/domain/RundeckAbort.html
index c5fea84..ed9072e 100644
--- a/apidocs/org/rundeck/api/domain/RundeckAbort.html
+++ b/apidocs/org/rundeck/api/domain/RundeckAbort.html
@@ -2,13 +2,13 @@
 
 
 
-
+
 
 
-RundeckAbort (RunDeck API - Java Client 1.1 API)
+RundeckAbort (RunDeck API - Java Client 1.2 API)
 
 
-
+
 
 
 
@@ -16,7 +16,7 @@ RundeckAbort (RunDeck API - Java Client 1.1 API)
 function windowTitle()
 {
     if (location.href.indexOf('is-external=true') == -1) {
-        parent.document.title="RundeckAbort (RunDeck API - Java Client 1.1 API)";
+        parent.document.title="RundeckAbort (RunDeck API - Java Client 1.2 API)";
     }
 }
 
diff --git a/apidocs/org/rundeck/api/domain/RundeckEvent.EventStatus.html b/apidocs/org/rundeck/api/domain/RundeckEvent.EventStatus.html
new file mode 100644
index 0000000..fbd33f7
--- /dev/null
+++ b/apidocs/org/rundeck/api/domain/RundeckEvent.EventStatus.html
@@ -0,0 +1,346 @@
+
+
+
+
+
+
+
+RundeckEvent.EventStatus (RunDeck API - Java Client 1.2 API)
+
+
+
+
+
+
+
+
+
+
+
+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+
+
+  
+  
+  
+  
+  
+  
+  
+  
+  
+  
+
    Overview     Package   Class     Use     Tree     Deprecated     Index     Help 

+		
+
+

+ PREV CLASS 
+ NEXT CLASS
+  FRAMES   
+ NO FRAMES   
+ 
+
+
+
+

+  SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD
+DETAIL: ENUM CONSTANTS | FIELD | METHOD

+
+
+
+

+
+

+
+org.rundeck.api.domain
+

+Enum RundeckEvent.EventStatus

+
+java.lang.Object
+  extended by java.lang.Enum<RundeckEvent.EventStatus>
+      extended by org.rundeck.api.domain.RundeckEvent.EventStatus
+

+

+
All Implemented Interfaces: 
Serializable, Comparable<RundeckEvent.EventStatus>

+

+

+
Enclosing class:
RundeckEvent

+

+

+

+
public static enum RundeckEvent.EventStatus
extends Enum<RundeckEvent.EventStatus>

+

+
+

+The status of an event
+

+
+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+Enum Constant Summary
ABORTED
+
+

+           
FAILED
+
+

+           
SUCCEEDED
+
+

+           

+ 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+Method Summary

+static RundeckEvent.EventStatusvalueOf(String name)
+
+

+          Returns the enum constant of this type with the specified name.

+static RundeckEvent.EventStatus[]values()
+
+

+          Returns an array containing the constants of this enum type, in
+the order they are declared.

+ 
+
+
+
+
+
+
+
+
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

+ 
+
+
+
+
+
+
+
+
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

+ 
+

+
+
+
+
+
+
+
+
+

+Enum Constant Detail

+
+

+SUCCEEDED

+
+public static final RundeckEvent.EventStatus SUCCEEDED

+

+

+

+

+

+
+

+FAILED

+
+public static final RundeckEvent.EventStatus FAILED

+

+

+

+

+

+
+

+ABORTED

+
+public static final RundeckEvent.EventStatus ABORTED

+

+

+

+

+
+
+
+
+
+
+
+
+

+Method Detail

+
+

+values

+
+public static RundeckEvent.EventStatus[] values()

+

+
Returns an array containing the constants of this enum type, in
+the order they are declared.  This method may be used to iterate
+over the constants as follows:
+
+for (RundeckEvent.EventStatus c : RundeckEvent.EventStatus.values())
+    System.out.println(c);
+

+

+

+
+
Returns:
an array containing the constants of this enum type, in
+the order they are declared

+

+

+

+
+

+valueOf

+
+public static RundeckEvent.EventStatus valueOf(String name)

+

+
Returns the enum constant of this type with the specified name.
+The string must match exactly an identifier used to declare an
+enum constant in this type.  (Extraneous whitespace characters are 
+not permitted.)
+

+

+
Parameters:
name - the name of the enum constant to be returned.
+
Returns:
the enum constant with the specified name
+
Throws:
+
IllegalArgumentException - if this enum type has no constant
+with the specified name
+
NullPointerException - if the argument is null

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+
+
+  
+  
+  
+  
+  
+  
+  
+  
+  
+  
+
    Overview     Package   Class     Use     Tree     Deprecated     Index     Help 

+		
+
+

+ PREV CLASS 
+ NEXT CLASS
+  FRAMES   
+ NO FRAMES   
+ 
+
+
+
+

+  SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD
+DETAIL: ENUM CONSTANTS | FIELD | METHOD

+
+
+
+

+Copyright © 2011. All Rights Reserved.
+
+
diff --git a/apidocs/org/rundeck/api/domain/RundeckEvent.NodeSummary.html b/apidocs/org/rundeck/api/domain/RundeckEvent.NodeSummary.html
new file mode 100644
index 0000000..33101a2
--- /dev/null
+++ b/apidocs/org/rundeck/api/domain/RundeckEvent.NodeSummary.html
@@ -0,0 +1,444 @@
+
+
+
+
+
+
+
+RundeckEvent.NodeSummary (RunDeck API - Java Client 1.2 API)
+
+
+
+
+
+
+
+
+
+
+
+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+
+
+  
+  
+  
+  
+  
+  
+  
+  
+  
+  
+
    Overview     Package   Class     Use     Tree     Deprecated     Index     Help 

+		
+
+

+ PREV CLASS 
+ NEXT CLASS
+  FRAMES   
+ NO FRAMES   
+ 
+
+
+
+

+  SUMMARY: NESTED | FIELD | CONSTR | METHOD
+DETAIL: FIELD | CONSTR | METHOD

+
+
+
+

+
+

+
+org.rundeck.api.domain
+

+Class RundeckEvent.NodeSummary

+
+java.lang.Object
+  extended by org.rundeck.api.domain.RundeckEvent.NodeSummary
+

+

+
All Implemented Interfaces: 
Serializable

+

+

+
Enclosing class:
RundeckEvent

+

+

+

+
public static class RundeckEvent.NodeSummary
extends Object
implements Serializable

+
+ +

+Summary for nodes +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
RundeckEvent.NodeSummary() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleanequals(Object obj) + +
+           
+ intgetFailed() + +
+           
+ intgetSucceeded() + +
+           
+ intgetTotal() + +
+           
+ inthashCode() + +
+           
+ voidsetFailed(int failed) + +
+           
+ voidsetSucceeded(int succeeded) + +
+           
+ voidsetTotal(int total) + +
+           
+ StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+RundeckEvent.NodeSummary

+
+public RundeckEvent.NodeSummary()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getSucceeded

+
+public int getSucceeded()
+
+
+
+
+
+
+
+
+
+ +

+setSucceeded

+
+public void setSucceeded(int succeeded)
+
+
+
+
+
+
+
+
+
+ +

+getFailed

+
+public int getFailed()
+
+
+
+
+
+
+
+
+
+ +

+setFailed

+
+public void setFailed(int failed)
+
+
+
+
+
+
+
+
+
+ +

+getTotal

+
+public int getTotal()
+
+
+
+
+
+
+
+
+
+ +

+setTotal

+
+public void setTotal(int total)
+
+
+
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
+
Overrides:
hashCode in class Object
+
+
+
+
+
+
+ +

+equals

+
+public boolean equals(Object obj)
+
+
+
Overrides:
equals in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/domain/RundeckEvent.html b/apidocs/org/rundeck/api/domain/RundeckEvent.html new file mode 100644 index 0000000..f0a9fac --- /dev/null +++ b/apidocs/org/rundeck/api/domain/RundeckEvent.html @@ -0,0 +1,941 @@ + + + + + + + +RundeckEvent (RunDeck API - Java Client 1.2 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.rundeck.api.domain +
+Class RundeckEvent

+
+java.lang.Object
+  extended by org.rundeck.api.domain.RundeckEvent
+
+
+
All Implemented Interfaces:
Serializable
+
+
+
+
public class RundeckEvent
extends Object
implements Serializable
+ + +

+Represents a RunDeck event +

+ +

+

+
Author:
+
Vincent Behar
+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + + + + + +
+Nested Class Summary
+static classRundeckEvent.EventStatus + +
+          The status of an event
+static classRundeckEvent.NodeSummary + +
+          Summary for nodes
+  + + + + + + + + + + +
+Constructor Summary
RundeckEvent() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleanequals(Object obj) + +
+           
+ StringgetAbortedBy() + +
+           
+ StringgetDuration() + +
+           
+ LonggetDurationInMillis() + +
+           
+ LonggetDurationInSeconds() + +
+           
+ DategetEndedAt() + +
+           
+ LonggetExecutionId() + +
+           
+ StringgetJobId() + +
+           
+ RundeckEvent.NodeSummarygetNodeSummary() + +
+           
+ StringgetProject() + +
+           
+ StringgetShortDuration() + +
+           
+ DategetStartedAt() + +
+           
+ RundeckEvent.EventStatusgetStatus() + +
+           
+ StringgetSummary() + +
+           
+ StringgetTitle() + +
+           
+ StringgetUser() + +
+           
+ inthashCode() + +
+           
+ booleanisAdhoc() + +
+           
+ voidsetAbortedBy(String abortedBy) + +
+           
+ voidsetEndedAt(Date endedAt) + +
+           
+ voidsetExecutionId(Long executionId) + +
+           
+ voidsetJobId(String jobId) + +
+           
+ voidsetNodeSummary(RundeckEvent.NodeSummary nodeSummary) + +
+           
+ voidsetProject(String project) + +
+           
+ voidsetStartedAt(Date startedAt) + +
+           
+ voidsetStatus(RundeckEvent.EventStatus status) + +
+           
+ voidsetSummary(String summary) + +
+           
+ voidsetTitle(String title) + +
+           
+ voidsetUser(String user) + +
+           
+ StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+RundeckEvent

+
+public RundeckEvent()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getDurationInMillis

+
+public Long getDurationInMillis()
+
+
+
+
+
+ +
Returns:
the duration of the event in milliseconds (or null if the dates are invalid)
+
+
+
+ +

+getDurationInSeconds

+
+public Long getDurationInSeconds()
+
+
+
+
+
+ +
Returns:
the duration of the event in seconds (or null if the dates are invalid)
+
+
+
+ +

+getDuration

+
+public String getDuration()
+
+
+
+
+
+ +
Returns:
the duration of the event, as a human-readable string : "3 minutes 34 seconds" (or null if the dates are + invalid)
+
+
+
+ +

+getShortDuration

+
+public String getShortDuration()
+
+
+
+
+
+ +
Returns:
the duration of the event, as a "short" human-readable string : "0:03:34.187" (or null if the dates are + invalid)
+
+
+
+ +

+isAdhoc

+
+public boolean isAdhoc()
+
+
+
+
+
+ +
Returns:
true if this event is for an ad-hoc command or script, false otherwise (for a job)
+
+
+
+ +

+getTitle

+
+public String getTitle()
+
+
+
+
+
+
+
+
+
+ +

+setTitle

+
+public void setTitle(String title)
+
+
+
+
+
+
+
+
+
+ +

+getStatus

+
+public RundeckEvent.EventStatus getStatus()
+
+
+
+
+
+ +
Returns:
the status of the event - see RundeckEvent.EventStatus
+
+
+
+ +

+setStatus

+
+public void setStatus(RundeckEvent.EventStatus status)
+
+
+
+
+
+
+
+
+
+ +

+getSummary

+
+public String getSummary()
+
+
+
+
+
+
+
+
+
+ +

+setSummary

+
+public void setSummary(String summary)
+
+
+
+
+
+
+
+
+
+ +

+getNodeSummary

+
+public RundeckEvent.NodeSummary getNodeSummary()
+
+
+
+
+
+ +
Returns:
the node summary - see RundeckEvent.NodeSummary
+
+
+
+ +

+setNodeSummary

+
+public void setNodeSummary(RundeckEvent.NodeSummary nodeSummary)
+
+
+
+
+
+
+
+
+
+ +

+getUser

+
+public String getUser()
+
+
+
+
+
+
+
+
+
+ +

+setUser

+
+public void setUser(String user)
+
+
+
+
+
+
+
+
+
+ +

+getProject

+
+public String getProject()
+
+
+
+
+
+
+
+
+
+ +

+setProject

+
+public void setProject(String project)
+
+
+
+
+
+
+
+
+
+ +

+getStartedAt

+
+public Date getStartedAt()
+
+
+
+
+
+
+
+
+
+ +

+setStartedAt

+
+public void setStartedAt(Date startedAt)
+
+
+
+
+
+
+
+
+
+ +

+getEndedAt

+
+public Date getEndedAt()
+
+
+
+
+
+
+
+
+
+ +

+setEndedAt

+
+public void setEndedAt(Date endedAt)
+
+
+
+
+
+
+
+
+
+ +

+getAbortedBy

+
+public String getAbortedBy()
+
+
+
+
+
+
+
+
+
+ +

+setAbortedBy

+
+public void setAbortedBy(String abortedBy)
+
+
+
+
+
+
+
+
+
+ +

+getExecutionId

+
+public Long getExecutionId()
+
+
+
+
+
+ +
Returns:
the ID of the execution associated with this event, or null if there is not
+
+
+
+ +

+setExecutionId

+
+public void setExecutionId(Long executionId)
+
+
+
+
+
+
+
+
+
+ +

+getJobId

+
+public String getJobId()
+
+
+
+
+
+ +
Returns:
the ID of the job associated with this event, or null in the case of an ad-hoc command or script
+
+
+
+ +

+setJobId

+
+public void setJobId(String jobId)
+
+
+
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
+
Overrides:
hashCode in class Object
+
+
+
+
+
+
+ +

+equals

+
+public boolean equals(Object obj)
+
+
+
Overrides:
equals in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html b/apidocs/org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html index c9a92e3..4ae4364 100644 --- a/apidocs/org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html +++ b/apidocs/org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html @@ -2,13 +2,13 @@ - + -RundeckExecution.ExecutionStatus (RunDeck API - Java Client 1.1 API) +RundeckExecution.ExecutionStatus (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ RundeckExecution.ExecutionStatus (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="RundeckExecution.ExecutionStatus (RunDeck API - Java Client 1.1 API)"; + parent.document.title="RundeckExecution.ExecutionStatus (RunDeck API - Java Client 1.2 API)"; } } @@ -57,7 +57,7 @@ function windowTitle()  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO FRAMES   @@ -328,7 +328,7 @@ with the specified name  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO FRAMES   diff --git a/apidocs/org/rundeck/api/domain/RundeckExecution.html b/apidocs/org/rundeck/api/domain/RundeckExecution.html index 7d5b179..177aa68 100644 --- a/apidocs/org/rundeck/api/domain/RundeckExecution.html +++ b/apidocs/org/rundeck/api/domain/RundeckExecution.html @@ -2,13 +2,13 @@ - + -RundeckExecution (RunDeck API - Java Client 1.1 API) +RundeckExecution (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ RundeckExecution (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="RundeckExecution (RunDeck API - Java Client 1.1 API)"; + parent.document.title="RundeckExecution (RunDeck API - Java Client 1.2 API)"; } } @@ -56,7 +56,7 @@ function windowTitle() - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   @@ -788,7 +788,7 @@ public boolean equals( - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   diff --git a/apidocs/org/rundeck/api/domain/RundeckHistory.html b/apidocs/org/rundeck/api/domain/RundeckHistory.html new file mode 100644 index 0000000..4a25050 --- /dev/null +++ b/apidocs/org/rundeck/api/domain/RundeckHistory.html @@ -0,0 +1,553 @@ + + + + + + + +RundeckHistory (RunDeck API - Java Client 1.2 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.rundeck.api.domain +
+Class RundeckHistory

+
+java.lang.Object
+  extended by org.rundeck.api.domain.RundeckHistory
+
+
+
All Implemented Interfaces:
Serializable
+
+
+
+
public class RundeckHistory
extends Object
implements Serializable
+ + +

+Represents a portion of the RunDeck (events) history +

+ +

+

+
Author:
+
Vincent Behar
+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
RundeckHistory() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddEvent(RundeckEvent event) + +
+           
+ booleanequals(Object obj) + +
+           
+ intgetCount() + +
+           
+ List<RundeckEvent>getEvents() + +
+           
+ intgetMax() + +
+           
+ intgetOffset() + +
+           
+ intgetTotal() + +
+           
+ inthashCode() + +
+           
+ voidsetCount(int count) + +
+           
+ voidsetEvents(List<RundeckEvent> events) + +
+           
+ voidsetMax(int max) + +
+           
+ voidsetOffset(int offset) + +
+           
+ voidsetTotal(int total) + +
+           
+ StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+RundeckHistory

+
+public RundeckHistory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+addEvent

+
+public void addEvent(RundeckEvent event)
+
+
+
+
+
+
+
+
+
+ +

+getEvents

+
+public List<RundeckEvent> getEvents()
+
+
+
+
+
+
+
+
+
+ +

+setEvents

+
+public void setEvents(List<RundeckEvent> events)
+
+
+
+
+
+
+
+
+
+ +

+getCount

+
+public int getCount()
+
+
+
+
+
+
+
+
+
+ +

+setCount

+
+public void setCount(int count)
+
+
+
+
+
+
+
+
+
+ +

+getTotal

+
+public int getTotal()
+
+
+
+
+
+
+
+
+
+ +

+setTotal

+
+public void setTotal(int total)
+
+
+
+
+
+
+
+
+
+ +

+getMax

+
+public int getMax()
+
+
+
+
+
+
+
+
+
+ +

+setMax

+
+public void setMax(int max)
+
+
+
+
+
+
+
+
+
+ +

+getOffset

+
+public int getOffset()
+
+
+
+
+
+
+
+
+
+ +

+setOffset

+
+public void setOffset(int offset)
+
+
+
+
+
+
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
+
Overrides:
hashCode in class Object
+
+
+
+
+
+
+ +

+equals

+
+public boolean equals(Object obj)
+
+
+
Overrides:
equals in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/domain/RundeckJob.html b/apidocs/org/rundeck/api/domain/RundeckJob.html index d7f2876..193b3df 100644 --- a/apidocs/org/rundeck/api/domain/RundeckJob.html +++ b/apidocs/org/rundeck/api/domain/RundeckJob.html @@ -2,13 +2,13 @@ - + -RundeckJob (RunDeck API - Java Client 1.1 API) +RundeckJob (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ RundeckJob (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="RundeckJob (RunDeck API - Java Client 1.1 API)"; + parent.document.title="RundeckJob (RunDeck API - Java Client 1.2 API)"; } } @@ -56,7 +56,7 @@ function windowTitle() - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   @@ -519,7 +519,7 @@ public boolean equals( - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   diff --git a/apidocs/org/rundeck/api/domain/RundeckJobsImportMethod.html b/apidocs/org/rundeck/api/domain/RundeckJobsImportMethod.html index 95a520b..b154d9c 100644 --- a/apidocs/org/rundeck/api/domain/RundeckJobsImportMethod.html +++ b/apidocs/org/rundeck/api/domain/RundeckJobsImportMethod.html @@ -2,13 +2,13 @@ - + -RundeckJobsImportMethod (RunDeck API - Java Client 1.1 API) +RundeckJobsImportMethod (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ RundeckJobsImportMethod (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="RundeckJobsImportMethod (RunDeck API - Java Client 1.1 API)"; + parent.document.title="RundeckJobsImportMethod (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/domain/RundeckJobsImportResult.html b/apidocs/org/rundeck/api/domain/RundeckJobsImportResult.html index 4adb9e2..9f30fd0 100644 --- a/apidocs/org/rundeck/api/domain/RundeckJobsImportResult.html +++ b/apidocs/org/rundeck/api/domain/RundeckJobsImportResult.html @@ -2,13 +2,13 @@ - + -RundeckJobsImportResult (RunDeck API - Java Client 1.1 API) +RundeckJobsImportResult (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ RundeckJobsImportResult (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="RundeckJobsImportResult (RunDeck API - Java Client 1.1 API)"; + parent.document.title="RundeckJobsImportResult (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/domain/RundeckNode.html b/apidocs/org/rundeck/api/domain/RundeckNode.html index 72c0d9b..fe41d4e 100644 --- a/apidocs/org/rundeck/api/domain/RundeckNode.html +++ b/apidocs/org/rundeck/api/domain/RundeckNode.html @@ -2,13 +2,13 @@ - + -RundeckNode (RunDeck API - Java Client 1.1 API) +RundeckNode (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ RundeckNode (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="RundeckNode (RunDeck API - Java Client 1.1 API)"; + parent.document.title="RundeckNode (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/domain/RundeckProject.html b/apidocs/org/rundeck/api/domain/RundeckProject.html index 3465fa0..1b7b5a3 100644 --- a/apidocs/org/rundeck/api/domain/RundeckProject.html +++ b/apidocs/org/rundeck/api/domain/RundeckProject.html @@ -2,13 +2,13 @@ - + -RundeckProject (RunDeck API - Java Client 1.1 API) +RundeckProject (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ RundeckProject (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="RundeckProject (RunDeck API - Java Client 1.1 API)"; + parent.document.title="RundeckProject (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/domain/RundeckSystemInfo.html b/apidocs/org/rundeck/api/domain/RundeckSystemInfo.html index c0c2aeb..a72d52d 100644 --- a/apidocs/org/rundeck/api/domain/RundeckSystemInfo.html +++ b/apidocs/org/rundeck/api/domain/RundeckSystemInfo.html @@ -2,13 +2,13 @@ - + -RundeckSystemInfo (RunDeck API - Java Client 1.1 API) +RundeckSystemInfo (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ RundeckSystemInfo (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="RundeckSystemInfo (RunDeck API - Java Client 1.1 API)"; + parent.document.title="RundeckSystemInfo (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/domain/class-use/RundeckAbort.AbortStatus.html b/apidocs/org/rundeck/api/domain/class-use/RundeckAbort.AbortStatus.html index 7eee844..f37d6b7 100644 --- a/apidocs/org/rundeck/api/domain/class-use/RundeckAbort.AbortStatus.html +++ b/apidocs/org/rundeck/api/domain/class-use/RundeckAbort.AbortStatus.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.domain.RundeckAbort.AbortStatus (RunDeck API - Java Client 1.1 API) +Uses of Class org.rundeck.api.domain.RundeckAbort.AbortStatus (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.domain.RundeckAbort.AbortStatus (RunDeck API - Jav function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.domain.RundeckAbort.AbortStatus (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Class org.rundeck.api.domain.RundeckAbort.AbortStatus (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/domain/class-use/RundeckAbort.html b/apidocs/org/rundeck/api/domain/class-use/RundeckAbort.html index 06414a0..fc098f2 100644 --- a/apidocs/org/rundeck/api/domain/class-use/RundeckAbort.html +++ b/apidocs/org/rundeck/api/domain/class-use/RundeckAbort.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.domain.RundeckAbort (RunDeck API - Java Client 1.1 API) +Uses of Class org.rundeck.api.domain.RundeckAbort (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.domain.RundeckAbort (RunDeck API - Java Client 1.1 function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.domain.RundeckAbort (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Class org.rundeck.api.domain.RundeckAbort (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/domain/class-use/RundeckEvent.EventStatus.html b/apidocs/org/rundeck/api/domain/class-use/RundeckEvent.EventStatus.html new file mode 100644 index 0000000..a446dc5 --- /dev/null +++ b/apidocs/org/rundeck/api/domain/class-use/RundeckEvent.EventStatus.html @@ -0,0 +1,214 @@ + + + + + + + +Uses of Class org.rundeck.api.domain.RundeckEvent.EventStatus (RunDeck API - Java Client 1.2 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
org.rundeck.api.domain.RundeckEvent.EventStatus

+
+ + + + + + + + + +
+Packages that use RundeckEvent.EventStatus
org.rundeck.api.domainDomain classes that are returned to the client of the API. 
+  +

+ + + + + +
+Uses of RundeckEvent.EventStatus in org.rundeck.api.domain
+  +

+ + + + + + + + + + + + + + + + + +
Methods in org.rundeck.api.domain that return RundeckEvent.EventStatus
+ RundeckEvent.EventStatusRundeckEvent.getStatus() + +
+           
+static RundeckEvent.EventStatusRundeckEvent.EventStatus.valueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static RundeckEvent.EventStatus[]RundeckEvent.EventStatus.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+ + + + + + + + + +
Methods in org.rundeck.api.domain with parameters of type RundeckEvent.EventStatus
+ voidRundeckEvent.setStatus(RundeckEvent.EventStatus status) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/domain/class-use/RundeckEvent.NodeSummary.html b/apidocs/org/rundeck/api/domain/class-use/RundeckEvent.NodeSummary.html new file mode 100644 index 0000000..cb96bd7 --- /dev/null +++ b/apidocs/org/rundeck/api/domain/class-use/RundeckEvent.NodeSummary.html @@ -0,0 +1,197 @@ + + + + + + + +Uses of Class org.rundeck.api.domain.RundeckEvent.NodeSummary (RunDeck API - Java Client 1.2 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
org.rundeck.api.domain.RundeckEvent.NodeSummary

+
+ + + + + + + + + +
+Packages that use RundeckEvent.NodeSummary
org.rundeck.api.domainDomain classes that are returned to the client of the API. 
+  +

+ + + + + +
+Uses of RundeckEvent.NodeSummary in org.rundeck.api.domain
+  +

+ + + + + + + + + +
Methods in org.rundeck.api.domain that return RundeckEvent.NodeSummary
+ RundeckEvent.NodeSummaryRundeckEvent.getNodeSummary() + +
+           
+  +

+ + + + + + + + + +
Methods in org.rundeck.api.domain with parameters of type RundeckEvent.NodeSummary
+ voidRundeckEvent.setNodeSummary(RundeckEvent.NodeSummary nodeSummary) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/domain/class-use/RundeckEvent.html b/apidocs/org/rundeck/api/domain/class-use/RundeckEvent.html new file mode 100644 index 0000000..77a5863 --- /dev/null +++ b/apidocs/org/rundeck/api/domain/class-use/RundeckEvent.html @@ -0,0 +1,242 @@ + + + + + + + +Uses of Class org.rundeck.api.domain.RundeckEvent (RunDeck API - Java Client 1.2 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
org.rundeck.api.domain.RundeckEvent

+
+ + + + + + + + + + + + + +
+Packages that use RundeckEvent
org.rundeck.api.domainDomain classes that are returned to the client of the API. 
org.rundeck.api.parserInternal parsers for parsing the RunDeck responses. 
+  +

+ + + + + +
+Uses of RundeckEvent in org.rundeck.api.domain
+  +

+ + + + + + + + + +
Methods in org.rundeck.api.domain that return types with arguments of type RundeckEvent
+ List<RundeckEvent>RundeckHistory.getEvents() + +
+           
+  +

+ + + + + + + + + +
Methods in org.rundeck.api.domain with parameters of type RundeckEvent
+ voidRundeckHistory.addEvent(RundeckEvent event) + +
+           
+  +

+ + + + + + + + + +
Method parameters in org.rundeck.api.domain with type arguments of type RundeckEvent
+ voidRundeckHistory.setEvents(List<RundeckEvent> events) + +
+           
+  +

+ + + + + +
+Uses of RundeckEvent in org.rundeck.api.parser
+  +

+ + + + + + + + + +
Methods in org.rundeck.api.parser that return RundeckEvent
+ RundeckEventEventParser.parseXmlNode(org.dom4j.Node node) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/domain/class-use/RundeckExecution.ExecutionStatus.html b/apidocs/org/rundeck/api/domain/class-use/RundeckExecution.ExecutionStatus.html index 51cb13b..9820e2e 100644 --- a/apidocs/org/rundeck/api/domain/class-use/RundeckExecution.ExecutionStatus.html +++ b/apidocs/org/rundeck/api/domain/class-use/RundeckExecution.ExecutionStatus.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.domain.RundeckExecution.ExecutionStatus (RunDeck API - Java Client 1.1 API) +Uses of Class org.rundeck.api.domain.RundeckExecution.ExecutionStatus (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.domain.RundeckExecution.ExecutionStatus (RunDeck A function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.domain.RundeckExecution.ExecutionStatus (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Class org.rundeck.api.domain.RundeckExecution.ExecutionStatus (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/domain/class-use/RundeckExecution.html b/apidocs/org/rundeck/api/domain/class-use/RundeckExecution.html index e155683..0c4001e 100644 --- a/apidocs/org/rundeck/api/domain/class-use/RundeckExecution.html +++ b/apidocs/org/rundeck/api/domain/class-use/RundeckExecution.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.domain.RundeckExecution (RunDeck API - Java Client 1.1 API) +Uses of Class org.rundeck.api.domain.RundeckExecution (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.domain.RundeckExecution (RunDeck API - Java Client function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.domain.RundeckExecution (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Class org.rundeck.api.domain.RundeckExecution (RunDeck API - Java Client 1.2 API)"; } } @@ -198,6 +198,194 @@ Uses of  RundeckExecution +RundeckClient.runAdhocScript(String project, + InputStream script) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +RundeckClient.runAdhocScript(String project, + InputStream script, + long poolingInterval, + TimeUnit poolingUnit) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +RundeckClient.runAdhocScript(String project, + InputStream script, + Properties options) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +RundeckClient.runAdhocScript(String project, + InputStream script, + Properties options, + long poolingInterval, + TimeUnit poolingUnit) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +RundeckClient.runAdhocScript(String project, + InputStream script, + Properties options, + Properties nodeFilters) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +RundeckClient.runAdhocScript(String project, + InputStream script, + Properties options, + Properties nodeFilters, + Integer nodeThreadcount, + Boolean nodeKeepgoing) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +RundeckClient.runAdhocScript(String project, + InputStream script, + Properties options, + Properties nodeFilters, + Integer nodeThreadcount, + Boolean nodeKeepgoing, + long poolingInterval, + TimeUnit poolingUnit) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +RundeckClient.runAdhocScript(String project, + InputStream script, + Properties options, + Properties nodeFilters, + long poolingInterval, + TimeUnit poolingUnit) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +RundeckClient.runAdhocScript(String project, + String scriptFilename) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +RundeckClient.runAdhocScript(String project, + String scriptFilename, + long poolingInterval, + TimeUnit poolingUnit) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +RundeckClient.runAdhocScript(String project, + String scriptFilename, + Properties options) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +RundeckClient.runAdhocScript(String project, + String scriptFilename, + Properties options, + long poolingInterval, + TimeUnit poolingUnit) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +RundeckClient.runAdhocScript(String project, + String scriptFilename, + Properties options, + Properties nodeFilters) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +RundeckClient.runAdhocScript(String project, + String scriptFilename, + Properties options, + Properties nodeFilters, + Integer nodeThreadcount, + Boolean nodeKeepgoing) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +RundeckClient.runAdhocScript(String project, + String scriptFilename, + Properties options, + Properties nodeFilters, + Integer nodeThreadcount, + Boolean nodeKeepgoing, + long poolingInterval, + TimeUnit poolingUnit) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution +RundeckClient.runAdhocScript(String project, + String scriptFilename, + Properties options, + Properties nodeFilters, + long poolingInterval, + TimeUnit poolingUnit) + +
+          Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. + + + + RundeckExecution RundeckClient.runJob(String jobId)
@@ -279,6 +467,92 @@ Uses of  RundeckExecution +RundeckClient.triggerAdhocScript(String project, + InputStream script) + +
+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). + + + + RundeckExecution +RundeckClient.triggerAdhocScript(String project, + InputStream script, + Properties options) + +
+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). + + + + RundeckExecution +RundeckClient.triggerAdhocScript(String project, + InputStream script, + Properties options, + Properties nodeFilters) + +
+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). + + + + RundeckExecution +RundeckClient.triggerAdhocScript(String project, + InputStream script, + Properties options, + Properties nodeFilters, + Integer nodeThreadcount, + Boolean nodeKeepgoing) + +
+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). + + + + RundeckExecution +RundeckClient.triggerAdhocScript(String project, + String scriptFilename) + +
+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). + + + + RundeckExecution +RundeckClient.triggerAdhocScript(String project, + String scriptFilename, + Properties options) + +
+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). + + + + RundeckExecution +RundeckClient.triggerAdhocScript(String project, + String scriptFilename, + Properties options, + Properties nodeFilters) + +
+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). + + + + RundeckExecution +RundeckClient.triggerAdhocScript(String project, + String scriptFilename, + Properties options, + Properties nodeFilters, + Integer nodeThreadcount, + Boolean nodeKeepgoing) + +
+          Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). + + + + RundeckExecution RundeckClient.triggerJob(String jobId)
diff --git a/apidocs/org/rundeck/api/domain/class-use/RundeckHistory.html b/apidocs/org/rundeck/api/domain/class-use/RundeckHistory.html new file mode 100644 index 0000000..f9f37dc --- /dev/null +++ b/apidocs/org/rundeck/api/domain/class-use/RundeckHistory.html @@ -0,0 +1,302 @@ + + + + + + + +Uses of Class org.rundeck.api.domain.RundeckHistory (RunDeck API - Java Client 1.2 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
org.rundeck.api.domain.RundeckHistory

+
+ + + + + + + + + + + + + +
+Packages that use RundeckHistory
org.rundeck.apiJava client for the RunDeck API. 
org.rundeck.api.parserInternal parsers for parsing the RunDeck responses. 
+  +

+ + + + + +
+Uses of RundeckHistory in org.rundeck.api
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in org.rundeck.api that return RundeckHistory
+ RundeckHistoryRundeckClient.getHistory(String project) + +
+          Get the (events) history for the given project
+ RundeckHistoryRundeckClient.getHistory(String project, + Date begin, + Date end) + +
+          Get the (events) history for the given project
+ RundeckHistoryRundeckClient.getHistory(String project, + Date begin, + Date end, + Long max, + Long offset) + +
+          Get the (events) history for the given project
+ RundeckHistoryRundeckClient.getHistory(String project, + Long max, + Long offset) + +
+          Get the (events) history for the given project
+ RundeckHistoryRundeckClient.getHistory(String project, + String recent) + +
+          Get the (events) history for the given project
+ RundeckHistoryRundeckClient.getHistory(String project, + String recent, + Long max, + Long offset) + +
+          Get the (events) history for the given project
+ RundeckHistoryRundeckClient.getHistory(String project, + String jobId, + String reportId, + String user) + +
+          Get the (events) history for the given project
+ RundeckHistoryRundeckClient.getHistory(String project, + String jobId, + String reportId, + String user, + Long max, + Long offset) + +
+          Get the (events) history for the given project
+ RundeckHistoryRundeckClient.getHistory(String project, + String jobId, + String reportId, + String user, + String recent, + Date begin, + Date end, + Long max, + Long offset) + +
+          Get the (events) history for the given project
+  +

+ + + + + +
+Uses of RundeckHistory in org.rundeck.api.parser
+  +

+ + + + + + + + + +
Methods in org.rundeck.api.parser that return RundeckHistory
+ RundeckHistoryHistoryParser.parseXmlNode(org.dom4j.Node node) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/domain/class-use/RundeckJob.html b/apidocs/org/rundeck/api/domain/class-use/RundeckJob.html index 6abba07..eff08fe 100644 --- a/apidocs/org/rundeck/api/domain/class-use/RundeckJob.html +++ b/apidocs/org/rundeck/api/domain/class-use/RundeckJob.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.domain.RundeckJob (RunDeck API - Java Client 1.1 API) +Uses of Class org.rundeck.api.domain.RundeckJob (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.domain.RundeckJob (RunDeck API - Java Client 1.1 A function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.domain.RundeckJob (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Class org.rundeck.api.domain.RundeckJob (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/domain/class-use/RundeckJobsImportMethod.html b/apidocs/org/rundeck/api/domain/class-use/RundeckJobsImportMethod.html index 6ab46fe..05d6cac 100644 --- a/apidocs/org/rundeck/api/domain/class-use/RundeckJobsImportMethod.html +++ b/apidocs/org/rundeck/api/domain/class-use/RundeckJobsImportMethod.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.domain.RundeckJobsImportMethod (RunDeck API - Java Client 1.1 API) +Uses of Class org.rundeck.api.domain.RundeckJobsImportMethod (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.domain.RundeckJobsImportMethod (RunDeck API - Java function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.domain.RundeckJobsImportMethod (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Class org.rundeck.api.domain.RundeckJobsImportMethod (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/domain/class-use/RundeckJobsImportResult.html b/apidocs/org/rundeck/api/domain/class-use/RundeckJobsImportResult.html index 97e326e..70e8f3d 100644 --- a/apidocs/org/rundeck/api/domain/class-use/RundeckJobsImportResult.html +++ b/apidocs/org/rundeck/api/domain/class-use/RundeckJobsImportResult.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.domain.RundeckJobsImportResult (RunDeck API - Java Client 1.1 API) +Uses of Class org.rundeck.api.domain.RundeckJobsImportResult (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.domain.RundeckJobsImportResult (RunDeck API - Java function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.domain.RundeckJobsImportResult (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Class org.rundeck.api.domain.RundeckJobsImportResult (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/domain/class-use/RundeckNode.html b/apidocs/org/rundeck/api/domain/class-use/RundeckNode.html index 2400c68..75adcfe 100644 --- a/apidocs/org/rundeck/api/domain/class-use/RundeckNode.html +++ b/apidocs/org/rundeck/api/domain/class-use/RundeckNode.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.domain.RundeckNode (RunDeck API - Java Client 1.1 API) +Uses of Class org.rundeck.api.domain.RundeckNode (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.domain.RundeckNode (RunDeck API - Java Client 1.1 function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.domain.RundeckNode (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Class org.rundeck.api.domain.RundeckNode (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/domain/class-use/RundeckProject.html b/apidocs/org/rundeck/api/domain/class-use/RundeckProject.html index 02fbaec..10cb6c1 100644 --- a/apidocs/org/rundeck/api/domain/class-use/RundeckProject.html +++ b/apidocs/org/rundeck/api/domain/class-use/RundeckProject.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.domain.RundeckProject (RunDeck API - Java Client 1.1 API) +Uses of Class org.rundeck.api.domain.RundeckProject (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.domain.RundeckProject (RunDeck API - Java Client 1 function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.domain.RundeckProject (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Class org.rundeck.api.domain.RundeckProject (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/domain/class-use/RundeckSystemInfo.html b/apidocs/org/rundeck/api/domain/class-use/RundeckSystemInfo.html index f623b79..8b843b8 100644 --- a/apidocs/org/rundeck/api/domain/class-use/RundeckSystemInfo.html +++ b/apidocs/org/rundeck/api/domain/class-use/RundeckSystemInfo.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.domain.RundeckSystemInfo (RunDeck API - Java Client 1.1 API) +Uses of Class org.rundeck.api.domain.RundeckSystemInfo (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.domain.RundeckSystemInfo (RunDeck API - Java Clien function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.domain.RundeckSystemInfo (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Class org.rundeck.api.domain.RundeckSystemInfo (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/domain/package-frame.html b/apidocs/org/rundeck/api/domain/package-frame.html index 61b5963..3670f1e 100644 --- a/apidocs/org/rundeck/api/domain/package-frame.html +++ b/apidocs/org/rundeck/api/domain/package-frame.html @@ -2,13 +2,13 @@ - + -org.rundeck.api.domain (RunDeck API - Java Client 1.1 API) +org.rundeck.api.domain (RunDeck API - Java Client 1.2 API) - + @@ -26,8 +26,14 @@ Classes 
RundeckAbort
+RundeckEvent +
+RundeckEvent.NodeSummary +
RundeckExecution
+RundeckHistory +
RundeckJob
RundeckJobsImportResult @@ -49,6 +55,8 @@ Enums 
RundeckAbort.AbortStatus
+RundeckEvent.EventStatus +
RundeckExecution.ExecutionStatus
RundeckJobsImportMethod diff --git a/apidocs/org/rundeck/api/domain/package-summary.html b/apidocs/org/rundeck/api/domain/package-summary.html index d2c2241..d01427c 100644 --- a/apidocs/org/rundeck/api/domain/package-summary.html +++ b/apidocs/org/rundeck/api/domain/package-summary.html @@ -2,13 +2,13 @@ - + -org.rundeck.api.domain (RunDeck API - Java Client 1.1 API) +org.rundeck.api.domain (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ org.rundeck.api.domain (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.rundeck.api.domain (RunDeck API - Java Client 1.1 API)"; + parent.document.title="org.rundeck.api.domain (RunDeck API - Java Client 1.2 API)"; } } @@ -100,10 +100,22 @@ Domain classes that are returned to the client of the API. Represents an abort of a RundeckExecution +RundeckEvent +Represents a RunDeck event + + +RundeckEvent.NodeSummary +Summary for nodes + + RundeckExecution Represents a RunDeck execution, usually triggered by an API call. +RundeckHistory +Represents a portion of the RunDeck (events) history + + RundeckJob Represents a RunDeck job @@ -138,6 +150,10 @@ Domain classes that are returned to the client of the API. The status of an abort +RundeckEvent.EventStatus +The status of an event + + RundeckExecution.ExecutionStatus The status of an execution diff --git a/apidocs/org/rundeck/api/domain/package-tree.html b/apidocs/org/rundeck/api/domain/package-tree.html index 3a3ba01..6d7d421 100644 --- a/apidocs/org/rundeck/api/domain/package-tree.html +++ b/apidocs/org/rundeck/api/domain/package-tree.html @@ -2,13 +2,13 @@ - + -org.rundeck.api.domain Class Hierarchy (RunDeck API - Java Client 1.1 API) +org.rundeck.api.domain Class Hierarchy (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ org.rundeck.api.domain Class Hierarchy (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.rundeck.api.domain Class Hierarchy (RunDeck API - Java Client 1.1 API)"; + parent.document.title="org.rundeck.api.domain Class Hierarchy (RunDeck API - Java Client 1.2 API)"; } } @@ -94,7 +94,10 @@ Class Hierarchy
diff --git a/apidocs/org/rundeck/api/domain/package-use.html b/apidocs/org/rundeck/api/domain/package-use.html index 77cfcb1..fad19d2 100644 --- a/apidocs/org/rundeck/api/domain/package-use.html +++ b/apidocs/org/rundeck/api/domain/package-use.html @@ -2,13 +2,13 @@ - + -Uses of Package org.rundeck.api.domain (RunDeck API - Java Client 1.1 API) +Uses of Package org.rundeck.api.domain (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Package org.rundeck.api.domain (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Package org.rundeck.api.domain (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Package org.rundeck.api.domain (RunDeck API - Java Client 1.2 API)"; } } @@ -130,6 +130,12 @@ Classes in org           The status of an execution +RundeckHistory + +
+          Represents a portion of the RunDeck (events) history + + RundeckJob
@@ -181,6 +187,24 @@ Classes in org           The status of an abort +RundeckEvent + +
+          Represents a RunDeck event + + +RundeckEvent.EventStatus + +
+          The status of an event + + +RundeckEvent.NodeSummary + +
+          Summary for nodes + + RundeckExecution
@@ -220,12 +244,24 @@ Classes in org           Represents an abort of a RundeckExecution +RundeckEvent + +
+          Represents a RunDeck event + + RundeckExecution
          Represents a RunDeck execution, usually triggered by an API call. +RundeckHistory + +
+          Represents a portion of the RunDeck (events) history + + RundeckJob
diff --git a/apidocs/org/rundeck/api/package-frame.html b/apidocs/org/rundeck/api/package-frame.html index ed85774..60855c0 100644 --- a/apidocs/org/rundeck/api/package-frame.html +++ b/apidocs/org/rundeck/api/package-frame.html @@ -2,13 +2,13 @@ - + -org.rundeck.api (RunDeck API - Java Client 1.1 API) +org.rundeck.api (RunDeck API - Java Client 1.2 API) - + diff --git a/apidocs/org/rundeck/api/package-summary.html b/apidocs/org/rundeck/api/package-summary.html index 96d93d5..d825562 100644 --- a/apidocs/org/rundeck/api/package-summary.html +++ b/apidocs/org/rundeck/api/package-summary.html @@ -2,13 +2,13 @@ - + -org.rundeck.api (RunDeck API - Java Client 1.1 API) +org.rundeck.api (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ org.rundeck.api (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.rundeck.api (RunDeck API - Java Client 1.1 API)"; + parent.document.title="org.rundeck.api (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/package-tree.html b/apidocs/org/rundeck/api/package-tree.html index d862a92..86e30c8 100644 --- a/apidocs/org/rundeck/api/package-tree.html +++ b/apidocs/org/rundeck/api/package-tree.html @@ -2,13 +2,13 @@ - + -org.rundeck.api Class Hierarchy (RunDeck API - Java Client 1.1 API) +org.rundeck.api Class Hierarchy (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ org.rundeck.api Class Hierarchy (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.rundeck.api Class Hierarchy (RunDeck API - Java Client 1.1 API)"; + parent.document.title="org.rundeck.api Class Hierarchy (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/package-use.html b/apidocs/org/rundeck/api/package-use.html index a2ae148..48f5383 100644 --- a/apidocs/org/rundeck/api/package-use.html +++ b/apidocs/org/rundeck/api/package-use.html @@ -2,13 +2,13 @@ - + -Uses of Package org.rundeck.api (RunDeck API - Java Client 1.1 API) +Uses of Package org.rundeck.api (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Package org.rundeck.api (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Package org.rundeck.api (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Package org.rundeck.api (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/parser/AbortParser.html b/apidocs/org/rundeck/api/parser/AbortParser.html index cd440ea..09db66a 100644 --- a/apidocs/org/rundeck/api/parser/AbortParser.html +++ b/apidocs/org/rundeck/api/parser/AbortParser.html @@ -2,13 +2,13 @@ - + -AbortParser (RunDeck API - Java Client 1.1 API) +AbortParser (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ AbortParser (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="AbortParser (RunDeck API - Java Client 1.1 API)"; + parent.document.title="AbortParser (RunDeck API - Java Client 1.2 API)"; } } @@ -57,7 +57,7 @@ function windowTitle()  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO FRAMES   @@ -253,7 +253,7 @@ public  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO FRAMES   diff --git a/apidocs/org/rundeck/api/parser/EventParser.html b/apidocs/org/rundeck/api/parser/EventParser.html new file mode 100644 index 0000000..9567c0b --- /dev/null +++ b/apidocs/org/rundeck/api/parser/EventParser.html @@ -0,0 +1,287 @@ + + + + + + + +EventParser (RunDeck API - Java Client 1.2 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.rundeck.api.parser +
+Class EventParser

+
+java.lang.Object
+  extended by org.rundeck.api.parser.EventParser
+
+
+
All Implemented Interfaces:
XmlNodeParser<RundeckEvent>
+
+
+
+
public class EventParser
extends Object
implements XmlNodeParser<RundeckEvent>
+ + +

+Parser for a single RundeckEvent +

+ +

+

+
Author:
+
Vincent Behar
+
+
+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
EventParser() + +
+           
EventParser(String xpath) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ RundeckEventparseXmlNode(org.dom4j.Node node) + +
+          Parse the given XML Node
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+EventParser

+
+public EventParser()
+
+
+
+ +

+EventParser

+
+public EventParser(String xpath)
+
+
+
Parameters:
xpath - of the event element if it is not the root node
+
+ + + + + + + + +
+Method Detail
+ +

+parseXmlNode

+
+public RundeckEvent parseXmlNode(org.dom4j.Node node)
+
+
Description copied from interface: XmlNodeParser
+
Parse the given XML Node +

+

+
Specified by:
parseXmlNode in interface XmlNodeParser<RundeckEvent>
+
+
+ +
Returns:
any object holding the converted value
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/parser/ExecutionParser.html b/apidocs/org/rundeck/api/parser/ExecutionParser.html index e5f8549..e265558 100644 --- a/apidocs/org/rundeck/api/parser/ExecutionParser.html +++ b/apidocs/org/rundeck/api/parser/ExecutionParser.html @@ -2,13 +2,13 @@ - + -ExecutionParser (RunDeck API - Java Client 1.1 API) +ExecutionParser (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ ExecutionParser (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="ExecutionParser (RunDeck API - Java Client 1.1 API)"; + parent.document.title="ExecutionParser (RunDeck API - Java Client 1.2 API)"; } } @@ -56,8 +56,8 @@ function windowTitle() - PREV CLASS  - NEXT CLASS + PREV CLASS  + NEXT CLASS FRAMES    NO FRAMES   @@ -252,8 +252,8 @@ public - PREV CLASS  - NEXT CLASS + PREV CLASS  + NEXT CLASS FRAMES    NO FRAMES   diff --git a/apidocs/org/rundeck/api/parser/HistoryParser.html b/apidocs/org/rundeck/api/parser/HistoryParser.html new file mode 100644 index 0000000..efed943 --- /dev/null +++ b/apidocs/org/rundeck/api/parser/HistoryParser.html @@ -0,0 +1,287 @@ + + + + + + + +HistoryParser (RunDeck API - Java Client 1.2 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.rundeck.api.parser +
+Class HistoryParser

+
+java.lang.Object
+  extended by org.rundeck.api.parser.HistoryParser
+
+
+
All Implemented Interfaces:
XmlNodeParser<RundeckHistory>
+
+
+
+
public class HistoryParser
extends Object
implements XmlNodeParser<RundeckHistory>
+ + +

+Parser for a single RundeckHistory +

+ +

+

+
Author:
+
Vincent Behar
+
+
+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
HistoryParser() + +
+           
HistoryParser(String xpath) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ RundeckHistoryparseXmlNode(org.dom4j.Node node) + +
+          Parse the given XML Node
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+HistoryParser

+
+public HistoryParser()
+
+
+
+ +

+HistoryParser

+
+public HistoryParser(String xpath)
+
+
+
Parameters:
xpath - of the history element if it is not the root node
+
+ + + + + + + + +
+Method Detail
+ +

+parseXmlNode

+
+public RundeckHistory parseXmlNode(org.dom4j.Node node)
+
+
Description copied from interface: XmlNodeParser
+
Parse the given XML Node +

+

+
Specified by:
parseXmlNode in interface XmlNodeParser<RundeckHistory>
+
+
+ +
Returns:
any object holding the converted value
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/parser/JobParser.html b/apidocs/org/rundeck/api/parser/JobParser.html index 473ed13..2bb9af1 100644 --- a/apidocs/org/rundeck/api/parser/JobParser.html +++ b/apidocs/org/rundeck/api/parser/JobParser.html @@ -2,13 +2,13 @@ - + -JobParser (RunDeck API - Java Client 1.1 API) +JobParser (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ JobParser (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="JobParser (RunDeck API - Java Client 1.1 API)"; + parent.document.title="JobParser (RunDeck API - Java Client 1.2 API)"; } } @@ -56,7 +56,7 @@ function windowTitle() - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   @@ -252,7 +252,7 @@ public - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   diff --git a/apidocs/org/rundeck/api/parser/JobsImportResultParser.html b/apidocs/org/rundeck/api/parser/JobsImportResultParser.html index f606005..1aea9e5 100644 --- a/apidocs/org/rundeck/api/parser/JobsImportResultParser.html +++ b/apidocs/org/rundeck/api/parser/JobsImportResultParser.html @@ -2,13 +2,13 @@ - + -JobsImportResultParser (RunDeck API - Java Client 1.1 API) +JobsImportResultParser (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ JobsImportResultParser (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="JobsImportResultParser (RunDeck API - Java Client 1.1 API)"; + parent.document.title="JobsImportResultParser (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/parser/ListParser.html b/apidocs/org/rundeck/api/parser/ListParser.html index 5a76aa8..4dcdbed 100644 --- a/apidocs/org/rundeck/api/parser/ListParser.html +++ b/apidocs/org/rundeck/api/parser/ListParser.html @@ -2,13 +2,13 @@ - + -ListParser (RunDeck API - Java Client 1.1 API) +ListParser (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ ListParser (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="ListParser (RunDeck API - Java Client 1.1 API)"; + parent.document.title="ListParser (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/parser/NodeParser.html b/apidocs/org/rundeck/api/parser/NodeParser.html index 6fe2d9d..28d1b18 100644 --- a/apidocs/org/rundeck/api/parser/NodeParser.html +++ b/apidocs/org/rundeck/api/parser/NodeParser.html @@ -2,13 +2,13 @@ - + -NodeParser (RunDeck API - Java Client 1.1 API) +NodeParser (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ NodeParser (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="NodeParser (RunDeck API - Java Client 1.1 API)"; + parent.document.title="NodeParser (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/parser/ParserHelper.html b/apidocs/org/rundeck/api/parser/ParserHelper.html index 5abcd92..c6a4b96 100644 --- a/apidocs/org/rundeck/api/parser/ParserHelper.html +++ b/apidocs/org/rundeck/api/parser/ParserHelper.html @@ -2,13 +2,13 @@ - + -ParserHelper (RunDeck API - Java Client 1.1 API) +ParserHelper (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ ParserHelper (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="ParserHelper (RunDeck API - Java Client 1.1 API)"; + parent.document.title="ParserHelper (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/parser/ProjectParser.html b/apidocs/org/rundeck/api/parser/ProjectParser.html index 3a2bcb1..d89ab05 100644 --- a/apidocs/org/rundeck/api/parser/ProjectParser.html +++ b/apidocs/org/rundeck/api/parser/ProjectParser.html @@ -2,13 +2,13 @@ - + -ProjectParser (RunDeck API - Java Client 1.1 API) +ProjectParser (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ ProjectParser (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="ProjectParser (RunDeck API - Java Client 1.1 API)"; + parent.document.title="ProjectParser (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/parser/StringParser.html b/apidocs/org/rundeck/api/parser/StringParser.html index ed6f732..d563e70 100644 --- a/apidocs/org/rundeck/api/parser/StringParser.html +++ b/apidocs/org/rundeck/api/parser/StringParser.html @@ -2,13 +2,13 @@ - + -StringParser (RunDeck API - Java Client 1.1 API) +StringParser (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ StringParser (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="StringParser (RunDeck API - Java Client 1.1 API)"; + parent.document.title="StringParser (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/parser/SystemInfoParser.html b/apidocs/org/rundeck/api/parser/SystemInfoParser.html index 98c79a8..b7c8b78 100644 --- a/apidocs/org/rundeck/api/parser/SystemInfoParser.html +++ b/apidocs/org/rundeck/api/parser/SystemInfoParser.html @@ -2,13 +2,13 @@ - + -SystemInfoParser (RunDeck API - Java Client 1.1 API) +SystemInfoParser (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ SystemInfoParser (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SystemInfoParser (RunDeck API - Java Client 1.1 API)"; + parent.document.title="SystemInfoParser (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/parser/XmlNodeParser.html b/apidocs/org/rundeck/api/parser/XmlNodeParser.html index 8a6c3ae..9d2693a 100644 --- a/apidocs/org/rundeck/api/parser/XmlNodeParser.html +++ b/apidocs/org/rundeck/api/parser/XmlNodeParser.html @@ -2,13 +2,13 @@ - + -XmlNodeParser (RunDeck API - Java Client 1.1 API) +XmlNodeParser (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ XmlNodeParser (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="XmlNodeParser (RunDeck API - Java Client 1.1 API)"; + parent.document.title="XmlNodeParser (RunDeck API - Java Client 1.2 API)"; } } @@ -93,7 +93,7 @@ org.rundeck.api.parser
Interface XmlNodeParser<T>
-
All Known Implementing Classes:
AbortParser, ExecutionParser, JobParser, JobsImportResultParser, ListParser, NodeParser, ProjectParser, StringParser, SystemInfoParser
+
All Known Implementing Classes:
AbortParser, EventParser, ExecutionParser, HistoryParser, JobParser, JobsImportResultParser, ListParser, NodeParser, ProjectParser, StringParser, SystemInfoParser
diff --git a/apidocs/org/rundeck/api/parser/class-use/AbortParser.html b/apidocs/org/rundeck/api/parser/class-use/AbortParser.html index 0224fb1..7f55b97 100644 --- a/apidocs/org/rundeck/api/parser/class-use/AbortParser.html +++ b/apidocs/org/rundeck/api/parser/class-use/AbortParser.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.parser.AbortParser (RunDeck API - Java Client 1.1 API) +Uses of Class org.rundeck.api.parser.AbortParser (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.parser.AbortParser (RunDeck API - Java Client 1.1 function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.parser.AbortParser (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Class org.rundeck.api.parser.AbortParser (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/parser/class-use/EventParser.html b/apidocs/org/rundeck/api/parser/class-use/EventParser.html new file mode 100644 index 0000000..7b01d29 --- /dev/null +++ b/apidocs/org/rundeck/api/parser/class-use/EventParser.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.rundeck.api.parser.EventParser (RunDeck API - Java Client 1.2 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
org.rundeck.api.parser.EventParser

+
+No usage of org.rundeck.api.parser.EventParser +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/parser/class-use/ExecutionParser.html b/apidocs/org/rundeck/api/parser/class-use/ExecutionParser.html index 3dcf8ee..05366ab 100644 --- a/apidocs/org/rundeck/api/parser/class-use/ExecutionParser.html +++ b/apidocs/org/rundeck/api/parser/class-use/ExecutionParser.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.parser.ExecutionParser (RunDeck API - Java Client 1.1 API) +Uses of Class org.rundeck.api.parser.ExecutionParser (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.parser.ExecutionParser (RunDeck API - Java Client function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.parser.ExecutionParser (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Class org.rundeck.api.parser.ExecutionParser (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/parser/class-use/HistoryParser.html b/apidocs/org/rundeck/api/parser/class-use/HistoryParser.html new file mode 100644 index 0000000..64da812 --- /dev/null +++ b/apidocs/org/rundeck/api/parser/class-use/HistoryParser.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.rundeck.api.parser.HistoryParser (RunDeck API - Java Client 1.2 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
org.rundeck.api.parser.HistoryParser

+
+No usage of org.rundeck.api.parser.HistoryParser +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/parser/class-use/JobParser.html b/apidocs/org/rundeck/api/parser/class-use/JobParser.html index a9c40ce..5c8ad0a 100644 --- a/apidocs/org/rundeck/api/parser/class-use/JobParser.html +++ b/apidocs/org/rundeck/api/parser/class-use/JobParser.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.parser.JobParser (RunDeck API - Java Client 1.1 API) +Uses of Class org.rundeck.api.parser.JobParser (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.parser.JobParser (RunDeck API - Java Client 1.1 AP function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.parser.JobParser (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Class org.rundeck.api.parser.JobParser (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/parser/class-use/JobsImportResultParser.html b/apidocs/org/rundeck/api/parser/class-use/JobsImportResultParser.html index b635349..1942952 100644 --- a/apidocs/org/rundeck/api/parser/class-use/JobsImportResultParser.html +++ b/apidocs/org/rundeck/api/parser/class-use/JobsImportResultParser.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.parser.JobsImportResultParser (RunDeck API - Java Client 1.1 API) +Uses of Class org.rundeck.api.parser.JobsImportResultParser (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.parser.JobsImportResultParser (RunDeck API - Java function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.parser.JobsImportResultParser (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Class org.rundeck.api.parser.JobsImportResultParser (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/parser/class-use/ListParser.html b/apidocs/org/rundeck/api/parser/class-use/ListParser.html index 92f774d..655c576 100644 --- a/apidocs/org/rundeck/api/parser/class-use/ListParser.html +++ b/apidocs/org/rundeck/api/parser/class-use/ListParser.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.parser.ListParser (RunDeck API - Java Client 1.1 API) +Uses of Class org.rundeck.api.parser.ListParser (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.parser.ListParser (RunDeck API - Java Client 1.1 A function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.parser.ListParser (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Class org.rundeck.api.parser.ListParser (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/parser/class-use/NodeParser.html b/apidocs/org/rundeck/api/parser/class-use/NodeParser.html index 12e652d..d3efe97 100644 --- a/apidocs/org/rundeck/api/parser/class-use/NodeParser.html +++ b/apidocs/org/rundeck/api/parser/class-use/NodeParser.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.parser.NodeParser (RunDeck API - Java Client 1.1 API) +Uses of Class org.rundeck.api.parser.NodeParser (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.parser.NodeParser (RunDeck API - Java Client 1.1 A function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.parser.NodeParser (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Class org.rundeck.api.parser.NodeParser (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/parser/class-use/ParserHelper.html b/apidocs/org/rundeck/api/parser/class-use/ParserHelper.html index 01d0c1b..1b30ab7 100644 --- a/apidocs/org/rundeck/api/parser/class-use/ParserHelper.html +++ b/apidocs/org/rundeck/api/parser/class-use/ParserHelper.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.parser.ParserHelper (RunDeck API - Java Client 1.1 API) +Uses of Class org.rundeck.api.parser.ParserHelper (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.parser.ParserHelper (RunDeck API - Java Client 1.1 function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.parser.ParserHelper (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Class org.rundeck.api.parser.ParserHelper (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/parser/class-use/ProjectParser.html b/apidocs/org/rundeck/api/parser/class-use/ProjectParser.html index 9c9efdf..5b34388 100644 --- a/apidocs/org/rundeck/api/parser/class-use/ProjectParser.html +++ b/apidocs/org/rundeck/api/parser/class-use/ProjectParser.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.parser.ProjectParser (RunDeck API - Java Client 1.1 API) +Uses of Class org.rundeck.api.parser.ProjectParser (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.parser.ProjectParser (RunDeck API - Java Client 1. function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.parser.ProjectParser (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Class org.rundeck.api.parser.ProjectParser (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/parser/class-use/StringParser.html b/apidocs/org/rundeck/api/parser/class-use/StringParser.html index ea32909..786020a 100644 --- a/apidocs/org/rundeck/api/parser/class-use/StringParser.html +++ b/apidocs/org/rundeck/api/parser/class-use/StringParser.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.parser.StringParser (RunDeck API - Java Client 1.1 API) +Uses of Class org.rundeck.api.parser.StringParser (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.parser.StringParser (RunDeck API - Java Client 1.1 function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.parser.StringParser (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Class org.rundeck.api.parser.StringParser (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/parser/class-use/SystemInfoParser.html b/apidocs/org/rundeck/api/parser/class-use/SystemInfoParser.html index 8fefc29..96b2bb1 100644 --- a/apidocs/org/rundeck/api/parser/class-use/SystemInfoParser.html +++ b/apidocs/org/rundeck/api/parser/class-use/SystemInfoParser.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.parser.SystemInfoParser (RunDeck API - Java Client 1.1 API) +Uses of Class org.rundeck.api.parser.SystemInfoParser (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.parser.SystemInfoParser (RunDeck API - Java Client function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.parser.SystemInfoParser (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Class org.rundeck.api.parser.SystemInfoParser (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/parser/class-use/XmlNodeParser.html b/apidocs/org/rundeck/api/parser/class-use/XmlNodeParser.html index 8b6fe72..fc8671c 100644 --- a/apidocs/org/rundeck/api/parser/class-use/XmlNodeParser.html +++ b/apidocs/org/rundeck/api/parser/class-use/XmlNodeParser.html @@ -2,13 +2,13 @@ - + -Uses of Interface org.rundeck.api.parser.XmlNodeParser (RunDeck API - Java Client 1.1 API) +Uses of Interface org.rundeck.api.parser.XmlNodeParser (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Interface org.rundeck.api.parser.XmlNodeParser (RunDeck API - Java Clien function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Interface org.rundeck.api.parser.XmlNodeParser (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Interface org.rundeck.api.parser.XmlNodeParser (RunDeck API - Java Client 1.2 API)"; } } @@ -122,6 +122,14 @@ Uses of  class +EventParser + +
+          Parser for a single RundeckEvent + + + + class ExecutionParser
@@ -130,6 +138,14 @@ Uses of  class +HistoryParser + +
+          Parser for a single RundeckHistory + + + + class JobParser
diff --git a/apidocs/org/rundeck/api/parser/package-frame.html b/apidocs/org/rundeck/api/parser/package-frame.html index 1f18e03..987f877 100644 --- a/apidocs/org/rundeck/api/parser/package-frame.html +++ b/apidocs/org/rundeck/api/parser/package-frame.html @@ -2,13 +2,13 @@ - + -org.rundeck.api.parser (RunDeck API - Java Client 1.1 API) +org.rundeck.api.parser (RunDeck API - Java Client 1.2 API) - + @@ -37,8 +37,12 @@ Classes 
AbortParser
+EventParser +
ExecutionParser
+HistoryParser +
JobParser
JobsImportResultParser diff --git a/apidocs/org/rundeck/api/parser/package-summary.html b/apidocs/org/rundeck/api/parser/package-summary.html index b49ea94..6036aad 100644 --- a/apidocs/org/rundeck/api/parser/package-summary.html +++ b/apidocs/org/rundeck/api/parser/package-summary.html @@ -2,13 +2,13 @@ - + -org.rundeck.api.parser (RunDeck API - Java Client 1.1 API) +org.rundeck.api.parser (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ org.rundeck.api.parser (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.rundeck.api.parser (RunDeck API - Java Client 1.1 API)"; + parent.document.title="org.rundeck.api.parser (RunDeck API - Java Client 1.2 API)"; } } @@ -114,10 +114,18 @@ Internal parsers for parsing the RunDeck responses. Parser for a single RundeckAbort +EventParser +Parser for a single RundeckEvent + + ExecutionParser Parser for a single RundeckExecution +HistoryParser +Parser for a single RundeckHistory + + JobParser Parser for a single RundeckJob diff --git a/apidocs/org/rundeck/api/parser/package-tree.html b/apidocs/org/rundeck/api/parser/package-tree.html index c589f49..f7307f7 100644 --- a/apidocs/org/rundeck/api/parser/package-tree.html +++ b/apidocs/org/rundeck/api/parser/package-tree.html @@ -2,13 +2,13 @@ - + -org.rundeck.api.parser Class Hierarchy (RunDeck API - Java Client 1.1 API) +org.rundeck.api.parser Class Hierarchy (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ org.rundeck.api.parser Class Hierarchy (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.rundeck.api.parser Class Hierarchy (RunDeck API - Java Client 1.1 API)"; + parent.document.title="org.rundeck.api.parser Class Hierarchy (RunDeck API - Java Client 1.2 API)"; } } @@ -94,7 +94,9 @@ Class Hierarchy
  • java.lang.Object
    • org.rundeck.api.parser.AbortParser (implements org.rundeck.api.parser.XmlNodeParser<T>) +
    • org.rundeck.api.parser.EventParser (implements org.rundeck.api.parser.XmlNodeParser<T>)
    • org.rundeck.api.parser.ExecutionParser (implements org.rundeck.api.parser.XmlNodeParser<T>) +
    • org.rundeck.api.parser.HistoryParser (implements org.rundeck.api.parser.XmlNodeParser<T>)
    • org.rundeck.api.parser.JobParser (implements org.rundeck.api.parser.XmlNodeParser<T>)
    • org.rundeck.api.parser.JobsImportResultParser (implements org.rundeck.api.parser.XmlNodeParser<T>)
    • org.rundeck.api.parser.ListParser<T> (implements org.rundeck.api.parser.XmlNodeParser<T>) diff --git a/apidocs/org/rundeck/api/parser/package-use.html b/apidocs/org/rundeck/api/parser/package-use.html index 9721ee0..16493f4 100644 --- a/apidocs/org/rundeck/api/parser/package-use.html +++ b/apidocs/org/rundeck/api/parser/package-use.html @@ -2,13 +2,13 @@ - + -Uses of Package org.rundeck.api.parser (RunDeck API - Java Client 1.1 API) +Uses of Package org.rundeck.api.parser (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Package org.rundeck.api.parser (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Package org.rundeck.api.parser (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Package org.rundeck.api.parser (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/util/AssertUtil.html b/apidocs/org/rundeck/api/util/AssertUtil.html index edd17ed..ea56908 100644 --- a/apidocs/org/rundeck/api/util/AssertUtil.html +++ b/apidocs/org/rundeck/api/util/AssertUtil.html @@ -2,13 +2,13 @@ - + -AssertUtil (RunDeck API - Java Client 1.1 API) +AssertUtil (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ AssertUtil (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="AssertUtil (RunDeck API - Java Client 1.1 API)"; + parent.document.title="AssertUtil (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/util/ParametersUtil.html b/apidocs/org/rundeck/api/util/ParametersUtil.html index 24130c4..253c98a 100644 --- a/apidocs/org/rundeck/api/util/ParametersUtil.html +++ b/apidocs/org/rundeck/api/util/ParametersUtil.html @@ -2,13 +2,13 @@ - + -ParametersUtil (RunDeck API - Java Client 1.1 API) +ParametersUtil (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ ParametersUtil (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="ParametersUtil (RunDeck API - Java Client 1.1 API)"; + parent.document.title="ParametersUtil (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/util/class-use/AssertUtil.html b/apidocs/org/rundeck/api/util/class-use/AssertUtil.html index 2965edc..32e34e2 100644 --- a/apidocs/org/rundeck/api/util/class-use/AssertUtil.html +++ b/apidocs/org/rundeck/api/util/class-use/AssertUtil.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.util.AssertUtil (RunDeck API - Java Client 1.1 API) +Uses of Class org.rundeck.api.util.AssertUtil (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.util.AssertUtil (RunDeck API - Java Client 1.1 API function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.util.AssertUtil (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Class org.rundeck.api.util.AssertUtil (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/util/class-use/ParametersUtil.html b/apidocs/org/rundeck/api/util/class-use/ParametersUtil.html index a1d7bb7..985e9ee 100644 --- a/apidocs/org/rundeck/api/util/class-use/ParametersUtil.html +++ b/apidocs/org/rundeck/api/util/class-use/ParametersUtil.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.util.ParametersUtil (RunDeck API - Java Client 1.1 API) +Uses of Class org.rundeck.api.util.ParametersUtil (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.util.ParametersUtil (RunDeck API - Java Client 1.1 function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.util.ParametersUtil (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Class org.rundeck.api.util.ParametersUtil (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/util/package-frame.html b/apidocs/org/rundeck/api/util/package-frame.html index 3a09855..32ed13f 100644 --- a/apidocs/org/rundeck/api/util/package-frame.html +++ b/apidocs/org/rundeck/api/util/package-frame.html @@ -2,13 +2,13 @@ - + -org.rundeck.api.util (RunDeck API - Java Client 1.1 API) +org.rundeck.api.util (RunDeck API - Java Client 1.2 API) - + diff --git a/apidocs/org/rundeck/api/util/package-summary.html b/apidocs/org/rundeck/api/util/package-summary.html index 0a9bb49..f5bf40a 100644 --- a/apidocs/org/rundeck/api/util/package-summary.html +++ b/apidocs/org/rundeck/api/util/package-summary.html @@ -2,13 +2,13 @@ - + -org.rundeck.api.util (RunDeck API - Java Client 1.1 API) +org.rundeck.api.util (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ org.rundeck.api.util (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.rundeck.api.util (RunDeck API - Java Client 1.1 API)"; + parent.document.title="org.rundeck.api.util (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/util/package-tree.html b/apidocs/org/rundeck/api/util/package-tree.html index f695974..ed83ee4 100644 --- a/apidocs/org/rundeck/api/util/package-tree.html +++ b/apidocs/org/rundeck/api/util/package-tree.html @@ -2,13 +2,13 @@ - + -org.rundeck.api.util Class Hierarchy (RunDeck API - Java Client 1.1 API) +org.rundeck.api.util Class Hierarchy (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ org.rundeck.api.util Class Hierarchy (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.rundeck.api.util Class Hierarchy (RunDeck API - Java Client 1.1 API)"; + parent.document.title="org.rundeck.api.util Class Hierarchy (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/org/rundeck/api/util/package-use.html b/apidocs/org/rundeck/api/util/package-use.html index da3c789..3caf16d 100644 --- a/apidocs/org/rundeck/api/util/package-use.html +++ b/apidocs/org/rundeck/api/util/package-use.html @@ -2,13 +2,13 @@ - + -Uses of Package org.rundeck.api.util (RunDeck API - Java Client 1.1 API) +Uses of Package org.rundeck.api.util (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Uses of Package org.rundeck.api.util (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Package org.rundeck.api.util (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Uses of Package org.rundeck.api.util (RunDeck API - Java Client 1.2 API)"; } } diff --git a/apidocs/overview-frame.html b/apidocs/overview-frame.html index 647e7ba..8b340a2 100644 --- a/apidocs/overview-frame.html +++ b/apidocs/overview-frame.html @@ -2,13 +2,13 @@ - + -Overview List (RunDeck API - Java Client 1.1 API) +Overview List (RunDeck API - Java Client 1.2 API) - + diff --git a/apidocs/overview-summary.html b/apidocs/overview-summary.html index 0f5fe57..6fdb103 100644 --- a/apidocs/overview-summary.html +++ b/apidocs/overview-summary.html @@ -2,13 +2,13 @@ - + -Overview (RunDeck API - Java Client 1.1 API) +Overview (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Overview (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Overview (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Overview (RunDeck API - Java Client 1.2 API)"; } } @@ -82,7 +82,7 @@ function windowTitle()

      -RunDeck API - Java Client 1.1 API +RunDeck API - Java Client 1.2 API

      See the documentation of the RundeckClient class (main entry point of the API). diff --git a/apidocs/overview-tree.html b/apidocs/overview-tree.html index ca9f24a..38cf7fb 100644 --- a/apidocs/overview-tree.html +++ b/apidocs/overview-tree.html @@ -2,13 +2,13 @@ - + -Class Hierarchy (RunDeck API - Java Client 1.1 API) +Class Hierarchy (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Class Hierarchy (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Class Hierarchy (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Class Hierarchy (RunDeck API - Java Client 1.2 API)"; } } @@ -93,7 +93,9 @@ Class Hierarchy
      diff --git a/apidocs/serialized-form.html b/apidocs/serialized-form.html index 9502f5c..6f23f8b 100644 --- a/apidocs/serialized-form.html +++ b/apidocs/serialized-form.html @@ -2,13 +2,13 @@ - + -Serialized Form (RunDeck API - Java Client 1.1 API) +Serialized Form (RunDeck API - Java Client 1.2 API) - + @@ -16,7 +16,7 @@ Serialized Form (RunDeck API - Java Client 1.1 API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Serialized Form (RunDeck API - Java Client 1.1 API)"; + parent.document.title="Serialized Form (RunDeck API - Java Client 1.2 API)"; } } @@ -147,6 +147,8 @@ url 
       String url
      +
      URL of the RunDeck instance ("http://localhost:4440", "http://rundeck.your-compagny.com/", etc) +

      @@ -156,6 +158,8 @@ login 
       String login
      +
      Login to use for authentication on the RunDeck instance +

      @@ -165,6 +169,8 @@ password 
       String password
      +
      Password to use for authentication on the RunDeck instance +

      @@ -216,6 +222,180 @@ execution
+

+ + + + + +
+Class org.rundeck.api.domain.RundeckEvent extends Object implements Serializable
+ +

+serialVersionUID: 1L + +

+ + + + + +
+Serialized Fields
+ +

+title

+
+String title
+
+
+
+
+
+

+status

+
+RundeckEvent.EventStatus status
+
+
+
+
+
+

+summary

+
+String summary
+
+
+
+
+
+

+nodeSummary

+
+RundeckEvent.NodeSummary nodeSummary
+
+
+
+
+
+

+user

+
+String user
+
+
+
+
+
+

+project

+
+String project
+
+
+
+
+
+

+startedAt

+
+Date startedAt
+
+
+
+
+
+

+endedAt

+
+Date endedAt
+
+
+
+
+
+

+abortedBy

+
+String abortedBy
+
+
only if the execution was aborted +

+

+
+
+
+

+executionId

+
+Long executionId
+
+
only if associated with an execution +

+

+
+
+
+

+jobId

+
+String jobId
+
+
only if associated with a job +

+

+
+
+ +

+ + + + + +
+Class org.rundeck.api.domain.RundeckEvent.NodeSummary extends Object implements Serializable
+ +

+serialVersionUID: 1L + +

+ + + + + +
+Serialized Fields
+ +

+succeeded

+
+int succeeded
+
+
+
+
+
+

+failed

+
+int failed
+
+
+
+
+
+

+total

+
+int total
+
+
+
+
+

@@ -324,6 +504,72 @@ description +

+ +

+ + + +
+Class org.rundeck.api.domain.RundeckHistory extends Object implements Serializable
+ +

+serialVersionUID: 1L + +

+ + + + + +
+Serialized Fields
+ +

+events

+
+List<E> events
+
+
+
+
+
+

+count

+
+int count
+
+
+
+
+
+

+total

+
+int total
+
+
+
+
+
+

+max

+
+int max
+
+
+
+
+
+

+offset

+
+int offset
+
+
+
+
+

diff --git a/changes-report.html b/changes-report.html index 968bada..55a8b19 100644 --- a/changes-report.html +++ b/changes-report.html @@ -1,5 +1,5 @@ - + @@ -11,7 +11,7 @@ - + @@ -50,8 +50,8 @@
- Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
@@ -75,6 +75,9 @@
  • Download
    • +
  • + Changelog +
  • API Documentation
    • @@ -150,7 +153,7 @@
    -

    Changelog

    Release History

    VersionDateDescription
    1.12011-07-28Import / export jobs
    1.02011-07-08Use RunDeck REST API version 1 (RunDeck 1.2+)

    Release 1.1 - 2011-07-28

    TypeChangesBy

    add

    		Import jobs (XML or YAML)vbehar

    add

    		YAML format is now supported when exporting jobs definitionsvbehar

    add

    		Support for using an HTTP proxyvbehar

    Release 1.0 - 2011-07-08

    TypeChangesBy

    add

    		Initial releasevbehar
    +

    Changelog

    Release History

    VersionDateDescription
    1.22011-07-31Ad-hoc scripts + history events
    1.12011-07-28Import / export jobs
    1.02011-07-08Use RunDeck REST API version 1 (RunDeck 1.2+)

    Release 1.2 - 2011-07-31

    TypeChangesBy

    add

    		Run ad-hoc scriptsvbehar

    add

    		List history eventsvbehar

    Release 1.1 - 2011-07-28

    TypeChangesBy

    add

    		Import jobs (XML or YAML)vbehar

    add

    		YAML format is now supported when exporting jobs definitionsvbehar

    add

    		Support for using an HTTP proxyvbehar

    Release 1.0 - 2011-07-08

    TypeChangesBy

    add

    		Initial releasevbehar
    diff --git a/cpd.html b/cpd.html index d28a9cb..3a9fe5c 100644 --- a/cpd.html +++ b/cpd.html @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -49,8 +49,8 @@
    - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation @@ -149,7 +152,66 @@
    • -

    CPD Results

    The following document contains the results of PMD's CPD 4.2.5.

    Duplications

    CPD found no problems in your source code.

    +

    CPD Results

    The following document contains the results of PMD's CPD 4.2.5.

    Duplications

    FileLine
    org/rundeck/api/domain/RundeckEvent.java152
    org/rundeck/api/domain/RundeckExecution.java136
        }
+
+    public Date getStartedAt() {
+        return (startedAt != null) ? new Date(startedAt.getTime()) : null;
+    }
+
+    public void setStartedAt(Date startedAt) {
+        this.startedAt = ((startedAt != null) ? new Date(startedAt.getTime()) : null);
+    }
+
+    public Date getEndedAt() {
+        return (endedAt != null) ? new Date(endedAt.getTime()) : null;
+    }
+
+    public void setEndedAt(Date endedAt) {
+        this.endedAt = ((endedAt != null) ? new Date(endedAt.getTime()) : null);
+    }
+
+    public String getAbortedBy() {
+        return abortedBy;
+    }
+
+    public void setAbortedBy(String abortedBy) {
+        this.abortedBy = abortedBy;
+    }
+
+    public String getDescription() {
    FileLine
    org/rundeck/api/domain/RundeckEvent.java60
    org/rundeck/api/domain/RundeckExecution.java58
        public Long getDurationInMillis() {
+        if (startedAt == null || endedAt == null) {
+            return null;
+        }
+        return endedAt.getTime() - startedAt.getTime();
+    }
+
+    /**
+     * @return the duration of the execution in seconds (or null if the execution is still running, or has been aborted)
+     */
+    public Long getDurationInSeconds() {
+        Long durationInMillis = getDurationInMillis();
+        return durationInMillis != null ? TimeUnit.MILLISECONDS.toSeconds(durationInMillis) : null;
+    }
+
+    /**
+     * @return the duration of the execution, as a human-readable string : "3 minutes 34 seconds" (or null if the
+     *         execution is still running, or has been aborted)
+     */
+    public String getDuration() {
+        Long durationInMillis = getDurationInMillis();
+        return durationInMillis != null ? DurationFormatUtils.formatDurationWords(durationInMillis, true, true) : null;
+    }
+
+    /**
+     * @return the duration of the execution, as a "short" human-readable string : "0:03:34.187" (or null if the
+     *         execution is still running, or has been aborted)
+     */
+    public String getShortDuration() {
+        Long durationInMillis = getDurationInMillis();
+        return durationInMillis != null ? DurationFormatUtils.formatDurationHMS(durationInMillis) : null;
+    }
+
+    public Long getId() {
    diff --git a/cpd.xml b/cpd.xml index 4a4568b..d732ed4 100644 --- a/cpd.xml +++ b/cpd.xml @@ -1,3 +1,80 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dependencies.html b/dependencies.html index 87d0ef9..e616c5e 100644 --- a/dependencies.html +++ b/dependencies.html @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -49,8 +49,8 @@
    - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation @@ -160,28 +163,28 @@ } } -

    Dependency Tree

    • org.rundeck:rundeck-api-java-client:jar:1.1 Information
      • org.apache.httpcomponents:httpclient:jar:4.1.1 (compile) Information
        • org.apache.httpcomponents:httpcore:jar:4.1 (compile) Information
        • commons-logging:commons-logging:jar:1.1.1 (compile) Information
        • commons-codec:commons-codec:jar:1.4 (compile) Information
      • com.ibm.icu:icu4j:jar:2.6.1 (compile) Information
  • junit:junit:jar:4.8.2 (test) Information

    • Licenses

    LGPL: xom

    Unknown: Unnamed - com.ibm.icu:icu4j:jar:2.6.1, Unnamed - jdom:jdom:jar:1.0, Unnamed - xalan:xalan:jar:2.6.0, Unnamed - xerces:xercesImpl:jar:2.6.2, Unnamed - xerces:xmlParserAPIs:jar:2.6.2, dom4j, jaxen

    Apache License: HttpClient, HttpCore, HttpMime

    Common Public License Version 1.0: JUnit

    The Apache Software License, Version 2.0: Commons Codec, Commons IO, Commons Lang, Commons Logging, RunDeck API - Java Client, XML Commons External Components XML APIs

    Dependency File Details

    FilenameSizeEntriesClassesPackagesJDK RevDebugSealed
    icu4j-2.6.1.jar2.34 MB75564861.2debug-
    commons-codec-1.4.jar56.80 kB473051.4debug-
    commons-io-2.0.1.jar155.77 kB12210461.5debug-
    commons-lang-2.6.jar277.56 kB155133101.3debug-
    commons-logging-1.1.1.jar59.26 kB422821.1debug-
    dom4j-1.6.1.jar306.54 kB208190141.3debug-
    jaxen-1.1.1.jar221.60 kB236214171.2debug-
    jdom-1.0.jar149.66 kB877581.1debug-
    junit-4.8.2.jar231.78 kB267230301.5debug-
    httpclient-4.1.1.jar342.90 kB308272221.5debug-
    httpcore-4.1.jar176.80 kB185163101.3debug-
    httpmime-4.1.1.jar26.26 kB311521.5debug-
    xalan-2.6.0.jar3.00 MB1,6251,548501.1debug-
    xercesImpl-2.6.2.jar986.99 kB845784371.1release-
    xmlParserAPIs-2.6.2.jar121.80 kB238207171.1release-
    xml-apis-1.0.b2.jar106.76 kB217184171.2release-
    xom-1.0.jar106.32 kB1089661.2releasesealed
    TotalSizeEntriesClassesPackagesJDK RevDebugSealed
    178.59 MB5,4764,9212591.5131
    compile: 16compile: 8.36 MBcompile: 5,209compile: 4,691compile: 229-compile: 12compile: 1
    test: 1test: 231.78 kBtest: 267test: 230test: 30-test: 1-

    Dependency Repository Locations

    Repo IDURLReleaseSnapshot
    apache.snapshotshttp://people.apache.org/repo/m2-snapshot-repository-Yes-
    sonatype-nexus-snapshotshttps://oss.sonatype.org/content/repositories/snapshots-Yes-
    centralhttp://repo1.maven.org/maven2Yes--

    Repository locations for each of the Dependencies.

    Artifactapache.snapshotssonatype-nexus-snapshotscentral
    com.ibm.icu:icu4j:jar:2.6.1--Found at http://repo1.maven.org/maven2
    commons-codec:commons-codec:jar:1.4--Found at http://repo1.maven.org/maven2
    commons-io:commons-io:jar:2.0.1--Found at http://repo1.maven.org/maven2
    commons-lang:commons-lang:jar:2.6--Found at http://repo1.maven.org/maven2
    commons-logging:commons-logging:jar:1.1.1--Found at http://repo1.maven.org/maven2
    dom4j:dom4j:jar:1.6.1--Found at http://repo1.maven.org/maven2
    jaxen:jaxen:jar:1.1.1--Found at http://repo1.maven.org/maven2
    jdom:jdom:jar:1.0--Found at http://repo1.maven.org/maven2
    junit:junit:jar:4.8.2--Found at http://repo1.maven.org/maven2
    org.apache.httpcomponents:httpclient:jar:4.1.1--Found at http://repo1.maven.org/maven2
    org.apache.httpcomponents:httpcore:jar:4.1--Found at http://repo1.maven.org/maven2
    org.apache.httpcomponents:httpmime:jar:4.1.1--Found at http://repo1.maven.org/maven2
    xalan:xalan:jar:2.6.0--Found at http://repo1.maven.org/maven2
    xerces:xercesImpl:jar:2.6.2--Found at http://repo1.maven.org/maven2
    xerces:xmlParserAPIs:jar:2.6.2--Found at http://repo1.maven.org/maven2
    xml-apis:xml-apis:jar:1.0.b2--Found at http://repo1.maven.org/maven2
    xom:xom:jar:1.0--Found at http://repo1.maven.org/maven2
    Totalapache.snapshotssonatype-nexus-snapshotscentral
    17 (compile: 16, test: 1)0017
    diff --git a/dependency-updates-report.html b/dependency-updates-report.html index 983b7a1..143b4bc 100644 --- a/dependency-updates-report.html +++ b/dependency-updates-report.html @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -49,8 +49,8 @@
    - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation diff --git a/distribution-management.html b/distribution-management.html index 40d9069..dc9c969 100644 --- a/distribution-management.html +++ b/distribution-management.html @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -49,8 +49,8 @@
    • - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation diff --git a/download.html b/download.html index 4026145..b6a8ee6 100644 --- a/download.html +++ b/download.html @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -49,8 +49,8 @@
    • - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -74,6 +74,9 @@
  • Download
    • +
  • + Changelog +
  • API Documentation
    • diff --git a/faq.html b/faq.html index 41c6c6e..0b8209b 100644 --- a/faq.html +++ b/faq.html @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -49,8 +49,8 @@
    - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation diff --git a/findbugs.html b/findbugs.html index f7bc49d..26ad156 100644 --- a/findbugs.html +++ b/findbugs.html @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -49,8 +49,8 @@
    • - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation @@ -149,7 +152,7 @@
    • -

    FindBugs Bug Detector Report

    The following document contains the results of FindBugs Report

    FindBugs Version is 1.3.9

    Threshold is medium

    Effort is min

    Summary

    ClassesBugsErrorsMissing Classes
    32000

    Files

    ClassBugs
    +

    FindBugs Bug Detector Report

    The following document contains the results of FindBugs Report

    FindBugs Version is 1.3.9

    Threshold is medium

    Effort is min

    Summary

    ClassesBugsErrorsMissing Classes
    38000

    Files

    ClassBugs
    diff --git a/groovy.html b/groovy.html index 8e557ae..2cf7f56 100644 --- a/groovy.html +++ b/groovy.html @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -49,8 +49,8 @@
    - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation @@ -112,7 +115,7 @@

    Using the RunDeck API from Groovy scripts

    Here are some examples of what you can do with this lib and a few lines of Groovy.

    We can use Grape to download the lib (and its dependencies) from the Maven Central Repository, so you don't have to install anything manually (except Groovy, of course).

    Basic usage

    Save the following script in a file named "rundeck.groovy", and execute it with "groovy rundeck.groovy". Feeling Groovy ? ;-)

    // we use Grape (Ivy) to download the lib (and its dependencies) from Maven Central Repository
-@Grab(group='org.rundeck', module='rundeck-api-java-client', version='1.1')
+@Grab(group='org.rundeck', module='rundeck-api-java-client', version='1.2')
 import org.rundeck.api.RundeckClient
 
 rundeck = new RundeckClient("http://localhost:4440", "admin", "admin")
@@ -159,6 +162,14 @@ execution = rundeck.triggerAdhocCommand("my-project", "uptime&quo
 
 // run the "uptime" command on all unix nodes
 execution = rundeck.runAdhocCommand("my-project", "uptime", new Properties(os-family: "unix"))
+

    Running an ad-hoc script

    import org.rundeck.api.RundeckClient
+rundeck = new RundeckClient("http://localhost:4440", "admin", "admin")
+
+// trigger the execution of a custom bash script on the RunDeck server
+execution = rundeck.triggerAdhocScript("my-project", "/tmp/my-script.sh")
+
+// run a bash script (with options) on all unix nodes
+execution = rundeck.runAdhocCommand("my-project", "/tmp/my-script-with-options.sh", new Properties(option1: "value one"), new Properties(os-family: "unix"))

    Exporting jobs

    import org.rundeck.api.RundeckClient
 rundeck = new RundeckClient("http://localhost:4440", "admin", "admin")
 
diff --git a/index.html b/index.html
index 0b11660..1e28440 100644
--- a/index.html
+++ b/index.html
@@ -1,5 +1,5 @@
 
-
+
 
   
     
@@ -10,7 +10,7 @@
       @import url("./css/site.css");
     
     
-    
+    
     
         
           
@@ -49,8 +49,8 @@
    - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation diff --git a/integration.html b/integration.html index d7fa5f4..ae66f06 100644 --- a/integration.html +++ b/integration.html @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -49,8 +49,8 @@
    • - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation diff --git a/issue-tracking.html b/issue-tracking.html index af20bc3..c7fc17d 100644 --- a/issue-tracking.html +++ b/issue-tracking.html @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -49,8 +49,8 @@
    • - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation diff --git a/jruby.html b/jruby.html index 0b3dd64..bf42779 100644 --- a/jruby.html +++ b/jruby.html @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -49,8 +49,8 @@
    • - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation @@ -164,6 +167,17 @@ execution = rundeck.triggerAdhocCommand("my-project", "uptime&quo // run the "uptime" command on all unix nodes execution = rundeck.runAdhocCommand("my-project", "uptime", NodeFiltersBuilder.new().osFamily("unix").toProperties()) +

    • Running an ad-hoc script

    import org.rundeck.api.RundeckClient
+import org.rundeck.api.OptionsBuilder
+import org.rundeck.api.NodeFiltersBuilder
+
+rundeck = RundeckClient.new("http://localhost:4440", "admin", "admin")
+
+// trigger the execution of a custom bash script on the RunDeck server
+execution = rundeck.triggerAdhocScript("my-project", "/tmp/my-script.sh")
+
+// run a bash script (with options) on all unix nodes
+execution = rundeck.runAdhocCommand("my-project", "/tmp/my-script-with-options.sh", OptionsBuilder.new().addOption("option1", "value one").toProperties(), NodeFiltersBuilder.new().osFamily("unix").toProperties())

    Exporting jobs

    import org.rundeck.api.RundeckClient
 rundeck = RundeckClient.new("http://localhost:4440", "admin", "admin")
 
diff --git a/jython.html b/jython.html
index 420a1f7..58468f1 100644
--- a/jython.html
+++ b/jython.html
@@ -1,5 +1,5 @@
 
-
+
 
   
     
@@ -10,7 +10,7 @@
       @import url("./css/site.css");
     
     
-    
+    
     
         
           
@@ -49,8 +49,8 @@
    - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation @@ -153,6 +156,17 @@ execution = rundeck.triggerAdhocCommand("my-project", "uptime&quo // run the "uptime" command on all unix nodes execution = rundeck.runAdhocCommand("my-project", "uptime", NodeFiltersBuilder().osFamily("unix").toProperties()) +

    • Running an ad-hoc script

    from org.rundeck.api import RundeckClient
+from org.rundeck.api import OptionsBuilder
+from org.rundeck.api import NodeFiltersBuilder
+
+rundeck = RundeckClient("http://localhost:4440", "admin", "admin")
+
+// trigger the execution of a custom bash script on the RunDeck server
+execution = rundeck.triggerAdhocScript("my-project", "/tmp/my-script.sh")
+
+// run a bash script (with options) on all unix nodes
+execution = rundeck.runAdhocCommand("my-project", "/tmp/my-script-with-options.sh", OptionsBuilder().addOption("option1", "value one").toProperties(), NodeFiltersBuilder().osFamily("unix").toProperties())

    Exporting jobs

    from org.rundeck.api import RundeckClient
 rundeck = RundeckClient("http://localhost:4440", "admin", "admin")
 
diff --git a/license.html b/license.html
index 2e46190..73476e2 100644
--- a/license.html
+++ b/license.html
@@ -1,5 +1,5 @@
 
-
+
 
   
     
@@ -10,7 +10,7 @@
       @import url("./css/site.css");
     
     
-    
+    
     
         
           
@@ -49,8 +49,8 @@
    - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation diff --git a/mail-lists.html b/mail-lists.html index 12cfda9..946d0d7 100644 --- a/mail-lists.html +++ b/mail-lists.html @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -49,8 +49,8 @@
    • - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation diff --git a/plugin-updates-report.html b/plugin-updates-report.html index 22c7b32..657b642 100644 --- a/plugin-updates-report.html +++ b/plugin-updates-report.html @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -49,8 +49,8 @@
    • - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation @@ -149,7 +152,7 @@
    • -

    Overview

    This report summarizes newer versions that may be available for your project's various plugins.

    # of plugins using the latest version available25
    # of plugins where the next version available is smaller than an incremental version update1
    # of plugins where the next version available is an incremental version update1
    # of plugins where the next version available is a minor version update4
    # of plugins where the next version available is a major version update0
    # of plugins where a dependencies section containes a dependency with an updated version0

    Plugin Management

    StatusGroup IdArtifact IdCurrent VersionNext VersionNext IncrementalNext MinorNext MajorDependency status
    org.apache.maven.pluginsmaven-antrun-plugin1.6
    org.apache.maven.pluginsmaven-assembly-plugin2.2.1
    org.apache.maven.pluginsmaven-checkstyle-plugin2.6
    org.apache.maven.pluginsmaven-clean-plugin2.4.1
    org.apache.maven.pluginsmaven-compiler-plugin2.3.2
    org.apache.maven.pluginsmaven-dependency-plugin2.3
    org.apache.maven.pluginsmaven-deploy-plugin2.6
    org.apache.maven.pluginsmaven-ear-plugin2.3.12.3.22.4
    org.apache.maven.pluginsmaven-eclipse-plugin2.8
    org.apache.maven.pluginsmaven-ejb-plugin2.12.2
    org.apache.maven.pluginsmaven-enforcer-plugin1.0.1
    org.apache.maven.pluginsmaven-help-plugin2.1.1
    org.apache.maven.pluginsmaven-install-plugin2.3.1
    org.apache.maven.pluginsmaven-jar-plugin2.3.1
    org.apache.maven.pluginsmaven-javadoc-plugin2.8
    org.apache.maven.pluginsmaven-plugin-plugin2.4.32.5
    org.apache.maven.pluginsmaven-pmd-plugin2.5
    org.apache.maven.pluginsmaven-rar-plugin2.2
    org.apache.maven.pluginsmaven-release-plugin2.2
    org.apache.maven.pluginsmaven-resources-plugin2.5
    org.apache.maven.pluginsmaven-site-plugin2.33.0-beta-1
    org.apache.maven.pluginsmaven-source-plugin2.1.2
    org.apache.maven.pluginsmaven-surefire-plugin2.9
    org.apache.maven.pluginsmaven-war-plugin2.1-alpha-22.1-beta-12.1.1
    org.codehaus.mojofindbugs-maven-plugin2.3.2
    StatusGroup IdArtifact IdCurrent VersionNext VersionNext IncrementalNext MinorNext MajorDependency status

    Plugins

    StatusGroup IdArtifact IdCurrent VersionNext VersionNext IncrementalNext MinorNext MajorDependency status
    org.apache.maven.pluginsmaven-changes-plugin2.6
    org.apache.maven.pluginsmaven-gpg-plugin1.11.2
    org.apache.maven.pluginsmaven-jxr-plugin2.3
    org.apache.maven.pluginsmaven-project-info-reports-plugin2.4
    org.codehaus.mojotaglist-maven-plugin2.4
    org.codehaus.mojoversions-maven-plugin1.2
    StatusGroup IdArtifact IdCurrent VersionNext VersionNext IncrementalNext MinorNext MajorDependency status

    Plugin Updates

    Plugin org.apache.maven.plugins:maven-antrun-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-antrun-plugin
    Current Version1.6

    Plugin org.apache.maven.plugins:maven-assembly-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-assembly-plugin
    Current Version2.2.1

    Plugin org.apache.maven.plugins:maven-changes-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-changes-plugin
    Current Version2.6

    Plugin org.apache.maven.plugins:maven-checkstyle-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-checkstyle-plugin
    Current Version2.6

    Plugin org.apache.maven.plugins:maven-clean-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-clean-plugin
    Current Version2.4.1

    Plugin org.apache.maven.plugins:maven-compiler-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-compiler-plugin
    Current Version2.3.2

    Plugin org.apache.maven.plugins:maven-dependency-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-dependency-plugin
    Current Version2.3

    Plugin org.apache.maven.plugins:maven-deploy-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-deploy-plugin
    Current Version2.6

    Plugin org.apache.maven.plugins:maven-ear-plugin

    Status There is at least one newer incremental version available. Incremental updates are typically passive.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-ear-plugin
    Current Version2.3.1
    Newer versions2.3.2 Next Incremental
    2.4 Next Minor
    2.4.1
    2.4.2
    2.5
    2.6 Latest Minor

    Plugin org.apache.maven.plugins:maven-eclipse-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-eclipse-plugin
    Current Version2.8

    Plugin org.apache.maven.plugins:maven-ejb-plugin

    Status There is at least one newer minor version available. Minor updates are sometimes passive.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-ejb-plugin
    Current Version2.1
    Newer versions2.2 Next Minor
    2.2.1
    2.3 Latest Minor

    Plugin org.apache.maven.plugins:maven-enforcer-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-enforcer-plugin
    Current Version1.0.1

    Plugin org.apache.maven.plugins:maven-gpg-plugin

    Status There is at least one newer minor version available. Minor updates are sometimes passive.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-gpg-plugin
    Current Version1.1
    Newer versions1.2 Next Minor
    1.3 Latest Minor

    Plugin org.apache.maven.plugins:maven-help-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-help-plugin
    Current Version2.1.1

    Plugin org.apache.maven.plugins:maven-install-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-install-plugin
    Current Version2.3.1

    Plugin org.apache.maven.plugins:maven-jar-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-jar-plugin
    Current Version2.3.1

    Plugin org.apache.maven.plugins:maven-javadoc-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-javadoc-plugin
    Current Version2.8

    Plugin org.apache.maven.plugins:maven-jxr-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-jxr-plugin
    Current Version2.3

    Plugin org.apache.maven.plugins:maven-plugin-plugin

    Status There is at least one newer minor version available. Minor updates are sometimes passive.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-plugin-plugin
    Current Version2.4.3
    Newer versions2.5 Next Minor
    2.5.1
    2.6
    2.7
    2.8 Latest Minor

    Plugin org.apache.maven.plugins:maven-pmd-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-pmd-plugin
    Current Version2.5

    Plugin org.apache.maven.plugins:maven-project-info-reports-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-project-info-reports-plugin
    Current Version2.4

    Plugin org.apache.maven.plugins:maven-rar-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-rar-plugin
    Current Version2.2

    Plugin org.apache.maven.plugins:maven-release-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-release-plugin
    Current Version2.2

    Plugin org.apache.maven.plugins:maven-resources-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-resources-plugin
    Current Version2.5

    Plugin org.apache.maven.plugins:maven-site-plugin

    Status There is at least one newer minor version available. Minor updates are sometimes passive.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-site-plugin
    Current Version2.3
    Newer versions3.0-beta-1 Next Minor
    3.0-beta-2
    3.0-beta-3 Latest Minor

    Plugin org.apache.maven.plugins:maven-source-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-source-plugin
    Current Version2.1.2

    Plugin org.apache.maven.plugins:maven-surefire-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-surefire-plugin
    Current Version2.9

    Plugin org.apache.maven.plugins:maven-war-plugin

    Status There is at least one newer version available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-war-plugin
    Current Version2.1-alpha-2
    Newer versions2.1-beta-1 Next Version
    2.1
    2.1.1 Next Incremental

    Plugin org.codehaus.mojo:findbugs-maven-plugin

    Status No newer versions available.
    Group Idorg.codehaus.mojo
    Artifact Idfindbugs-maven-plugin
    Current Version2.3.2

    Plugin org.codehaus.mojo:taglist-maven-plugin

    Status No newer versions available.
    Group Idorg.codehaus.mojo
    Artifact Idtaglist-maven-plugin
    Current Version2.4

    Plugin org.codehaus.mojo:versions-maven-plugin

    Status No newer versions available.
    Group Idorg.codehaus.mojo
    Artifact Idversions-maven-plugin
    Current Version1.2
    +

    Overview

    This report summarizes newer versions that may be available for your project's various plugins.

    # of plugins using the latest version available26
    # of plugins where the next version available is smaller than an incremental version update1
    # of plugins where the next version available is an incremental version update1
    # of plugins where the next version available is a minor version update3
    # of plugins where the next version available is a major version update0
    # of plugins where a dependencies section containes a dependency with an updated version0

    Plugin Management

    StatusGroup IdArtifact IdCurrent VersionNext VersionNext IncrementalNext MinorNext MajorDependency status
    org.apache.maven.pluginsmaven-antrun-plugin1.6
    org.apache.maven.pluginsmaven-assembly-plugin2.2.1
    org.apache.maven.pluginsmaven-checkstyle-plugin2.6
    org.apache.maven.pluginsmaven-clean-plugin2.4.1
    org.apache.maven.pluginsmaven-compiler-plugin2.3.2
    org.apache.maven.pluginsmaven-dependency-plugin2.3
    org.apache.maven.pluginsmaven-deploy-plugin2.6
    org.apache.maven.pluginsmaven-ear-plugin2.3.12.3.22.4
    org.apache.maven.pluginsmaven-eclipse-plugin2.8
    org.apache.maven.pluginsmaven-ejb-plugin2.12.2
    org.apache.maven.pluginsmaven-enforcer-plugin1.0.1
    org.apache.maven.pluginsmaven-gpg-plugin1.3
    org.apache.maven.pluginsmaven-help-plugin2.1.1
    org.apache.maven.pluginsmaven-install-plugin2.3.1
    org.apache.maven.pluginsmaven-jar-plugin2.3.1
    org.apache.maven.pluginsmaven-javadoc-plugin2.8
    org.apache.maven.pluginsmaven-plugin-plugin2.4.32.5
    org.apache.maven.pluginsmaven-pmd-plugin2.5
    org.apache.maven.pluginsmaven-rar-plugin2.2
    org.apache.maven.pluginsmaven-release-plugin2.2
    org.apache.maven.pluginsmaven-resources-plugin2.5
    org.apache.maven.pluginsmaven-site-plugin2.33.0-beta-1
    org.apache.maven.pluginsmaven-source-plugin2.1.2
    org.apache.maven.pluginsmaven-surefire-plugin2.9
    org.apache.maven.pluginsmaven-war-plugin2.1-alpha-22.1-beta-12.1.1
    org.codehaus.mojofindbugs-maven-plugin2.3.2
    StatusGroup IdArtifact IdCurrent VersionNext VersionNext IncrementalNext MinorNext MajorDependency status

    Plugins

    StatusGroup IdArtifact IdCurrent VersionNext VersionNext IncrementalNext MinorNext MajorDependency status
    org.apache.maven.pluginsmaven-changes-plugin2.6
    org.apache.maven.pluginsmaven-jxr-plugin2.3
    org.apache.maven.pluginsmaven-project-info-reports-plugin2.4
    org.codehaus.mojotaglist-maven-plugin2.4
    org.codehaus.mojoversions-maven-plugin1.2
    StatusGroup IdArtifact IdCurrent VersionNext VersionNext IncrementalNext MinorNext MajorDependency status

    Plugin Updates

    Plugin org.apache.maven.plugins:maven-antrun-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-antrun-plugin
    Current Version1.6

    Plugin org.apache.maven.plugins:maven-assembly-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-assembly-plugin
    Current Version2.2.1

    Plugin org.apache.maven.plugins:maven-changes-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-changes-plugin
    Current Version2.6

    Plugin org.apache.maven.plugins:maven-checkstyle-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-checkstyle-plugin
    Current Version2.6

    Plugin org.apache.maven.plugins:maven-clean-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-clean-plugin
    Current Version2.4.1

    Plugin org.apache.maven.plugins:maven-compiler-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-compiler-plugin
    Current Version2.3.2

    Plugin org.apache.maven.plugins:maven-dependency-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-dependency-plugin
    Current Version2.3

    Plugin org.apache.maven.plugins:maven-deploy-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-deploy-plugin
    Current Version2.6

    Plugin org.apache.maven.plugins:maven-ear-plugin

    Status There is at least one newer incremental version available. Incremental updates are typically passive.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-ear-plugin
    Current Version2.3.1
    Newer versions2.3.2 Next Incremental
    2.4 Next Minor
    2.4.1
    2.4.2
    2.5
    2.6 Latest Minor

    Plugin org.apache.maven.plugins:maven-eclipse-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-eclipse-plugin
    Current Version2.8

    Plugin org.apache.maven.plugins:maven-ejb-plugin

    Status There is at least one newer minor version available. Minor updates are sometimes passive.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-ejb-plugin
    Current Version2.1
    Newer versions2.2 Next Minor
    2.2.1
    2.3 Latest Minor

    Plugin org.apache.maven.plugins:maven-enforcer-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-enforcer-plugin
    Current Version1.0.1

    Plugin org.apache.maven.plugins:maven-gpg-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-gpg-plugin
    Current Version1.3

    Plugin org.apache.maven.plugins:maven-help-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-help-plugin
    Current Version2.1.1

    Plugin org.apache.maven.plugins:maven-install-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-install-plugin
    Current Version2.3.1

    Plugin org.apache.maven.plugins:maven-jar-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-jar-plugin
    Current Version2.3.1

    Plugin org.apache.maven.plugins:maven-javadoc-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-javadoc-plugin
    Current Version2.8

    Plugin org.apache.maven.plugins:maven-jxr-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-jxr-plugin
    Current Version2.3

    Plugin org.apache.maven.plugins:maven-plugin-plugin

    Status There is at least one newer minor version available. Minor updates are sometimes passive.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-plugin-plugin
    Current Version2.4.3
    Newer versions2.5 Next Minor
    2.5.1
    2.6
    2.7
    2.8 Latest Minor

    Plugin org.apache.maven.plugins:maven-pmd-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-pmd-plugin
    Current Version2.5

    Plugin org.apache.maven.plugins:maven-project-info-reports-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-project-info-reports-plugin
    Current Version2.4

    Plugin org.apache.maven.plugins:maven-rar-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-rar-plugin
    Current Version2.2

    Plugin org.apache.maven.plugins:maven-release-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-release-plugin
    Current Version2.2

    Plugin org.apache.maven.plugins:maven-resources-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-resources-plugin
    Current Version2.5

    Plugin org.apache.maven.plugins:maven-site-plugin

    Status There is at least one newer minor version available. Minor updates are sometimes passive.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-site-plugin
    Current Version2.3
    Newer versions3.0-beta-1 Next Minor
    3.0-beta-2
    3.0-beta-3 Latest Minor

    Plugin org.apache.maven.plugins:maven-source-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-source-plugin
    Current Version2.1.2

    Plugin org.apache.maven.plugins:maven-surefire-plugin

    Status No newer versions available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-surefire-plugin
    Current Version2.9

    Plugin org.apache.maven.plugins:maven-war-plugin

    Status There is at least one newer version available.
    Group Idorg.apache.maven.plugins
    Artifact Idmaven-war-plugin
    Current Version2.1-alpha-2
    Newer versions2.1-beta-1 Next Version
    2.1
    2.1.1 Next Incremental

    Plugin org.codehaus.mojo:findbugs-maven-plugin

    Status No newer versions available.
    Group Idorg.codehaus.mojo
    Artifact Idfindbugs-maven-plugin
    Current Version2.3.2

    Plugin org.codehaus.mojo:taglist-maven-plugin

    Status No newer versions available.
    Group Idorg.codehaus.mojo
    Artifact Idtaglist-maven-plugin
    Current Version2.4

    Plugin org.codehaus.mojo:versions-maven-plugin

    Status No newer versions available.
    Group Idorg.codehaus.mojo
    Artifact Idversions-maven-plugin
    Current Version1.2
    diff --git a/pmd.html b/pmd.html index f393b7e..9b750ae 100644 --- a/pmd.html +++ b/pmd.html @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -49,8 +49,8 @@
    - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation diff --git a/pmd.xml b/pmd.xml index 3c1bf7e..a59c1cd 100644 --- a/pmd.xml +++ b/pmd.xml @@ -1,3 +1,3 @@ - + \ No newline at end of file diff --git a/project-info.html b/project-info.html index 61763bd..339d20f 100644 --- a/project-info.html +++ b/project-info.html @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -49,8 +49,8 @@
    • - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation diff --git a/project-reports.html b/project-reports.html index d3563e9..7698826 100644 --- a/project-reports.html +++ b/project-reports.html @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -49,8 +49,8 @@
    • - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation diff --git a/project-summary.html b/project-summary.html index e3f6189..49b6b9f 100644 --- a/project-summary.html +++ b/project-summary.html @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -49,8 +49,8 @@
    • - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation @@ -143,7 +146,7 @@
    • -

    Project Summary

    Project Information

    FieldValue
    NameRunDeck API - Java Client
    DescriptionJava client for the RunDeck REST API
    Homepagehttp://vbehar.github.com/rundeck-api-java-client

    Project Organization

    This project does not belong to an organization.

    Build Information

    FieldValue
    GroupIdorg.rundeck
    ArtifactIdrundeck-api-java-client
    Version1.1
    Typejar
    JDK Rev1.6
    +

    Project Summary

    Project Information

    FieldValue
    NameRunDeck API - Java Client
    DescriptionJava client for the RunDeck REST API
    Homepagehttp://vbehar.github.com/rundeck-api-java-client

    Project Organization

    This project does not belong to an organization.

    Build Information

    FieldValue
    GroupIdorg.rundeck
    ArtifactIdrundeck-api-java-client
    Version1.2
    Typejar
    JDK Rev1.6
    diff --git a/property-updates-report.html b/property-updates-report.html index 03079ff..706f49d 100644 --- a/property-updates-report.html +++ b/property-updates-report.html @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -49,8 +49,8 @@
    - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation @@ -149,7 +152,7 @@
    • -

    Overview

    This report summarizes newer versions that may be available for your project's various properties associated with artifacts.

    # of properties using the latest version available24
    # of properties where the next version available is smaller than an incremental version update0
    # of properties where the next version available is an incremental version update0
    # of properties where the next version available is a minor version update1
    # of properties where the next version available is a major version update0

    Summary of properties sssociated with artifact versions

    StatusPropertyCurrent VersionNext VersionNext IncrementalNext MinorNext Major
    ${plugin.findbugs.version}2.3.2
    ${plugin.clean.version}2.4.1
    ${plugin.enforcer.version}1.0.1
    ${plugin.install.version}2.3.1
    ${plugin.release.version}2.2
    ${plugin.resources.version}2.5
    ${plugin.assembly.version}2.2.1
    ${plugin.antrun.version}1.6
    ${plugin.site.version}2.33.0-beta-1
    ${plugin.versions.version}1.2
    ${plugin.project-info-reports.version}2.4
    ${plugin.javadoc.version}2.8
    ${plugin.taglist.version}2.4
    ${plugin.eclipse.version}2.8
    ${plugin.help.version}2.1.1
    ${plugin.source.version}2.1.2
    ${plugin.surefire.version}2.9
    ${plugin.compiler.version}2.3.2
    ${plugin.pmd.version}2.5
    ${plugin.jxr.version}2.3
    ${plugin.checkstyle.version}2.6
    ${plugin.changes.version}2.6
    ${plugin.deploy.version}2.6
    ${plugin.dependency.version}2.3
    ${plugin.jar.version}2.3.1
    StatusPropertyCurrent VersionNext VersionNext IncrementalNext MinorNext Major

    Properties sssociated with artifact versions

    ${plugin.antrun.version}

    Status No newer versions available.
    Property${plugin.antrun.version}
    Associated artifactsorg.apache.maven.plugins:maven-antrun-plugin
    Current Version1.6
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.assembly.version}

    Status No newer versions available.
    Property${plugin.assembly.version}
    Associated artifactsorg.apache.maven.plugins:maven-assembly-plugin
    Current Version2.2.1
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.changes.version}

    Status No newer versions available.
    Property${plugin.changes.version}
    Associated artifactsorg.apache.maven.plugins:maven-changes-plugin
    Current Version2.6
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.checkstyle.version}

    Status No newer versions available.
    Property${plugin.checkstyle.version}
    Associated artifactsorg.apache.maven.plugins:maven-checkstyle-plugin
    Current Version2.6
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.clean.version}

    Status No newer versions available.
    Property${plugin.clean.version}
    Associated artifactsorg.apache.maven.plugins:maven-clean-plugin
    Current Version2.4.1
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.compiler.version}

    Status No newer versions available.
    Property${plugin.compiler.version}
    Associated artifactsorg.apache.maven.plugins:maven-compiler-plugin
    Current Version2.3.2
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.dependency.version}

    Status No newer versions available.
    Property${plugin.dependency.version}
    Associated artifactsorg.apache.maven.plugins:maven-dependency-plugin
    Current Version2.3
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.deploy.version}

    Status No newer versions available.
    Property${plugin.deploy.version}
    Associated artifactsorg.apache.maven.plugins:maven-deploy-plugin
    Current Version2.6
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.eclipse.version}

    Status No newer versions available.
    Property${plugin.eclipse.version}
    Associated artifactsorg.apache.maven.plugins:maven-eclipse-plugin
    Current Version2.8
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.enforcer.version}

    Status No newer versions available.
    Property${plugin.enforcer.version}
    Associated artifactsorg.apache.maven.plugins:maven-enforcer-plugin
    Current Version1.0.1
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.findbugs.version}

    Status No newer versions available.
    Property${plugin.findbugs.version}
    Associated artifactsorg.codehaus.mojo:findbugs-maven-plugin
    Current Version2.3.2
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.help.version}

    Status No newer versions available.
    Property${plugin.help.version}
    Associated artifactsorg.apache.maven.plugins:maven-help-plugin
    Current Version2.1.1
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.install.version}

    Status No newer versions available.
    Property${plugin.install.version}
    Associated artifactsorg.apache.maven.plugins:maven-install-plugin
    Current Version2.3.1
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.jar.version}

    Status No newer versions available.
    Property${plugin.jar.version}
    Associated artifactsorg.apache.maven.plugins:maven-jar-plugin
    Current Version2.3.1
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.javadoc.version}

    Status No newer versions available.
    Property${plugin.javadoc.version}
    Associated artifactsorg.apache.maven.plugins:maven-javadoc-plugin
    Current Version2.8
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.jxr.version}

    Status No newer versions available.
    Property${plugin.jxr.version}
    Associated artifactsorg.apache.maven.plugins:maven-jxr-plugin
    Current Version2.3
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.pmd.version}

    Status No newer versions available.
    Property${plugin.pmd.version}
    Associated artifactsorg.apache.maven.plugins:maven-pmd-plugin
    Current Version2.5
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.project-info-reports.version}

    Status No newer versions available.
    Property${plugin.project-info-reports.version}
    Associated artifactsorg.apache.maven.plugins:maven-project-info-reports-plugin
    Current Version2.4
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.release.version}

    Status No newer versions available.
    Property${plugin.release.version}
    Associated artifactsorg.apache.maven.plugins:maven-release-plugin
    Current Version2.2
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.resources.version}

    Status No newer versions available.
    Property${plugin.resources.version}
    Associated artifactsorg.apache.maven.plugins:maven-resources-plugin
    Current Version2.5
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.site.version}

    Status There is at least one newer minor version available. Minor updates are sometimes passive.
    Property${plugin.site.version}
    Associated artifactsorg.apache.maven.plugins:maven-site-plugin
    Current Version2.3
    Newer versions3.0-beta-1 Next Minor
    3.0-beta-2
    3.0-beta-3 Latest Minor
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.source.version}

    Status No newer versions available.
    Property${plugin.source.version}
    Associated artifactsorg.apache.maven.plugins:maven-source-plugin
    Current Version2.1.2
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.surefire.version}

    Status No newer versions available.
    Property${plugin.surefire.version}
    Associated artifactsorg.apache.maven.plugins:maven-surefire-plugin
    Current Version2.9
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.taglist.version}

    Status No newer versions available.
    Property${plugin.taglist.version}
    Associated artifactsorg.codehaus.mojo:taglist-maven-plugin
    Current Version2.4
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.versions.version}

    Status No newer versions available.
    Property${plugin.versions.version}
    Associated artifactsorg.codehaus.mojo:versions-maven-plugin
    Current Version1.2
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes
    +

    Overview

    This report summarizes newer versions that may be available for your project's various properties associated with artifacts.

    # of properties using the latest version available25
    # of properties where the next version available is smaller than an incremental version update0
    # of properties where the next version available is an incremental version update0
    # of properties where the next version available is a minor version update1
    # of properties where the next version available is a major version update0

    Summary of properties sssociated with artifact versions

    StatusPropertyCurrent VersionNext VersionNext IncrementalNext MinorNext Major
    ${plugin.findbugs.version}2.3.2
    ${plugin.clean.version}2.4.1
    ${plugin.enforcer.version}1.0.1
    ${plugin.install.version}2.3.1
    ${plugin.release.version}2.2
    ${plugin.resources.version}2.5
    ${plugin.assembly.version}2.2.1
    ${plugin.antrun.version}1.6
    ${plugin.site.version}2.33.0-beta-1
    ${plugin.versions.version}1.2
    ${plugin.project-info-reports.version}2.4
    ${plugin.javadoc.version}2.8
    ${plugin.taglist.version}2.4
    ${plugin.eclipse.version}2.8
    ${plugin.help.version}2.1.1
    ${plugin.source.version}2.1.2
    ${plugin.surefire.version}2.9
    ${plugin.compiler.version}2.3.2
    ${plugin.pmd.version}2.5
    ${plugin.jxr.version}2.3
    ${plugin.gpg.version}1.3
    ${plugin.checkstyle.version}2.6
    ${plugin.changes.version}2.6
    ${plugin.deploy.version}2.6
    ${plugin.dependency.version}2.3
    ${plugin.jar.version}2.3.1
    StatusPropertyCurrent VersionNext VersionNext IncrementalNext MinorNext Major

    Properties sssociated with artifact versions

    ${plugin.antrun.version}

    Status No newer versions available.
    Property${plugin.antrun.version}
    Associated artifactsorg.apache.maven.plugins:maven-antrun-plugin
    Current Version1.6
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.assembly.version}

    Status No newer versions available.
    Property${plugin.assembly.version}
    Associated artifactsorg.apache.maven.plugins:maven-assembly-plugin
    Current Version2.2.1
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.changes.version}

    Status No newer versions available.
    Property${plugin.changes.version}
    Associated artifactsorg.apache.maven.plugins:maven-changes-plugin
    Current Version2.6
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.checkstyle.version}

    Status No newer versions available.
    Property${plugin.checkstyle.version}
    Associated artifactsorg.apache.maven.plugins:maven-checkstyle-plugin
    Current Version2.6
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.clean.version}

    Status No newer versions available.
    Property${plugin.clean.version}
    Associated artifactsorg.apache.maven.plugins:maven-clean-plugin
    Current Version2.4.1
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.compiler.version}

    Status No newer versions available.
    Property${plugin.compiler.version}
    Associated artifactsorg.apache.maven.plugins:maven-compiler-plugin
    Current Version2.3.2
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.dependency.version}

    Status No newer versions available.
    Property${plugin.dependency.version}
    Associated artifactsorg.apache.maven.plugins:maven-dependency-plugin
    Current Version2.3
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.deploy.version}

    Status No newer versions available.
    Property${plugin.deploy.version}
    Associated artifactsorg.apache.maven.plugins:maven-deploy-plugin
    Current Version2.6
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.eclipse.version}

    Status No newer versions available.
    Property${plugin.eclipse.version}
    Associated artifactsorg.apache.maven.plugins:maven-eclipse-plugin
    Current Version2.8
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.enforcer.version}

    Status No newer versions available.
    Property${plugin.enforcer.version}
    Associated artifactsorg.apache.maven.plugins:maven-enforcer-plugin
    Current Version1.0.1
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.findbugs.version}

    Status No newer versions available.
    Property${plugin.findbugs.version}
    Associated artifactsorg.codehaus.mojo:findbugs-maven-plugin
    Current Version2.3.2
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.gpg.version}

    Status No newer versions available.
    Property${plugin.gpg.version}
    Associated artifactsorg.apache.maven.plugins:maven-gpg-plugin
    Current Version1.3
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.help.version}

    Status No newer versions available.
    Property${plugin.help.version}
    Associated artifactsorg.apache.maven.plugins:maven-help-plugin
    Current Version2.1.1
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.install.version}

    Status No newer versions available.
    Property${plugin.install.version}
    Associated artifactsorg.apache.maven.plugins:maven-install-plugin
    Current Version2.3.1
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.jar.version}

    Status No newer versions available.
    Property${plugin.jar.version}
    Associated artifactsorg.apache.maven.plugins:maven-jar-plugin
    Current Version2.3.1
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.javadoc.version}

    Status No newer versions available.
    Property${plugin.javadoc.version}
    Associated artifactsorg.apache.maven.plugins:maven-javadoc-plugin
    Current Version2.8
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.jxr.version}

    Status No newer versions available.
    Property${plugin.jxr.version}
    Associated artifactsorg.apache.maven.plugins:maven-jxr-plugin
    Current Version2.3
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.pmd.version}

    Status No newer versions available.
    Property${plugin.pmd.version}
    Associated artifactsorg.apache.maven.plugins:maven-pmd-plugin
    Current Version2.5
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.project-info-reports.version}

    Status No newer versions available.
    Property${plugin.project-info-reports.version}
    Associated artifactsorg.apache.maven.plugins:maven-project-info-reports-plugin
    Current Version2.4
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.release.version}

    Status No newer versions available.
    Property${plugin.release.version}
    Associated artifactsorg.apache.maven.plugins:maven-release-plugin
    Current Version2.2
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.resources.version}

    Status No newer versions available.
    Property${plugin.resources.version}
    Associated artifactsorg.apache.maven.plugins:maven-resources-plugin
    Current Version2.5
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.site.version}

    Status There is at least one newer minor version available. Minor updates are sometimes passive.
    Property${plugin.site.version}
    Associated artifactsorg.apache.maven.plugins:maven-site-plugin
    Current Version2.3
    Newer versions3.0-beta-1 Next Minor
    3.0-beta-2
    3.0-beta-3 Latest Minor
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.source.version}

    Status No newer versions available.
    Property${plugin.source.version}
    Associated artifactsorg.apache.maven.plugins:maven-source-plugin
    Current Version2.1.2
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.surefire.version}

    Status No newer versions available.
    Property${plugin.surefire.version}
    Associated artifactsorg.apache.maven.plugins:maven-surefire-plugin
    Current Version2.9
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.taglist.version}

    Status No newer versions available.
    Property${plugin.taglist.version}
    Associated artifactsorg.codehaus.mojo:taglist-maven-plugin
    Current Version2.4
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes

    ${plugin.versions.version}

    Status No newer versions available.
    Property${plugin.versions.version}
    Associated artifactsorg.codehaus.mojo:versions-maven-plugin
    Current Version1.2
    Allowed version range[,)
    Infer associations from projectYes
    Only use release versionsNo
    Include projects from reactorYes
    Always use reactor projects (even if older or -SNAPSHOT)Yes
    diff --git a/scripting.html b/scripting.html index 50eaae0..b95c842 100644 --- a/scripting.html +++ b/scripting.html @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -49,8 +49,8 @@
    - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation diff --git a/source-repository.html b/source-repository.html index b35e6b1..6f039d1 100644 --- a/source-repository.html +++ b/source-repository.html @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -49,8 +49,8 @@
    • - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation diff --git a/status.html b/status.html index 289720b..cc470f2 100644 --- a/status.html +++ b/status.html @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -49,8 +49,8 @@
    • - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation @@ -111,7 +114,7 @@
    • -

    Status of the implementation of the RunDeck API

    RunDeck API version 1

    Documentation of the RunDeck API version 1

    • Login-based authentication - OK
    • System Info - OK
    • Listing Jobs - OK
    • Running a Job - OK
    • Exporting Jobs - OK
    • Importing Jobs - OK
    • Getting a Job Definition - OK
    • Deleting a Job Definition - OK
    • Getting Executions for a Job - OK
    • Listing Running Executions - OK
    • Getting Execution Info - OK
    • Aborting Executions - OK
    • Running Adhoc Commands - OK
    • Running Adhoc Scripts - TODO
    • Listing Projects - OK
    • Getting Project Info - OK
    • Listing History - TODO
    • Creating History Event Reports - TODO
    • Listing Resources - OK
    • Getting Resource Info - OK
    +

    Status of the implementation of the RunDeck API

    RunDeck API version 1

    Documentation of the RunDeck API version 1

    • Login-based authentication - OK
    • System Info - OK
    • Listing Jobs - OK
    • Running a Job - OK
    • Exporting Jobs - OK
    • Importing Jobs - OK
    • Getting a Job Definition - OK
    • Deleting a Job Definition - OK
    • Getting Executions for a Job - OK
    • Listing Running Executions - OK
    • Getting Execution Info - OK
    • Aborting Executions - OK
    • Running Adhoc Commands - OK
    • Running Adhoc Scripts - OK
    • Listing Projects - OK
    • Getting Project Info - OK
    • Listing History - OK
    • Creating History Event Reports - TODO
    • Listing Resources - OK
    • Getting Resource Info - OK
    diff --git a/taglist.html b/taglist.html index b20a008..31116db 100644 --- a/taglist.html +++ b/taglist.html @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -49,8 +49,8 @@
    - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation diff --git a/team-list.html b/team-list.html index 8fdfa6b..daecbd4 100644 --- a/team-list.html +++ b/team-list.html @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ @import url("./css/site.css"); - + @@ -49,8 +49,8 @@
    • - Last Published: 2011-07-28 -  | Version: 1.1 + Last Published: 2011-07-31 +  | Version: 1.2
    @@ -73,6 +73,9 @@
  • Download +
    • +
  • + Changelog
  • API Documentation diff --git a/testapidocs/allclasses-frame.html b/testapidocs/allclasses-frame.html index 0e3a088..9303b0a 100644 --- a/testapidocs/allclasses-frame.html +++ b/testapidocs/allclasses-frame.html @@ -2,13 +2,13 @@ - + -All Classes (RunDeck API - Java Client 1.1 Test API) +All Classes (RunDeck API - Java Client 1.2 Test API) - + @@ -24,8 +24,12 @@ All Classes (RunDeck API - Java Client 1.1 Test API) AbortParserTest
    +EventParserTest +
    ExecutionParserTest
    +HistoryParserTest +
    JobParserTest
    JobsImportResultParserTest diff --git a/testapidocs/allclasses-noframe.html b/testapidocs/allclasses-noframe.html index 0a67890..cd3b051 100644 --- a/testapidocs/allclasses-noframe.html +++ b/testapidocs/allclasses-noframe.html @@ -2,13 +2,13 @@ - + -All Classes (RunDeck API - Java Client 1.1 Test API) +All Classes (RunDeck API - Java Client 1.2 Test API) - + @@ -24,8 +24,12 @@ All Classes (RunDeck API - Java Client 1.1 Test API) AbortParserTest
    +EventParserTest +
    ExecutionParserTest
    +HistoryParserTest +
    JobParserTest
    JobsImportResultParserTest diff --git a/testapidocs/constant-values.html b/testapidocs/constant-values.html index 0aefe36..97f8912 100644 --- a/testapidocs/constant-values.html +++ b/testapidocs/constant-values.html @@ -2,13 +2,13 @@ - + -Constant Field Values (RunDeck API - Java Client 1.1 Test API) +Constant Field Values (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ Constant Field Values (RunDeck API - Java Client 1.1 Test API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Constant Field Values (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="Constant Field Values (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/deprecated-list.html b/testapidocs/deprecated-list.html index ddd29aa..f6c9ce8 100644 --- a/testapidocs/deprecated-list.html +++ b/testapidocs/deprecated-list.html @@ -2,13 +2,13 @@ - + -Deprecated List (RunDeck API - Java Client 1.1 Test API) +Deprecated List (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ Deprecated List (RunDeck API - Java Client 1.1 Test API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Deprecated List (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="Deprecated List (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/help-doc.html b/testapidocs/help-doc.html index fcc0c7c..dc9ba39 100644 --- a/testapidocs/help-doc.html +++ b/testapidocs/help-doc.html @@ -2,13 +2,13 @@ - + -API Help (RunDeck API - Java Client 1.1 Test API) +API Help (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ API Help (RunDeck API - Java Client 1.1 Test API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="API Help (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="API Help (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/index-all.html b/testapidocs/index-all.html index 551da31..61587b9 100644 --- a/testapidocs/index-all.html +++ b/testapidocs/index-all.html @@ -2,13 +2,13 @@ - + -Index (RunDeck API - Java Client 1.1 Test API) +Index (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ Index (RunDeck API - Java Client 1.1 Test API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Index (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="Index (RunDeck API - Java Client 1.2 Test API)"; } } @@ -79,7 +79,7 @@ function windowTitle() -A E G J L N O P S
    +A E G H J L N O P S

    A

    @@ -91,6 +91,9 @@ Constructor for class org.rundeck.api.parser.

    E

    +
    EventParserTest - Class in org.rundeck.api.parser
    Test the EventParser
    EventParserTest() - +Constructor for class org.rundeck.api.parser.EventParserTest +
     
    ExecutionParserTest - Class in org.rundeck.api.parser
    Test the ExecutionParser
    ExecutionParserTest() - Constructor for class org.rundeck.api.parser.ExecutionParserTest
      @@ -107,6 +110,14 @@ Method in class org.rundeck.api.util.

    +H

    +
    +
    HistoryParserTest - Class in org.rundeck.api.parser
    Test the HistoryParser
    HistoryParserTest() - +Constructor for class org.rundeck.api.parser.HistoryParserTest +
      +
    +

    J

    @@ -154,6 +165,9 @@ Constructor for class org.rundeck.api.parser.ParametersUtilTest - Class in org.rundeck.api.util
    Test the ParametersUtil
    ParametersUtilTest() - Constructor for class org.rundeck.api.util.ParametersUtilTest
      +
    parseAdhocEvent() - +Method in class org.rundeck.api.parser.EventParserTest +
     
    parseAdhocExecution() - Method in class org.rundeck.api.parser.ExecutionParserTest
      @@ -163,6 +177,9 @@ Method in class org.rundeck.api.parser.parseFailedAbort() - Method in class org.rundeck.api.parser.AbortParserTest
      +
    parseHistory() - +Method in class org.rundeck.api.parser.HistoryParserTest +
     
    parseJob() - Method in class org.rundeck.api.parser.JobParserTest
      @@ -202,6 +219,9 @@ Constructor for class org.rundeck.api.parser.parseRunningExecution() - Method in class org.rundeck.api.parser.ExecutionParserTest
      +
    parseSucceededEvent() - +Method in class org.rundeck.api.parser.EventParserTest +
     
    parseSucceededExecution() - Method in class org.rundeck.api.parser.ExecutionParserTest
      @@ -221,7 +241,7 @@ Constructor for class org.rundeck.api.parser.A E G J L N O P S +A E G H J L N O P S diff --git a/testapidocs/index.html b/testapidocs/index.html index 2c8267d..520fd35 100644 --- a/testapidocs/index.html +++ b/testapidocs/index.html @@ -2,10 +2,10 @@ - + -RunDeck API - Java Client 1.1 Test API +RunDeck API - Java Client 1.2 Test API @@ -57,7 +57,7 @@ function windowTitle()  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO FRAMES   @@ -252,7 +252,7 @@ public void parseFailedAbort()  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO FRAMES   diff --git a/testapidocs/org/rundeck/api/parser/EventParserTest.html b/testapidocs/org/rundeck/api/parser/EventParserTest.html new file mode 100644 index 0000000..3d99ade --- /dev/null +++ b/testapidocs/org/rundeck/api/parser/EventParserTest.html @@ -0,0 +1,286 @@ + + + + + + + +EventParserTest (RunDeck API - Java Client 1.2 Test API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.rundeck.api.parser +
    +Class EventParserTest

    +
    +java.lang.Object
+  extended by org.rundeck.api.parser.EventParserTest
+
    +
    +
    +
    public class EventParserTest
    extends Object
    + + +

    +Test the EventParser +

    + +

    +

    +
    Author:
    +
    Vincent Behar
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    EventParserTest() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + voidparseAdhocEvent() + +
    +           
    + voidparseSucceededEvent() + +
    +           
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +EventParserTest

    +
    +public EventParserTest()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +parseSucceededEvent

    +
    +public void parseSucceededEvent()
+                         throws Exception
    +
    +
    + +
    Throws: +
    Exception
    +
    +
    +
    + +

    +parseAdhocEvent

    +
    +public void parseAdhocEvent()
+                     throws Exception
    +
    +
    + +
    Throws: +
    Exception
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2011. All Rights Reserved. + + diff --git a/testapidocs/org/rundeck/api/parser/ExecutionParserTest.html b/testapidocs/org/rundeck/api/parser/ExecutionParserTest.html index 19879ae..7713cb1 100644 --- a/testapidocs/org/rundeck/api/parser/ExecutionParserTest.html +++ b/testapidocs/org/rundeck/api/parser/ExecutionParserTest.html @@ -2,13 +2,13 @@ - + -ExecutionParserTest (RunDeck API - Java Client 1.1 Test API) +ExecutionParserTest (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ ExecutionParserTest (RunDeck API - Java Client 1.1 Test API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="ExecutionParserTest (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="ExecutionParserTest (RunDeck API - Java Client 1.2 Test API)"; } } @@ -56,8 +56,8 @@ function windowTitle() - PREV CLASS  - NEXT CLASS + PREV CLASS  + NEXT CLASS     FRAMES    NO FRAMES   @@ -295,8 +295,8 @@ public void parseMinimalistExecution() - PREV CLASS  - NEXT CLASS + PREV CLASS  + NEXT CLASS FRAMES    NO FRAMES   diff --git a/testapidocs/org/rundeck/api/parser/HistoryParserTest.html b/testapidocs/org/rundeck/api/parser/HistoryParserTest.html new file mode 100644 index 0000000..f89c6a8 --- /dev/null +++ b/testapidocs/org/rundeck/api/parser/HistoryParserTest.html @@ -0,0 +1,264 @@ + + + + + + + +HistoryParserTest (RunDeck API - Java Client 1.2 Test API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.rundeck.api.parser +
    +Class HistoryParserTest

    +
    +java.lang.Object
+  extended by org.rundeck.api.parser.HistoryParserTest
+
    +
    +
    +
    public class HistoryParserTest
    extends Object
    + + +

    +Test the HistoryParser +

    + +

    +

    +
    Author:
    +
    Vincent Behar
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    HistoryParserTest() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + voidparseHistory() + +
    +           
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +HistoryParserTest

    +
    +public HistoryParserTest()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +parseHistory

    +
    +public void parseHistory()
+                  throws Exception
    +
    +
    + +
    Throws: +
    Exception
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2011. All Rights Reserved. + + diff --git a/testapidocs/org/rundeck/api/parser/JobParserTest.html b/testapidocs/org/rundeck/api/parser/JobParserTest.html index 39cfc5b..48cd312 100644 --- a/testapidocs/org/rundeck/api/parser/JobParserTest.html +++ b/testapidocs/org/rundeck/api/parser/JobParserTest.html @@ -2,13 +2,13 @@ - + -JobParserTest (RunDeck API - Java Client 1.1 Test API) +JobParserTest (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ JobParserTest (RunDeck API - Java Client 1.1 Test API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="JobParserTest (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="JobParserTest (RunDeck API - Java Client 1.2 Test API)"; } } @@ -56,7 +56,7 @@ function windowTitle() - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   @@ -229,7 +229,7 @@ public void parseJob() - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   diff --git a/testapidocs/org/rundeck/api/parser/JobsImportResultParserTest.html b/testapidocs/org/rundeck/api/parser/JobsImportResultParserTest.html index 48439eb..b58aa19 100644 --- a/testapidocs/org/rundeck/api/parser/JobsImportResultParserTest.html +++ b/testapidocs/org/rundeck/api/parser/JobsImportResultParserTest.html @@ -2,13 +2,13 @@ - + -JobsImportResultParserTest (RunDeck API - Java Client 1.1 Test API) +JobsImportResultParserTest (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ JobsImportResultParserTest (RunDeck API - Java Client 1.1 Test API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="JobsImportResultParserTest (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="JobsImportResultParserTest (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/org/rundeck/api/parser/ListParserTest.html b/testapidocs/org/rundeck/api/parser/ListParserTest.html index f5f16a1..1ec1dd8 100644 --- a/testapidocs/org/rundeck/api/parser/ListParserTest.html +++ b/testapidocs/org/rundeck/api/parser/ListParserTest.html @@ -2,13 +2,13 @@ - + -ListParserTest (RunDeck API - Java Client 1.1 Test API) +ListParserTest (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ ListParserTest (RunDeck API - Java Client 1.1 Test API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="ListParserTest (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="ListParserTest (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/org/rundeck/api/parser/NodeParserTest.html b/testapidocs/org/rundeck/api/parser/NodeParserTest.html index 2159826..6ae3e72 100644 --- a/testapidocs/org/rundeck/api/parser/NodeParserTest.html +++ b/testapidocs/org/rundeck/api/parser/NodeParserTest.html @@ -2,13 +2,13 @@ - + -NodeParserTest (RunDeck API - Java Client 1.1 Test API) +NodeParserTest (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ NodeParserTest (RunDeck API - Java Client 1.1 Test API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="NodeParserTest (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="NodeParserTest (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/org/rundeck/api/parser/ParserHelperTest.html b/testapidocs/org/rundeck/api/parser/ParserHelperTest.html index 9378d97..5f33e52 100644 --- a/testapidocs/org/rundeck/api/parser/ParserHelperTest.html +++ b/testapidocs/org/rundeck/api/parser/ParserHelperTest.html @@ -2,13 +2,13 @@ - + -ParserHelperTest (RunDeck API - Java Client 1.1 Test API) +ParserHelperTest (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ ParserHelperTest (RunDeck API - Java Client 1.1 Test API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="ParserHelperTest (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="ParserHelperTest (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/org/rundeck/api/parser/ProjectParserTest.html b/testapidocs/org/rundeck/api/parser/ProjectParserTest.html index 8934b73..c20eb5a 100644 --- a/testapidocs/org/rundeck/api/parser/ProjectParserTest.html +++ b/testapidocs/org/rundeck/api/parser/ProjectParserTest.html @@ -2,13 +2,13 @@ - + -ProjectParserTest (RunDeck API - Java Client 1.1 Test API) +ProjectParserTest (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ ProjectParserTest (RunDeck API - Java Client 1.1 Test API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="ProjectParserTest (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="ProjectParserTest (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/org/rundeck/api/parser/StringParserTest.html b/testapidocs/org/rundeck/api/parser/StringParserTest.html index b971ffe..6c7dc23 100644 --- a/testapidocs/org/rundeck/api/parser/StringParserTest.html +++ b/testapidocs/org/rundeck/api/parser/StringParserTest.html @@ -2,13 +2,13 @@ - + -StringParserTest (RunDeck API - Java Client 1.1 Test API) +StringParserTest (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ StringParserTest (RunDeck API - Java Client 1.1 Test API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="StringParserTest (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="StringParserTest (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/org/rundeck/api/parser/SystemInfoParserTest.html b/testapidocs/org/rundeck/api/parser/SystemInfoParserTest.html index a67e8c4..e8418cc 100644 --- a/testapidocs/org/rundeck/api/parser/SystemInfoParserTest.html +++ b/testapidocs/org/rundeck/api/parser/SystemInfoParserTest.html @@ -2,13 +2,13 @@ - + -SystemInfoParserTest (RunDeck API - Java Client 1.1 Test API) +SystemInfoParserTest (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ SystemInfoParserTest (RunDeck API - Java Client 1.1 Test API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SystemInfoParserTest (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="SystemInfoParserTest (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/org/rundeck/api/parser/class-use/AbortParserTest.html b/testapidocs/org/rundeck/api/parser/class-use/AbortParserTest.html index 3945012..07c85ed 100644 --- a/testapidocs/org/rundeck/api/parser/class-use/AbortParserTest.html +++ b/testapidocs/org/rundeck/api/parser/class-use/AbortParserTest.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.parser.AbortParserTest (RunDeck API - Java Client 1.1 Test API) +Uses of Class org.rundeck.api.parser.AbortParserTest (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.parser.AbortParserTest (RunDeck API - Java Client function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.parser.AbortParserTest (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="Uses of Class org.rundeck.api.parser.AbortParserTest (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/org/rundeck/api/parser/class-use/EventParserTest.html b/testapidocs/org/rundeck/api/parser/class-use/EventParserTest.html new file mode 100644 index 0000000..093835f --- /dev/null +++ b/testapidocs/org/rundeck/api/parser/class-use/EventParserTest.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.rundeck.api.parser.EventParserTest (RunDeck API - Java Client 1.2 Test API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.rundeck.api.parser.EventParserTest

    +
    +No usage of org.rundeck.api.parser.EventParserTest +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2011. All Rights Reserved. + + diff --git a/testapidocs/org/rundeck/api/parser/class-use/ExecutionParserTest.html b/testapidocs/org/rundeck/api/parser/class-use/ExecutionParserTest.html index 35e555e..96d57bd 100644 --- a/testapidocs/org/rundeck/api/parser/class-use/ExecutionParserTest.html +++ b/testapidocs/org/rundeck/api/parser/class-use/ExecutionParserTest.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.parser.ExecutionParserTest (RunDeck API - Java Client 1.1 Test API) +Uses of Class org.rundeck.api.parser.ExecutionParserTest (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.parser.ExecutionParserTest (RunDeck API - Java Cli function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.parser.ExecutionParserTest (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="Uses of Class org.rundeck.api.parser.ExecutionParserTest (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/org/rundeck/api/parser/class-use/HistoryParserTest.html b/testapidocs/org/rundeck/api/parser/class-use/HistoryParserTest.html new file mode 100644 index 0000000..f7d084f --- /dev/null +++ b/testapidocs/org/rundeck/api/parser/class-use/HistoryParserTest.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.rundeck.api.parser.HistoryParserTest (RunDeck API - Java Client 1.2 Test API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.rundeck.api.parser.HistoryParserTest

    +
    +No usage of org.rundeck.api.parser.HistoryParserTest +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2011. All Rights Reserved. + + diff --git a/testapidocs/org/rundeck/api/parser/class-use/JobParserTest.html b/testapidocs/org/rundeck/api/parser/class-use/JobParserTest.html index fa008f7..90570bf 100644 --- a/testapidocs/org/rundeck/api/parser/class-use/JobParserTest.html +++ b/testapidocs/org/rundeck/api/parser/class-use/JobParserTest.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.parser.JobParserTest (RunDeck API - Java Client 1.1 Test API) +Uses of Class org.rundeck.api.parser.JobParserTest (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.parser.JobParserTest (RunDeck API - Java Client 1. function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.parser.JobParserTest (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="Uses of Class org.rundeck.api.parser.JobParserTest (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/org/rundeck/api/parser/class-use/JobsImportResultParserTest.html b/testapidocs/org/rundeck/api/parser/class-use/JobsImportResultParserTest.html index a47c5ff..41b19d0 100644 --- a/testapidocs/org/rundeck/api/parser/class-use/JobsImportResultParserTest.html +++ b/testapidocs/org/rundeck/api/parser/class-use/JobsImportResultParserTest.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.parser.JobsImportResultParserTest (RunDeck API - Java Client 1.1 Test API) +Uses of Class org.rundeck.api.parser.JobsImportResultParserTest (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.parser.JobsImportResultParserTest (RunDeck API - J function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.parser.JobsImportResultParserTest (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="Uses of Class org.rundeck.api.parser.JobsImportResultParserTest (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/org/rundeck/api/parser/class-use/ListParserTest.html b/testapidocs/org/rundeck/api/parser/class-use/ListParserTest.html index 4897573..d429172 100644 --- a/testapidocs/org/rundeck/api/parser/class-use/ListParserTest.html +++ b/testapidocs/org/rundeck/api/parser/class-use/ListParserTest.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.parser.ListParserTest (RunDeck API - Java Client 1.1 Test API) +Uses of Class org.rundeck.api.parser.ListParserTest (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.parser.ListParserTest (RunDeck API - Java Client 1 function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.parser.ListParserTest (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="Uses of Class org.rundeck.api.parser.ListParserTest (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/org/rundeck/api/parser/class-use/NodeParserTest.html b/testapidocs/org/rundeck/api/parser/class-use/NodeParserTest.html index d284475..053d6ad 100644 --- a/testapidocs/org/rundeck/api/parser/class-use/NodeParserTest.html +++ b/testapidocs/org/rundeck/api/parser/class-use/NodeParserTest.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.parser.NodeParserTest (RunDeck API - Java Client 1.1 Test API) +Uses of Class org.rundeck.api.parser.NodeParserTest (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.parser.NodeParserTest (RunDeck API - Java Client 1 function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.parser.NodeParserTest (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="Uses of Class org.rundeck.api.parser.NodeParserTest (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/org/rundeck/api/parser/class-use/ParserHelperTest.html b/testapidocs/org/rundeck/api/parser/class-use/ParserHelperTest.html index 5b9be2b..a39b9e9 100644 --- a/testapidocs/org/rundeck/api/parser/class-use/ParserHelperTest.html +++ b/testapidocs/org/rundeck/api/parser/class-use/ParserHelperTest.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.parser.ParserHelperTest (RunDeck API - Java Client 1.1 Test API) +Uses of Class org.rundeck.api.parser.ParserHelperTest (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.parser.ParserHelperTest (RunDeck API - Java Client function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.parser.ParserHelperTest (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="Uses of Class org.rundeck.api.parser.ParserHelperTest (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/org/rundeck/api/parser/class-use/ProjectParserTest.html b/testapidocs/org/rundeck/api/parser/class-use/ProjectParserTest.html index ea5a309..c8a6757 100644 --- a/testapidocs/org/rundeck/api/parser/class-use/ProjectParserTest.html +++ b/testapidocs/org/rundeck/api/parser/class-use/ProjectParserTest.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.parser.ProjectParserTest (RunDeck API - Java Client 1.1 Test API) +Uses of Class org.rundeck.api.parser.ProjectParserTest (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.parser.ProjectParserTest (RunDeck API - Java Clien function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.parser.ProjectParserTest (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="Uses of Class org.rundeck.api.parser.ProjectParserTest (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/org/rundeck/api/parser/class-use/StringParserTest.html b/testapidocs/org/rundeck/api/parser/class-use/StringParserTest.html index ccafa1f..7869766 100644 --- a/testapidocs/org/rundeck/api/parser/class-use/StringParserTest.html +++ b/testapidocs/org/rundeck/api/parser/class-use/StringParserTest.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.parser.StringParserTest (RunDeck API - Java Client 1.1 Test API) +Uses of Class org.rundeck.api.parser.StringParserTest (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.parser.StringParserTest (RunDeck API - Java Client function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.parser.StringParserTest (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="Uses of Class org.rundeck.api.parser.StringParserTest (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/org/rundeck/api/parser/class-use/SystemInfoParserTest.html b/testapidocs/org/rundeck/api/parser/class-use/SystemInfoParserTest.html index c2219ad..bcbc2dc 100644 --- a/testapidocs/org/rundeck/api/parser/class-use/SystemInfoParserTest.html +++ b/testapidocs/org/rundeck/api/parser/class-use/SystemInfoParserTest.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.parser.SystemInfoParserTest (RunDeck API - Java Client 1.1 Test API) +Uses of Class org.rundeck.api.parser.SystemInfoParserTest (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.parser.SystemInfoParserTest (RunDeck API - Java Cl function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.parser.SystemInfoParserTest (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="Uses of Class org.rundeck.api.parser.SystemInfoParserTest (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/org/rundeck/api/parser/package-frame.html b/testapidocs/org/rundeck/api/parser/package-frame.html index 545feeb..304db20 100644 --- a/testapidocs/org/rundeck/api/parser/package-frame.html +++ b/testapidocs/org/rundeck/api/parser/package-frame.html @@ -2,13 +2,13 @@ - + -org.rundeck.api.parser (RunDeck API - Java Client 1.1 Test API) +org.rundeck.api.parser (RunDeck API - Java Client 1.2 Test API) - + @@ -26,8 +26,12 @@ Classes     
    AbortParserTest
    +EventParserTest +
    ExecutionParserTest
    +HistoryParserTest +
    JobParserTest
    JobsImportResultParserTest diff --git a/testapidocs/org/rundeck/api/parser/package-summary.html b/testapidocs/org/rundeck/api/parser/package-summary.html index 5c8c22b..2a87ffb 100644 --- a/testapidocs/org/rundeck/api/parser/package-summary.html +++ b/testapidocs/org/rundeck/api/parser/package-summary.html @@ -2,13 +2,13 @@ - + -org.rundeck.api.parser (RunDeck API - Java Client 1.1 Test API) +org.rundeck.api.parser (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ org.rundeck.api.parser (RunDeck API - Java Client 1.1 Test API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.rundeck.api.parser (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="org.rundeck.api.parser (RunDeck API - Java Client 1.2 Test API)"; } } @@ -94,10 +94,18 @@ Package org.rundeck.api.parser Test the AbortParser +EventParserTest +Test the EventParser + + ExecutionParserTest Test the ExecutionParser +HistoryParserTest +Test the HistoryParser + + JobParserTest Test the JobParser diff --git a/testapidocs/org/rundeck/api/parser/package-tree.html b/testapidocs/org/rundeck/api/parser/package-tree.html index 77489eb..554ed35 100644 --- a/testapidocs/org/rundeck/api/parser/package-tree.html +++ b/testapidocs/org/rundeck/api/parser/package-tree.html @@ -2,13 +2,13 @@ - + -org.rundeck.api.parser Class Hierarchy (RunDeck API - Java Client 1.1 Test API) +org.rundeck.api.parser Class Hierarchy (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ org.rundeck.api.parser Class Hierarchy (RunDeck API - Java Client 1.1 Test API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.rundeck.api.parser Class Hierarchy (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="org.rundeck.api.parser Class Hierarchy (RunDeck API - Java Client 1.2 Test API)"; } } @@ -93,7 +93,7 @@ Class Hierarchy
    diff --git a/testapidocs/org/rundeck/api/parser/package-use.html b/testapidocs/org/rundeck/api/parser/package-use.html index d02a906..494089e 100644 --- a/testapidocs/org/rundeck/api/parser/package-use.html +++ b/testapidocs/org/rundeck/api/parser/package-use.html @@ -2,13 +2,13 @@ - + -Uses of Package org.rundeck.api.parser (RunDeck API - Java Client 1.1 Test API) +Uses of Package org.rundeck.api.parser (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ Uses of Package org.rundeck.api.parser (RunDeck API - Java Client 1.1 Test API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Package org.rundeck.api.parser (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="Uses of Package org.rundeck.api.parser (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/org/rundeck/api/util/ParametersUtilTest.html b/testapidocs/org/rundeck/api/util/ParametersUtilTest.html index ac4b1ab..04328b5 100644 --- a/testapidocs/org/rundeck/api/util/ParametersUtilTest.html +++ b/testapidocs/org/rundeck/api/util/ParametersUtilTest.html @@ -2,13 +2,13 @@ - + -ParametersUtilTest (RunDeck API - Java Client 1.1 Test API) +ParametersUtilTest (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ ParametersUtilTest (RunDeck API - Java Client 1.1 Test API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="ParametersUtilTest (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="ParametersUtilTest (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/org/rundeck/api/util/class-use/ParametersUtilTest.html b/testapidocs/org/rundeck/api/util/class-use/ParametersUtilTest.html index 9f2d1ad..3358535 100644 --- a/testapidocs/org/rundeck/api/util/class-use/ParametersUtilTest.html +++ b/testapidocs/org/rundeck/api/util/class-use/ParametersUtilTest.html @@ -2,13 +2,13 @@ - + -Uses of Class org.rundeck.api.util.ParametersUtilTest (RunDeck API - Java Client 1.1 Test API) +Uses of Class org.rundeck.api.util.ParametersUtilTest (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ Uses of Class org.rundeck.api.util.ParametersUtilTest (RunDeck API - Java Client function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.rundeck.api.util.ParametersUtilTest (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="Uses of Class org.rundeck.api.util.ParametersUtilTest (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/org/rundeck/api/util/package-frame.html b/testapidocs/org/rundeck/api/util/package-frame.html index 32f0a75..2755c8c 100644 --- a/testapidocs/org/rundeck/api/util/package-frame.html +++ b/testapidocs/org/rundeck/api/util/package-frame.html @@ -2,13 +2,13 @@ - + -org.rundeck.api.util (RunDeck API - Java Client 1.1 Test API) +org.rundeck.api.util (RunDeck API - Java Client 1.2 Test API) - + diff --git a/testapidocs/org/rundeck/api/util/package-summary.html b/testapidocs/org/rundeck/api/util/package-summary.html index 02040d2..a96bddd 100644 --- a/testapidocs/org/rundeck/api/util/package-summary.html +++ b/testapidocs/org/rundeck/api/util/package-summary.html @@ -2,13 +2,13 @@ - + -org.rundeck.api.util (RunDeck API - Java Client 1.1 Test API) +org.rundeck.api.util (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ org.rundeck.api.util (RunDeck API - Java Client 1.1 Test API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.rundeck.api.util (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="org.rundeck.api.util (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/org/rundeck/api/util/package-tree.html b/testapidocs/org/rundeck/api/util/package-tree.html index f82698f..3bab216 100644 --- a/testapidocs/org/rundeck/api/util/package-tree.html +++ b/testapidocs/org/rundeck/api/util/package-tree.html @@ -2,13 +2,13 @@ - + -org.rundeck.api.util Class Hierarchy (RunDeck API - Java Client 1.1 Test API) +org.rundeck.api.util Class Hierarchy (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ org.rundeck.api.util Class Hierarchy (RunDeck API - Java Client 1.1 Test API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.rundeck.api.util Class Hierarchy (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="org.rundeck.api.util Class Hierarchy (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/org/rundeck/api/util/package-use.html b/testapidocs/org/rundeck/api/util/package-use.html index 77ba535..5cc35dd 100644 --- a/testapidocs/org/rundeck/api/util/package-use.html +++ b/testapidocs/org/rundeck/api/util/package-use.html @@ -2,13 +2,13 @@ - + -Uses of Package org.rundeck.api.util (RunDeck API - Java Client 1.1 Test API) +Uses of Package org.rundeck.api.util (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ Uses of Package org.rundeck.api.util (RunDeck API - Java Client 1.1 Test API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Package org.rundeck.api.util (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="Uses of Package org.rundeck.api.util (RunDeck API - Java Client 1.2 Test API)"; } } diff --git a/testapidocs/overview-frame.html b/testapidocs/overview-frame.html index 987bdb5..bc6407f 100644 --- a/testapidocs/overview-frame.html +++ b/testapidocs/overview-frame.html @@ -2,13 +2,13 @@ - + -Overview List (RunDeck API - Java Client 1.1 Test API) +Overview List (RunDeck API - Java Client 1.2 Test API) - + diff --git a/testapidocs/overview-summary.html b/testapidocs/overview-summary.html index d4be57a..7648518 100644 --- a/testapidocs/overview-summary.html +++ b/testapidocs/overview-summary.html @@ -2,13 +2,13 @@ - + -Overview (RunDeck API - Java Client 1.1 Test API) +Overview (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ Overview (RunDeck API - Java Client 1.1 Test API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Overview (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="Overview (RunDeck API - Java Client 1.2 Test API)"; } } @@ -82,7 +82,7 @@ function windowTitle()

    -RunDeck API - Java Client 1.1 Test API +RunDeck API - Java Client 1.2 Test API

    diff --git a/testapidocs/overview-tree.html b/testapidocs/overview-tree.html index ebc3762..9df766d 100644 --- a/testapidocs/overview-tree.html +++ b/testapidocs/overview-tree.html @@ -2,13 +2,13 @@ - + -Class Hierarchy (RunDeck API - Java Client 1.1 Test API) +Class Hierarchy (RunDeck API - Java Client 1.2 Test API) - + @@ -16,7 +16,7 @@ Class Hierarchy (RunDeck API - Java Client 1.1 Test API) function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Class Hierarchy (RunDeck API - Java Client 1.1 Test API)"; + parent.document.title="Class Hierarchy (RunDeck API - Java Client 1.2 Test API)"; } } @@ -92,7 +92,7 @@ Class Hierarchy
    diff --git a/xref-test/allclasses-frame.html b/xref-test/allclasses-frame.html index 8ac7674..a88c930 100644 --- a/xref-test/allclasses-frame.html +++ b/xref-test/allclasses-frame.html @@ -13,9 +13,15 @@
    • AbortParserTest +
      • +
    • + EventParserTest
    • ExecutionParserTest +
      • +
    • + HistoryParserTest
    • JobParserTest diff --git a/xref-test/index.html b/xref-test/index.html index a8de5d6..fdd3988 100644 --- a/xref-test/index.html +++ b/xref-test/index.html @@ -3,7 +3,7 @@ - RunDeck API - Java Client 1.1 Reference + RunDeck API - Java Client 1.2 Reference diff --git a/xref-test/org/rundeck/api/parser/EventParserTest.html b/xref-test/org/rundeck/api/parser/EventParserTest.html new file mode 100644 index 0000000..21024ab --- /dev/null +++ b/xref-test/org/rundeck/api/parser/EventParserTest.html @@ -0,0 +1,91 @@ + + + + +EventParserTest xref + + + +
      +
+1   /*
+2    * Copyright 2011 Vincent Behar
+3    *
+4    * Licensed under the Apache License, Version 2.0 (the "License");
+5    * you may not use this file except in compliance with the License.
+6    * You may obtain a copy of the License at
+7    *
+8    *     http://www.apache.org/licenses/LICENSE-2.0
+9    *
+10   * Unless required by applicable law or agreed to in writing, software
+11   * distributed under the License is distributed on an "AS IS" BASIS,
+12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+13   * See the License for the specific language governing permissions and
+14   * limitations under the License.
+15   */
+16  package org.rundeck.api.parser;
+17  
+18  import java.io.InputStream;
+19  import java.util.Date;
+20  import org.dom4j.Document;
+21  import org.junit.Assert;
+22  import org.junit.Test;
+23  import org.rundeck.api.domain.RundeckEvent;
+24  import org.rundeck.api.domain.RundeckEvent.EventStatus;
+25  
+26  /**
+27   * Test the {@link EventParser}
+28   * 
+29   * @author Vincent Behar
+30   */
+31  public class EventParserTest {
+32  
+33      @Test
+34      public void parseSucceededEvent() throws Exception {
+35          InputStream input = getClass().getResourceAsStream("event-succeeded.xml");
+36          Document document = ParserHelper.loadDocument(input);
+37  
+38          RundeckEvent event = new EventParser("event").parseXmlNode(document);
+39  
+40          Assert.assertFalse(event.isAdhoc());
+41          Assert.assertEquals("job-name", event.getTitle());
+42          Assert.assertEquals(EventStatus.SUCCEEDED, event.getStatus());
+43          Assert.assertEquals("ps", event.getSummary());
+44          Assert.assertEquals(2, event.getNodeSummary().getSucceeded());
+45          Assert.assertEquals(0, event.getNodeSummary().getFailed());
+46          Assert.assertEquals(2, event.getNodeSummary().getTotal());
+47          Assert.assertEquals("admin", event.getUser());
+48          Assert.assertEquals("test", event.getProject());
+49          Assert.assertEquals(new Date(1311946495646L), event.getStartedAt());
+50          Assert.assertEquals(new Date(1311946557618L), event.getEndedAt());
+51          Assert.assertEquals("1", event.getJobId());
+52          Assert.assertEquals(new Long(2), event.getExecutionId());
+53      }
+54  
+55      @Test
+56      public void parseAdhocEvent() throws Exception {
+57          InputStream input = getClass().getResourceAsStream("event-adhoc.xml");
+58          Document document = ParserHelper.loadDocument(input);
+59  
+60          RundeckEvent event = new EventParser("event").parseXmlNode(document);
+61  
+62          Assert.assertTrue(event.isAdhoc());
+63          Assert.assertEquals("adhoc", event.getTitle());
+64          Assert.assertEquals(EventStatus.FAILED, event.getStatus());
+65          Assert.assertEquals("ls $HOME", event.getSummary());
+66          Assert.assertEquals(1, event.getNodeSummary().getSucceeded());
+67          Assert.assertEquals(1, event.getNodeSummary().getFailed());
+68          Assert.assertEquals(2, event.getNodeSummary().getTotal());
+69          Assert.assertEquals("admin", event.getUser());
+70          Assert.assertEquals("test", event.getProject());
+71          Assert.assertEquals(new Date(1311945953547L), event.getStartedAt());
+72          Assert.assertEquals(new Date(1311945963467L), event.getEndedAt());
+73          Assert.assertEquals(null, event.getJobId());
+74          Assert.assertEquals(new Long(1), event.getExecutionId());
+75      }
+76  
+77  }
+
      +
      + + diff --git a/xref-test/org/rundeck/api/parser/HistoryParserTest.html b/xref-test/org/rundeck/api/parser/HistoryParserTest.html new file mode 100644 index 0000000..6b93ab4 --- /dev/null +++ b/xref-test/org/rundeck/api/parser/HistoryParserTest.html @@ -0,0 +1,92 @@ + + + + +HistoryParserTest xref + + + +
      +
+1   /*
+2    * Copyright 2011 Vincent Behar
+3    *
+4    * Licensed under the Apache License, Version 2.0 (the "License");
+5    * you may not use this file except in compliance with the License.
+6    * You may obtain a copy of the License at
+7    *
+8    *     http://www.apache.org/licenses/LICENSE-2.0
+9    *
+10   * Unless required by applicable law or agreed to in writing, software
+11   * distributed under the License is distributed on an "AS IS" BASIS,
+12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+13   * See the License for the specific language governing permissions and
+14   * limitations under the License.
+15   */
+16  package org.rundeck.api.parser;
+17  
+18  import java.io.InputStream;
+19  import java.util.Date;
+20  import org.dom4j.Document;
+21  import org.junit.Assert;
+22  import org.junit.Test;
+23  import org.rundeck.api.domain.RundeckEvent;
+24  import org.rundeck.api.domain.RundeckHistory;
+25  import org.rundeck.api.domain.RundeckEvent.EventStatus;
+26  
+27  /**
+28   * Test the {@link HistoryParser}
+29   * 
+30   * @author Vincent Behar
+31   */
+32  public class HistoryParserTest {
+33  
+34      @Test
+35      public void parseHistory() throws Exception {
+36          InputStream input = getClass().getResourceAsStream("history.xml");
+37          Document document = ParserHelper.loadDocument(input);
+38  
+39          RundeckHistory history = new HistoryParser("result/events").parseXmlNode(document);
+40  
+41          Assert.assertEquals(2, history.getCount());
+42          Assert.assertEquals(4, history.getTotal());
+43          Assert.assertEquals(2, history.getMax());
+44          Assert.assertEquals(0, history.getOffset());
+45          Assert.assertEquals(2, history.getEvents().size());
+46  
+47          RundeckEvent event1 = history.getEvents().get(0);
+48          Assert.assertFalse(event1.isAdhoc());
+49          Assert.assertEquals("job-name", event1.getTitle());
+50          Assert.assertEquals(EventStatus.SUCCEEDED, event1.getStatus());
+51          Assert.assertEquals("ps", event1.getSummary());
+52          Assert.assertEquals(2, event1.getNodeSummary().getSucceeded());
+53          Assert.assertEquals(0, event1.getNodeSummary().getFailed());
+54          Assert.assertEquals(2, event1.getNodeSummary().getTotal());
+55          Assert.assertEquals("admin", event1.getUser());
+56          Assert.assertEquals("test", event1.getProject());
+57          Assert.assertEquals(new Date(1311946495646L), event1.getStartedAt());
+58          Assert.assertEquals(new Date(1311946557618L), event1.getEndedAt());
+59          Assert.assertEquals("1", event1.getJobId());
+60          Assert.assertEquals(new Long(2), event1.getExecutionId());
+61  
+62          RundeckEvent event2 = history.getEvents().get(1);
+63          Assert.assertTrue(event2.isAdhoc());
+64          Assert.assertEquals("adhoc", event2.getTitle());
+65          Assert.assertEquals(EventStatus.FAILED, event2.getStatus());
+66          Assert.assertEquals("ls $HOME", event2.getSummary());
+67          Assert.assertEquals(1, event2.getNodeSummary().getSucceeded());
+68          Assert.assertEquals(1, event2.getNodeSummary().getFailed());
+69          Assert.assertEquals(2, event2.getNodeSummary().getTotal());
+70          Assert.assertEquals("admin", event2.getUser());
+71          Assert.assertEquals("test", event2.getProject());
+72          Assert.assertEquals(new Date(1311945953547L), event2.getStartedAt());
+73          Assert.assertEquals(new Date(1311945963467L), event2.getEndedAt());
+74          Assert.assertEquals(null, event2.getJobId());
+75          Assert.assertEquals(new Long(1), event2.getExecutionId());
+76      }
+77  
+78  }
+
      +
      + + diff --git a/xref-test/org/rundeck/api/parser/package-frame.html b/xref-test/org/rundeck/api/parser/package-frame.html index bfb2f72..91ddd4e 100644 --- a/xref-test/org/rundeck/api/parser/package-frame.html +++ b/xref-test/org/rundeck/api/parser/package-frame.html @@ -3,7 +3,7 @@ - RunDeck API - Java Client 1.1 Reference Package org.rundeck.api.parser + RunDeck API - Java Client 1.2 Reference Package org.rundeck.api.parser @@ -17,9 +17,15 @@
      • AbortParserTest +
        • +
      • + EventParserTest
      • ExecutionParserTest +
        • +
      • + HistoryParserTest
      • JobParserTest diff --git a/xref-test/org/rundeck/api/parser/package-summary.html b/xref-test/org/rundeck/api/parser/package-summary.html index 7cc4ccd..1b26250 100644 --- a/xref-test/org/rundeck/api/parser/package-summary.html +++ b/xref-test/org/rundeck/api/parser/package-summary.html @@ -3,7 +3,7 @@ - RunDeck API - Java Client 1.1 Reference Package org.rundeck.api.parser + RunDeck API - Java Client 1.2 Reference Package org.rundeck.api.parser @@ -39,11 +39,21 @@ AbortParserTest + + + + EventParserTest + ExecutionParserTest + + + + HistoryParserTest + diff --git a/xref-test/org/rundeck/api/util/package-frame.html b/xref-test/org/rundeck/api/util/package-frame.html index 3e1f43b..1ba144f 100644 --- a/xref-test/org/rundeck/api/util/package-frame.html +++ b/xref-test/org/rundeck/api/util/package-frame.html @@ -3,7 +3,7 @@ - RunDeck API - Java Client 1.1 Reference Package org.rundeck.api.util + RunDeck API - Java Client 1.2 Reference Package org.rundeck.api.util diff --git a/xref-test/org/rundeck/api/util/package-summary.html b/xref-test/org/rundeck/api/util/package-summary.html index b0d5404..e98f890 100644 --- a/xref-test/org/rundeck/api/util/package-summary.html +++ b/xref-test/org/rundeck/api/util/package-summary.html @@ -3,7 +3,7 @@ - RunDeck API - Java Client 1.1 Reference Package org.rundeck.api.util + RunDeck API - Java Client 1.2 Reference Package org.rundeck.api.util diff --git a/xref-test/overview-frame.html b/xref-test/overview-frame.html index 2eb28d9..09d5b9f 100644 --- a/xref-test/overview-frame.html +++ b/xref-test/overview-frame.html @@ -3,7 +3,7 @@ - RunDeck API - Java Client 1.1 Reference + RunDeck API - Java Client 1.2 Reference diff --git a/xref-test/overview-summary.html b/xref-test/overview-summary.html index dd0f7e2..fd5cfb5 100644 --- a/xref-test/overview-summary.html +++ b/xref-test/overview-summary.html @@ -3,7 +3,7 @@ - RunDeck API - Java Client 1.1 Reference + RunDeck API - Java Client 1.2 Reference @@ -24,7 +24,7 @@
    • -

    RunDeck API - Java Client 1.1 Reference

    +

    RunDeck API - Java Client 1.2 Reference

    diff --git a/xref/allclasses-frame.html b/xref/allclasses-frame.html index e890bac..625ef8f 100644 --- a/xref/allclasses-frame.html +++ b/xref/allclasses-frame.html @@ -25,6 +25,12 @@
  • AssertUtil +
    • +
  • + EventParser +
    • +
  • + EventStatus
  • ExecutionParser @@ -34,6 +40,9 @@
  • FileType +
    • +
  • + HistoryParser
  • JobParser @@ -49,6 +58,9 @@
  • NodeParser +
    • +
  • + NodeSummary
  • OptionsBuilder @@ -73,9 +85,15 @@
  • RundeckClient +
    • +
  • + RundeckEvent
  • RundeckExecution +
    • +
  • + RundeckHistory
  • RundeckJob diff --git a/xref/index.html b/xref/index.html index a8de5d6..fdd3988 100644 --- a/xref/index.html +++ b/xref/index.html @@ -3,7 +3,7 @@ - RunDeck API - Java Client 1.1 Reference + RunDeck API - Java Client 1.2 Reference diff --git a/xref/org/rundeck/api/ApiPathBuilder.html b/xref/org/rundeck/api/ApiPathBuilder.html index 5fcdb12..fe3ab3d 100644 --- a/xref/org/rundeck/api/ApiPathBuilder.html +++ b/xref/org/rundeck/api/ApiPathBuilder.html @@ -26,191 +26,207 @@ 16 package org.rundeck.api; 17 18 import java.io.InputStream; -19 import java.util.HashMap; -20 import java.util.Map; -21 import java.util.Properties; -22 import org.apache.commons.lang.StringUtils; -23 import org.rundeck.api.util.ParametersUtil; -24 -25 /** -26 * Builder for API paths -27 * -28 * @author Vincent Behar -29 */ -30 class ApiPathBuilder { -31 -32 /** Internally, we store everything in a {@link StringBuilder} */ -33 private final StringBuilder apiPath; -34 -35 /** When POSTing, we can add attachments */ -36 private final Map<String, InputStream> attachments; -37 -38 /** Marker for using the right separator between parameters ("?" or "&") */ -39 private boolean firstParamDone = false; -40 -41 /** -42 * Build a new instance, for the given "path" (the "path" is the part before the parameters. The path and the -43 * parameters are separated by a "?") -44 * -45 * @param paths elements of the path -46 */ -47 public ApiPathBuilder(String... paths) { -48 apiPath = new StringBuilder(); -49 attachments = new HashMap<String, InputStream>(); -50 if (paths != null) { -51 for (String path : paths) { -52 if (StringUtils.isNotBlank(path)) { -53 append(path); -54 } -55 } -56 } -57 } -58 -59 /** -60 * Append the given parameter (key and value). This will only append the parameter if it is not blank (null, empty -61 * or whitespace), and make sure to add the right separator ("?" or "&") before. The key and value will be separated -62 * by the "=" character. Also, the value will be url-encoded. -63 * -64 * @param key of the parameter. Must not be null or empty -65 * @param value of the parameter. May be null/empty/blank. Will be url-encoded. -66 * @return this, for method chaining -67 */ -68 public ApiPathBuilder param(String key, String value) { -69 if (StringUtils.isNotBlank(value)) { -70 appendSeparator(); -71 append(key); -72 append("="); -73 append(ParametersUtil.urlEncode(value)); -74 } -75 return this; -76 } -77 -78 /** -79 * Append the given parameter (key and value). This will only append the parameter if it is not null, and make sure -80 * to add the right separator ("?" or "&") before. The key and value will be separated by the "=" character. Also, -81 * the value will be converted to lower-case. -82 * -83 * @param key of the parameter. Must not be null or empty -84 * @param value of the parameter. May be null -85 * @return this, for method chaining -86 */ -87 public ApiPathBuilder param(String key, Enum<?> value) { -88 if (value != null) { -89 param(key, StringUtils.lowerCase(value.toString())); -90 } -91 return this; -92 } -93 -94 /** -95 * Append the given parameter (key and value). This will only append the parameter if it is not null, and make sure -96 * to add the right separator ("?" or "&") before. The key and value will be separated by the "=" character. -97 * -98 * @param key of the parameter. Must not be null or empty -99 * @param value of the parameter. May be null -100 * @return this, for method chaining -101 */ -102 public ApiPathBuilder param(String key, Long value) { -103 if (value != null) { -104 param(key, value.toString()); -105 } -106 return this; -107 } -108 -109 /** -110 * Append the given parameter (key and value). This will only append the parameter if it is not null, and make sure -111 * to add the right separator ("?" or "&") before. The key and value will be separated by the "=" character. -112 * -113 * @param key of the parameter. Must not be null or empty -114 * @param value of the parameter. May be null -115 * @return this, for method chaining -116 */ -117 public ApiPathBuilder param(String key, Integer value) { -118 if (value != null) { -119 param(key, value.toString()); -120 } -121 return this; -122 } -123 -124 /** -125 * Append the given parameter (key and value). This will only append the parameter if it is not null, and make sure -126 * to add the right separator ("?" or "&") before. The key and value will be separated by the "=" character. -127 * -128 * @param key of the parameter. Must not be null or empty -129 * @param value of the parameter. May be null -130 * @return this, for method chaining -131 */ -132 public ApiPathBuilder param(String key, Boolean value) { -133 if (value != null) { -134 param(key, value.toString()); -135 } -136 return this; -137 } -138 -139 /** -140 * Append the given node filters, only if it is not null/empty -141 * -142 * @param nodeFilters may be null/empty -143 * @return this, for method chaining -144 * @see ParametersUtil#generateNodeFiltersString(Properties) -145 */ -146 public ApiPathBuilder nodeFilters(Properties nodeFilters) { -147 String filters = ParametersUtil.generateNodeFiltersString(nodeFilters); -148 if (StringUtils.isNotBlank(filters)) { -149 appendSeparator(); -150 append(filters); +19 import java.util.Date; +20 import java.util.HashMap; +21 import java.util.Map; +22 import java.util.Properties; +23 import org.apache.commons.lang.StringUtils; +24 import org.rundeck.api.util.ParametersUtil; +25 +26 /** +27 * Builder for API paths +28 * +29 * @author Vincent Behar +30 */ +31 class ApiPathBuilder { +32 +33 /** Internally, we store everything in a {@link StringBuilder} */ +34 private final StringBuilder apiPath; +35 +36 /** When POSTing, we can add attachments */ +37 private final Map<String, InputStream> attachments; +38 +39 /** Marker for using the right separator between parameters ("?" or "&") */ +40 private boolean firstParamDone = false; +41 +42 /** +43 * Build a new instance, for the given "path" (the "path" is the part before the parameters. The path and the +44 * parameters are separated by a "?") +45 * +46 * @param paths elements of the path +47 */ +48 public ApiPathBuilder(String... paths) { +49 apiPath = new StringBuilder(); +50 attachments = new HashMap<String, InputStream>(); +51 if (paths != null) { +52 for (String path : paths) { +53 if (StringUtils.isNotBlank(path)) { +54 append(path); +55 } +56 } +57 } +58 } +59 +60 /** +61 * Append the given parameter (key and value). This will only append the parameter if it is not blank (null, empty +62 * or whitespace), and make sure to add the right separator ("?" or "&") before. The key and value will be separated +63 * by the "=" character. Also, the value will be url-encoded. +64 * +65 * @param key of the parameter. Must not be null or empty +66 * @param value of the parameter. May be null/empty/blank. Will be url-encoded. +67 * @return this, for method chaining +68 */ +69 public ApiPathBuilder param(String key, String value) { +70 if (StringUtils.isNotBlank(value)) { +71 appendSeparator(); +72 append(key); +73 append("="); +74 append(ParametersUtil.urlEncode(value)); +75 } +76 return this; +77 } +78 +79 /** +80 * Append the given parameter (key and value). This will only append the parameter if it is not null, and make sure +81 * to add the right separator ("?" or "&") before. The key and value will be separated by the "=" character. Also, +82 * the value will be converted to lower-case. +83 * +84 * @param key of the parameter. Must not be null or empty +85 * @param value of the parameter. May be null +86 * @return this, for method chaining +87 */ +88 public ApiPathBuilder param(String key, Enum<?> value) { +89 if (value != null) { +90 param(key, StringUtils.lowerCase(value.toString())); +91 } +92 return this; +93 } +94 +95 /** +96 * Append the given parameter (key and value). This will only append the parameter if it is not null, and make sure +97 * to add the right separator ("?" or "&") before. The key and value will be separated by the "=" character. +98 * +99 * @param key of the parameter. Must not be null or empty +100 * @param value of the parameter. May be null +101 * @return this, for method chaining +102 */ +103 public ApiPathBuilder param(String key, Date value) { +104 if (value != null) { +105 param(key, value.getTime()); +106 } +107 return this; +108 } +109 +110 /** +111 * Append the given parameter (key and value). This will only append the parameter if it is not null, and make sure +112 * to add the right separator ("?" or "&") before. The key and value will be separated by the "=" character. +113 * +114 * @param key of the parameter. Must not be null or empty +115 * @param value of the parameter. May be null +116 * @return this, for method chaining +117 */ +118 public ApiPathBuilder param(String key, Long value) { +119 if (value != null) { +120 param(key, value.toString()); +121 } +122 return this; +123 } +124 +125 /** +126 * Append the given parameter (key and value). This will only append the parameter if it is not null, and make sure +127 * to add the right separator ("?" or "&") before. The key and value will be separated by the "=" character. +128 * +129 * @param key of the parameter. Must not be null or empty +130 * @param value of the parameter. May be null +131 * @return this, for method chaining +132 */ +133 public ApiPathBuilder param(String key, Integer value) { +134 if (value != null) { +135 param(key, value.toString()); +136 } +137 return this; +138 } +139 +140 /** +141 * Append the given parameter (key and value). This will only append the parameter if it is not null, and make sure +142 * to add the right separator ("?" or "&") before. The key and value will be separated by the "=" character. +143 * +144 * @param key of the parameter. Must not be null or empty +145 * @param value of the parameter. May be null +146 * @return this, for method chaining +147 */ +148 public ApiPathBuilder param(String key, Boolean value) { +149 if (value != null) { +150 param(key, value.toString()); 151 } 152 return this; 153 } 154 155 /** -156 * When POSTing a request, add the given {@link InputStream} as an attachment to the content of the request. This -157 * will only add the stream if it is not null. -158 * -159 * @param name of the attachment. Must not be null or empty -160 * @param stream. May be null -161 * @return this, for method chaining -162 */ -163 public ApiPathBuilder attach(String name, InputStream stream) { -164 if (stream != null) { -165 attachments.put(name, stream); -166 } -167 return this; -168 } -169 -170 /** -171 * @return all attachments to be POSTed, with their names -172 */ -173 public Map<String, InputStream> getAttachments() { -174 return attachments; -175 } -176 -177 @Override -178 public String toString() { -179 return apiPath.toString(); -180 } -181 -182 /** -183 * Append the given string -184 * -185 * @param str to append -186 */ -187 private void append(String str) { -188 apiPath.append(str); -189 } -190 -191 /** -192 * Append the right separator "?" or "&" between 2 parameters -193 */ -194 private void appendSeparator() { -195 if (firstParamDone) { -196 append("&"); -197 } else { -198 append("?"); -199 firstParamDone = true; -200 } -201 } -202 -203 } +156 * Append the given node filters, only if it is not null/empty +157 * +158 * @param nodeFilters may be null/empty +159 * @return this, for method chaining +160 * @see ParametersUtil#generateNodeFiltersString(Properties) +161 */ +162 public ApiPathBuilder nodeFilters(Properties nodeFilters) { +163 String filters = ParametersUtil.generateNodeFiltersString(nodeFilters); +164 if (StringUtils.isNotBlank(filters)) { +165 appendSeparator(); +166 append(filters); +167 } +168 return this; +169 } +170 +171 /** +172 * When POSTing a request, add the given {@link InputStream} as an attachment to the content of the request. This +173 * will only add the stream if it is not null. +174 * +175 * @param name of the attachment. Must not be null or empty +176 * @param stream. May be null +177 * @return this, for method chaining +178 */ +179 public ApiPathBuilder attach(String name, InputStream stream) { +180 if (stream != null) { +181 attachments.put(name, stream); +182 } +183 return this; +184 } +185 +186 /** +187 * @return all attachments to be POSTed, with their names +188 */ +189 public Map<String, InputStream> getAttachments() { +190 return attachments; +191 } +192 +193 @Override +194 public String toString() { +195 return apiPath.toString(); +196 } +197 +198 /** +199 * Append the given string +200 * +201 * @param str to append +202 */ +203 private void append(String str) { +204 apiPath.append(str); +205 } +206 +207 /** +208 * Append the right separator "?" or "&" between 2 parameters +209 */ +210 private void appendSeparator() { +211 if (firstParamDone) { +212 append("&"); +213 } else { +214 append("?"); +215 firstParamDone = true; +216 } +217 } +218 +219 }
    diff --git a/xref/org/rundeck/api/RundeckClient.html b/xref/org/rundeck/api/RundeckClient.html index a0369a3..eee41de 100644 --- a/xref/org/rundeck/api/RundeckClient.html +++ b/xref/org/rundeck/api/RundeckClient.html @@ -31,1378 +31,2215 @@ 21 import java.io.InputStream; 22 import java.io.Serializable; 23 import java.util.ArrayList; -24 import java.util.List; -25 import java.util.Properties; -26 import java.util.concurrent.TimeUnit; -27 import org.apache.commons.io.FileUtils; -28 import org.apache.commons.io.IOUtils; -29 import org.apache.commons.lang.StringUtils; -30 import org.rundeck.api.RundeckApiException.RundeckApiLoginException; -31 import org.rundeck.api.domain.RundeckAbort; -32 import org.rundeck.api.domain.RundeckExecution; -33 import org.rundeck.api.domain.RundeckJob; -34 import org.rundeck.api.domain.RundeckJobsImportMethod; -35 import org.rundeck.api.domain.RundeckJobsImportResult; -36 import org.rundeck.api.domain.RundeckNode; -37 import org.rundeck.api.domain.RundeckProject; -38 import org.rundeck.api.domain.RundeckSystemInfo; -39 import org.rundeck.api.domain.RundeckExecution.ExecutionStatus; -40 import org.rundeck.api.parser.AbortParser; -41 import org.rundeck.api.parser.ExecutionParser; -42 import org.rundeck.api.parser.JobParser; -43 import org.rundeck.api.parser.JobsImportResultParser; -44 import org.rundeck.api.parser.ListParser; -45 import org.rundeck.api.parser.NodeParser; -46 import org.rundeck.api.parser.ProjectParser; -47 import org.rundeck.api.parser.StringParser; -48 import org.rundeck.api.parser.SystemInfoParser; -49 import org.rundeck.api.util.AssertUtil; -50 import org.rundeck.api.util.ParametersUtil; -51 -52 /** -53 * Main entry point to talk to a RunDeck instance.<br> -54 * Usage : <br> -55 * <code> -56 * <pre> -57 * RundeckClient rundeck = new RundeckClient("http://localhost:4440", "admin", "admin"); -58 * -59 * List&lt;RundeckProject&gt; projects = rundeck.getProjects(); -60 * -61 * RundeckJob job = rundeck.findJob("my-project", "main-group/sub-group", "job-name"); -62 * RundeckExecution execution = rundeck.triggerJob(job.getId(), -63 * new OptionsBuilder().addOption("version", "1.2.0").toProperties()); -64 * -65 * List&lt;RundeckExecution&gt; runningExecutions = rundeck.getRunningExecutions("my-project"); -66 * -67 * rundeck.exportJobsToFile("/tmp/jobs.xml", FileType.XML, "my-project"); -68 * rundeck.importJobs("/tmp/jobs.xml", FileType.XML); -69 * </pre> -70 * </code> -71 * -72 * @author Vincent Behar -73 */ -74 public class RundeckClient implements Serializable { -75 -76 private static final long serialVersionUID = 1L; -77 -78 public static final transient int API_VERSION = 1; -79 -80 public static final transient String API_ENDPOINT = "/api/" + API_VERSION; -81 -82 private final String url; +24 import java.util.Date; +25 import java.util.List; +26 import java.util.Properties; +27 import java.util.concurrent.TimeUnit; +28 import org.apache.commons.io.FileUtils; +29 import org.apache.commons.io.IOUtils; +30 import org.apache.commons.lang.StringUtils; +31 import org.rundeck.api.RundeckApiException.RundeckApiLoginException; +32 import org.rundeck.api.domain.RundeckAbort; +33 import org.rundeck.api.domain.RundeckExecution; +34 import org.rundeck.api.domain.RundeckExecution.ExecutionStatus; +35 import org.rundeck.api.domain.RundeckHistory; +36 import org.rundeck.api.domain.RundeckJob; +37 import org.rundeck.api.domain.RundeckJobsImportMethod; +38 import org.rundeck.api.domain.RundeckJobsImportResult; +39 import org.rundeck.api.domain.RundeckNode; +40 import org.rundeck.api.domain.RundeckProject; +41 import org.rundeck.api.domain.RundeckSystemInfo; +42 import org.rundeck.api.parser.AbortParser; +43 import org.rundeck.api.parser.ExecutionParser; +44 import org.rundeck.api.parser.HistoryParser; +45 import org.rundeck.api.parser.JobParser; +46 import org.rundeck.api.parser.JobsImportResultParser; +47 import org.rundeck.api.parser.ListParser; +48 import org.rundeck.api.parser.NodeParser; +49 import org.rundeck.api.parser.ProjectParser; +50 import org.rundeck.api.parser.StringParser; +51 import org.rundeck.api.parser.SystemInfoParser; +52 import org.rundeck.api.util.AssertUtil; +53 import org.rundeck.api.util.ParametersUtil; +54 +55 /** +56 * Main entry point to talk to a RunDeck instance.<br> +57 * Usage : <br> +58 * <code> +59 * <pre> +60 * RundeckClient rundeck = new RundeckClient("http://localhost:4440", "admin", "admin"); +61 * +62 * List&lt;RundeckProject&gt; projects = rundeck.getProjects(); +63 * +64 * RundeckJob job = rundeck.findJob("my-project", "main-group/sub-group", "job-name"); +65 * RundeckExecution execution = rundeck.triggerJob(job.getId(), +66 * new OptionsBuilder().addOption("version", "1.2.0").toProperties()); +67 * +68 * List&lt;RundeckExecution&gt; runningExecutions = rundeck.getRunningExecutions("my-project"); +69 * +70 * rundeck.exportJobsToFile("/tmp/jobs.xml", FileType.XML, "my-project"); +71 * rundeck.importJobs("/tmp/jobs.xml", FileType.XML); +72 * </pre> +73 * </code> +74 * +75 * @author Vincent Behar +76 */ +77 public class RundeckClient implements Serializable { +78 +79 private static final long serialVersionUID = 1L; +80 +81 /** Version of the API supported */ +82 public static final transient int API_VERSION = 1; 83 -84 private final String login; -85 -86 private final String password; -87 -88 /** -89 * Instantiate a new {@link RundeckClient} for the RunDeck instance at the given url -90 * -91 * @param url of the RunDeck instance ("http://localhost:4440", "http://rundeck.your-compagny.com/", etc) -92 * @param login -93 * @param password -94 * @throws IllegalArgumentException if the url, login or password is blank (null, empty or whitespace) -95 */ -96 public RundeckClient(String url, String login, String password) throws IllegalArgumentException { -97 super(); -98 this.url = url; -99 this.login = login; -100 this.password = password; -101 AssertUtil.notBlank(url, "The RunDeck URL is mandatory !"); -102 AssertUtil.notBlank(login, "The RunDeck login is mandatory !"); -103 AssertUtil.notBlank(password, "The RunDeck password is mandatory !"); -104 } -105 -106 /** -107 * Try to "ping" the RunDeck instance to see if it is alive -108 * -109 * @throws RundeckApiException if the ping fails -110 */ -111 public void ping() throws RundeckApiException { -112 new ApiCall(this).ping(); -113 } -114 -115 /** -116 * Test your credentials (login/password) on the RunDeck instance -117 * -118 * @throws RundeckApiLoginException if the login fails -119 */ -120 public void testCredentials() throws RundeckApiLoginException { -121 new ApiCall(this).testCredentials(); -122 } -123 -124 /* -125 * Projects -126 */ -127 -128 /** -129 * List all projects -130 * -131 * @return a {@link List} of {@link RundeckProject} : might be empty, but won't be null -132 * @throws RundeckApiException in case of error when calling the API -133 * @throws RundeckApiLoginException if the login failed -134 */ -135 public List<RundeckProject> getProjects() throws RundeckApiException, RundeckApiLoginException { -136 return new ApiCall(this).get(new ApiPathBuilder("/projects"), -137 new ListParser<RundeckProject>(new ProjectParser(), "result/projects/project")); -138 } -139 -140 /** -141 * Get the definition of a single project, identified by the given name -142 * -143 * @param projectName name of the project - mandatory -144 * @return a {@link RundeckProject} instance - won't be null -145 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) -146 * @throws RundeckApiLoginException if the login failed -147 * @throws IllegalArgumentException if the projectName is blank (null, empty or whitespace) +84 /** End-point of the API */ +85 public static final transient String API_ENDPOINT = "/api/" + API_VERSION; +86 +87 /** Default value for the "pooling interval" used when running jobs/commands/scripts */ +88 private static final transient long DEFAULT_POOLING_INTERVAL = 5; +89 +90 /** Default unit of the "pooling interval" used when running jobs/commands/scripts */ +91 private static final transient TimeUnit DEFAULT_POOLING_UNIT = TimeUnit.SECONDS; +92 +93 /** URL of the RunDeck instance ("http://localhost:4440" target="alexandria_uri">http://localhost:4440", "http://rundeck.your-compagny.com/", etc) */ +94 private final String url; +95 +96 /** Login to use for authentication on the RunDeck instance */ +97 private final String login; +98 +99 /** Password to use for authentication on the RunDeck instance */ +100 private final String password; +101 +102 /** +103 * Instantiate a new {@link RundeckClient} for the RunDeck instance at the given url +104 * +105 * @param url of the RunDeck instance ("http://localhost:4440", "http://rundeck.your-compagny.com/", etc) +106 * @param login +107 * @param password +108 * @throws IllegalArgumentException if the url, login or password is blank (null, empty or whitespace) +109 */ +110 public RundeckClient(String url, String login, String password) throws IllegalArgumentException { +111 super(); +112 this.url = url; +113 this.login = login; +114 this.password = password; +115 AssertUtil.notBlank(url, "The RunDeck URL is mandatory !"); +116 AssertUtil.notBlank(login, "The RunDeck login is mandatory !"); +117 AssertUtil.notBlank(password, "The RunDeck password is mandatory !"); +118 } +119 +120 /** +121 * Try to "ping" the RunDeck instance to see if it is alive +122 * +123 * @throws RundeckApiException if the ping fails +124 */ +125 public void ping() throws RundeckApiException { +126 new ApiCall(this).ping(); +127 } +128 +129 /** +130 * Test your credentials (login/password) on the RunDeck instance +131 * +132 * @throws RundeckApiLoginException if the login fails +133 */ +134 public void testCredentials() throws RundeckApiLoginException { +135 new ApiCall(this).testCredentials(); +136 } +137 +138 /* +139 * Projects +140 */ +141 +142 /** +143 * List all projects +144 * +145 * @return a {@link List} of {@link RundeckProject} : might be empty, but won't be null +146 * @throws RundeckApiException in case of error when calling the API +147 * @throws RundeckApiLoginException if the login failed 148 */ -149 public RundeckProject getProject(String projectName) throws RundeckApiException, RundeckApiLoginException, -150 IllegalArgumentException { -151 AssertUtil.notBlank(projectName, "projectName is mandatory to get the details of a project !"); -152 return new ApiCall(this).get(new ApiPathBuilder("/project/", projectName), -153 new ProjectParser("result/projects/project")); -154 } -155 -156 /* -157 * Jobs -158 */ -159 -160 /** -161 * List all jobs (for all projects) -162 * -163 * @return a {@link List} of {@link RundeckJob} : might be empty, but won't be null -164 * @throws RundeckApiException in case of error when calling the API -165 * @throws RundeckApiLoginException if the login failed -166 */ -167 public List<RundeckJob> getJobs() throws RundeckApiException, RundeckApiLoginException { -168 List<RundeckJob> jobs = new ArrayList<RundeckJob>(); -169 for (RundeckProject project : getProjects()) { -170 jobs.addAll(getJobs(project.getName())); -171 } -172 return jobs; -173 } -174 -175 /** -176 * List all jobs that belongs to the given project -177 * -178 * @param project name of the project - mandatory -179 * @return a {@link List} of {@link RundeckJob} : might be empty, but won't be null -180 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) -181 * @throws RundeckApiLoginException if the login failed -182 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) -183 * @see #getJobs(String, String, String, String...) -184 */ -185 public List<RundeckJob> getJobs(String project) throws RundeckApiException, RundeckApiLoginException, -186 IllegalArgumentException { -187 return getJobs(project, null, null, new String[0]); -188 } -189 -190 /** -191 * List the jobs that belongs to the given project, and matches the given criteria (jobFilter, groupPath and jobIds) -192 * -193 * @param project name of the project - mandatory -194 * @param jobFilter a filter for the job Name - optional -195 * @param groupPath a group or partial group path to include all jobs within that group path - optional -196 * @param jobIds a list of Job IDs to include - optional -197 * @return a {@link List} of {@link RundeckJob} : might be empty, but won't be null -198 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) -199 * @throws RundeckApiLoginException if the login failed -200 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) -201 * @see #getJobs(String) -202 */ -203 public List<RundeckJob> getJobs(String project, String jobFilter, String groupPath, String... jobIds) -204 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { -205 AssertUtil.notBlank(project, "project is mandatory to get all jobs !"); -206 return new ApiCall(this).get(new ApiPathBuilder("/jobs").param("project", project) -207 .param("jobFilter", jobFilter) -208 .param("groupPath", groupPath) -209 .param("idlist", StringUtils.join(jobIds, ",")), -210 new ListParser<RundeckJob>(new JobParser(), "result/jobs/job")); -211 } -212 -213 /** -214 * Export the definitions of all jobs that belongs to the given project -215 * -216 * @param filename path of the file where the content should be saved - mandatory -217 * @param format of the export. See {@link FileType} - mandatory -218 * @param project name of the project - mandatory -219 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) -220 * @throws RundeckApiLoginException if the login failed -221 * @throws IllegalArgumentException if the format or project is blank (null, empty or whitespace), or the format is -222 * invalid -223 * @throws IOException if we failed to write to the file -224 * @see #exportJobsToFile(String, FileType, String, String, String, String...) -225 * @see #exportJobs(String, String) -226 */ -227 public void exportJobsToFile(String filename, String format, String project) throws RundeckApiException, -228 RundeckApiLoginException, IllegalArgumentException, IOException { -229 AssertUtil.notBlank(format, "format is mandatory to export jobs !"); -230 exportJobsToFile(filename, FileType.valueOf(StringUtils.upperCase(format)), project); -231 } -232 -233 /** -234 * Export the definitions of all jobs that belongs to the given project -235 * -236 * @param filename path of the file where the content should be saved - mandatory -237 * @param format of the export. See {@link FileType} - mandatory -238 * @param project name of the project - mandatory -239 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) -240 * @throws RundeckApiLoginException if the login failed -241 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the format is null -242 * @throws IOException if we failed to write to the file -243 * @see #exportJobsToFile(String, FileType, String, String, String, String...) -244 * @see #exportJobs(FileType, String) -245 */ -246 public void exportJobsToFile(String filename, FileType format, String project) throws RundeckApiException, -247 RundeckApiLoginException, IllegalArgumentException, IOException { -248 exportJobsToFile(filename, format, project, null, null, new String[0]); -249 } -250 -251 /** -252 * Export the definitions of the jobs that belongs to the given project, and matches the given criteria (jobFilter, -253 * groupPath and jobIds) -254 * -255 * @param filename path of the file where the content should be saved - mandatory -256 * @param format of the export. See {@link FileType} - mandatory -257 * @param project name of the project - mandatory -258 * @param jobFilter a filter for the job Name - optional -259 * @param groupPath a group or partial group path to include all jobs within that group path - optional -260 * @param jobIds a list of Job IDs to include - optional -261 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) -262 * @throws RundeckApiLoginException if the login failed -263 * @throws IllegalArgumentException if the filename, format or project is blank (null, empty or whitespace), or the -264 * format is invalid -265 * @throws IOException if we failed to write to the file -266 * @see #exportJobsToFile(String, FileType, String, String, String, String...) -267 * @see #exportJobs(FileType, String, String, String, String...) -268 */ -269 public void exportJobsToFile(String filename, String format, String project, String jobFilter, String groupPath, -270 String... jobIds) throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException, -271 IOException { -272 AssertUtil.notBlank(format, "format is mandatory to export jobs !"); -273 exportJobsToFile(filename, -274 FileType.valueOf(StringUtils.upperCase(format)), -275 project, -276 jobFilter, -277 groupPath, -278 jobIds); -279 } -280 -281 /** -282 * Export the definitions of the jobs that belongs to the given project, and matches the given criteria (jobFilter, -283 * groupPath and jobIds) -284 * -285 * @param filename path of the file where the content should be saved - mandatory -286 * @param format of the export. See {@link FileType} - mandatory -287 * @param project name of the project - mandatory -288 * @param jobFilter a filter for the job Name - optional -289 * @param groupPath a group or partial group path to include all jobs within that group path - optional -290 * @param jobIds a list of Job IDs to include - optional -291 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) -292 * @throws RundeckApiLoginException if the login failed -293 * @throws IllegalArgumentException if the filename or project is blank (null, empty or whitespace), or the format -294 * is null -295 * @throws IOException if we failed to write to the file -296 * @see #exportJobs(FileType, String, String, String, String...) -297 */ -298 public void exportJobsToFile(String filename, FileType format, String project, String jobFilter, String groupPath, -299 String... jobIds) throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException, -300 IOException { -301 AssertUtil.notBlank(filename, "filename is mandatory to export a job !"); -302 InputStream inputStream = exportJobs(format, project, jobFilter, groupPath, jobIds); -303 FileUtils.writeByteArrayToFile(new File(filename), IOUtils.toByteArray(inputStream)); -304 } -305 -306 /** -307 * Export the definitions of all jobs that belongs to the given project -308 * -309 * @param format of the export. See {@link FileType} - mandatory -310 * @param project name of the project - mandatory -311 * @return an {@link InputStream} instance, not linked to any network resources - won't be null -312 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) -313 * @throws RundeckApiLoginException if the login failed -314 * @throws IllegalArgumentException if the format or project is blank (null, empty or whitespace), or the format is -315 * invalid -316 * @see #exportJobs(FileType, String, String, String, String...) -317 * @see #exportJobsToFile(String, String, String) -318 */ -319 public InputStream exportJobs(String format, String project) throws RundeckApiException, RundeckApiLoginException, -320 IllegalArgumentException { -321 AssertUtil.notBlank(format, "format is mandatory to export jobs !"); -322 return exportJobs(FileType.valueOf(StringUtils.upperCase(format)), project); -323 } -324 -325 /** -326 * Export the definitions of all jobs that belongs to the given project -327 * -328 * @param format of the export. See {@link FileType} - mandatory -329 * @param project name of the project - mandatory -330 * @return an {@link InputStream} instance, not linked to any network resources - won't be null -331 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) -332 * @throws RundeckApiLoginException if the login failed -333 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the format is null -334 * @see #exportJobs(FileType, String, String, String, String...) -335 * @see #exportJobsToFile(String, FileType, String) -336 */ -337 public InputStream exportJobs(FileType format, String project) throws RundeckApiException, -338 RundeckApiLoginException, IllegalArgumentException { -339 return exportJobs(format, project, null, null, new String[0]); -340 } -341 -342 /** -343 * Export the definitions of the jobs that belongs to the given project, and matches the given criteria (jobFilter, -344 * groupPath and jobIds) -345 * -346 * @param format of the export. See {@link FileType} - mandatory -347 * @param project name of the project - mandatory -348 * @param jobFilter a filter for the job Name - optional -349 * @param groupPath a group or partial group path to include all jobs within that group path - optional -350 * @param jobIds a list of Job IDs to include - optional -351 * @return an {@link InputStream} instance, not linked to any network resources - won't be null -352 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) -353 * @throws RundeckApiLoginException if the login failed -354 * @throws IllegalArgumentException if the format or project is blank (null, empty or whitespace), or the format is -355 * invalid -356 * @see #exportJobs(FileType, String, String, String, String...) -357 * @see #exportJobsToFile(String, String, String, String, String, String...) -358 */ -359 public InputStream exportJobs(String format, String project, String jobFilter, String groupPath, String... jobIds) -360 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { -361 AssertUtil.notBlank(format, "format is mandatory to export jobs !"); -362 return exportJobs(FileType.valueOf(StringUtils.upperCase(format)), project, jobFilter, groupPath, jobIds); -363 } -364 -365 /** -366 * Export the definitions of the jobs that belongs to the given project, and matches the given criteria (jobFilter, -367 * groupPath and jobIds) -368 * -369 * @param format of the export. See {@link FileType} - mandatory -370 * @param project name of the project - mandatory -371 * @param jobFilter a filter for the job Name - optional -372 * @param groupPath a group or partial group path to include all jobs within that group path - optional -373 * @param jobIds a list of Job IDs to include - optional -374 * @return an {@link InputStream} instance, not linked to any network resources - won't be null -375 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) -376 * @throws RundeckApiLoginException if the login failed -377 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the format is null -378 * @see #exportJobsToFile(String, FileType, String, String, String, String...) -379 */ -380 public InputStream exportJobs(FileType format, String project, String jobFilter, String groupPath, String... jobIds) -381 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { -382 AssertUtil.notNull(format, "format is mandatory to export jobs !"); -383 AssertUtil.notBlank(project, "project is mandatory to export jobs !"); -384 return new ApiCall(this).get(new ApiPathBuilder("/jobs/export").param("format", format) -385 .param("project", project) -386 .param("jobFilter", jobFilter) -387 .param("groupPath", groupPath) -388 .param("idlist", StringUtils.join(jobIds, ","))); -389 } -390 -391 /** -392 * Export the definition of a single job (identified by the given ID) -393 * -394 * @param filename path of the file where the content should be saved - mandatory -395 * @param format of the export. See {@link FileType} - mandatory -396 * @param jobId identifier of the job - mandatory -397 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) -398 * @throws RundeckApiLoginException if the login failed -399 * @throws IllegalArgumentException if the filename, format or jobId is blank (null, empty or whitespace), or the -400 * format is invalid -401 * @throws IOException if we failed to write to the file -402 * @see #exportJobToFile(String, FileType, String) -403 * @see #exportJob(String, String) -404 * @see #getJob(String) -405 */ -406 public void exportJobToFile(String filename, String format, String jobId) throws RundeckApiException, -407 RundeckApiLoginException, IllegalArgumentException, IOException { -408 AssertUtil.notBlank(format, "format is mandatory to export a job !"); -409 exportJobToFile(filename, FileType.valueOf(StringUtils.upperCase(format)), jobId); -410 } -411 -412 /** -413 * Export the definition of a single job (identified by the given ID) -414 * -415 * @param filename path of the file where the content should be saved - mandatory -416 * @param format of the export. See {@link FileType} - mandatory -417 * @param jobId identifier of the job - mandatory -418 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) -419 * @throws RundeckApiLoginException if the login failed -420 * @throws IllegalArgumentException if the filename or jobId is blank (null, empty or whitespace), or the format is -421 * null -422 * @throws IOException if we failed to write to the file -423 * @see #exportJob(FileType, String) -424 * @see #getJob(String) -425 */ -426 public void exportJobToFile(String filename, FileType format, String jobId) throws RundeckApiException, -427 RundeckApiLoginException, IllegalArgumentException, IOException { -428 AssertUtil.notBlank(filename, "filename is mandatory to export a job !"); -429 InputStream inputStream = exportJob(format, jobId); -430 FileUtils.writeByteArrayToFile(new File(filename), IOUtils.toByteArray(inputStream)); -431 } -432 -433 /** -434 * Export the definition of a single job, identified by the given ID -435 * -436 * @param format of the export. See {@link FileType} - mandatory -437 * @param jobId identifier of the job - mandatory -438 * @return an {@link InputStream} instance, not linked to any network resources - won't be null -439 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) -440 * @throws RundeckApiLoginException if the login failed -441 * @throws IllegalArgumentException if the format or jobId is blank (null, empty or whitespace), or the format is -442 * invalid -443 * @see #exportJobToFile(String, String, String) -444 * @see #getJob(String) -445 */ -446 public InputStream exportJob(String format, String jobId) throws RundeckApiException, RundeckApiLoginException, -447 IllegalArgumentException { -448 AssertUtil.notBlank(format, "format is mandatory to export a job !"); -449 return exportJob(FileType.valueOf(StringUtils.upperCase(format)), jobId); -450 } -451 -452 /** -453 * Export the definition of a single job, identified by the given ID -454 * -455 * @param format of the export. See {@link FileType} - mandatory -456 * @param jobId identifier of the job - mandatory -457 * @return an {@link InputStream} instance, not linked to any network resources - won't be null -458 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) -459 * @throws RundeckApiLoginException if the login failed -460 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace), or the format is null -461 * @see #exportJobToFile(String, FileType, String) -462 * @see #getJob(String) -463 */ -464 public InputStream exportJob(FileType format, String jobId) throws RundeckApiException, RundeckApiLoginException, -465 IllegalArgumentException { -466 AssertUtil.notNull(format, "format is mandatory to export a job !"); -467 AssertUtil.notBlank(jobId, "jobId is mandatory to export a job !"); -468 return new ApiCall(this).get(new ApiPathBuilder("/job/", jobId).param("format", format)); -469 } -470 -471 /** -472 * Import the definitions of jobs, from the given file -473 * -474 * @param filename of the file containing the jobs definitions - mandatory -475 * @param fileType type of the file. See {@link FileType} - mandatory -476 * @return a {@link RundeckJobsImportResult} instance - won't be null -477 * @throws RundeckApiException in case of error when calling the API -478 * @throws RundeckApiLoginException if the login failed -479 * @throws IllegalArgumentException if the filename or fileType is blank (null, empty or whitespace), or the -480 * fileType is invalid -481 * @throws IOException if we failed to read the file -482 * @see #importJobs(InputStream, String) -483 * @see #importJobs(String, FileType, RundeckJobsImportMethod) -484 */ -485 public RundeckJobsImportResult importJobs(String filename, String fileType) throws RundeckApiException, -486 RundeckApiLoginException, IllegalArgumentException, IOException { -487 AssertUtil.notBlank(fileType, "fileType is mandatory to import jobs !"); -488 return importJobs(filename, FileType.valueOf(StringUtils.upperCase(fileType))); -489 } -490 -491 /** -492 * Import the definitions of jobs, from the given file -493 * -494 * @param filename of the file containing the jobs definitions - mandatory -495 * @param fileType type of the file. See {@link FileType} - mandatory -496 * @return a {@link RundeckJobsImportResult} instance - won't be null -497 * @throws RundeckApiException in case of error when calling the API -498 * @throws RundeckApiLoginException if the login failed -499 * @throws IllegalArgumentException if the filename is blank (null, empty or whitespace), or the fileType is null -500 * @throws IOException if we failed to read the file -501 * @see #importJobs(InputStream, FileType) -502 * @see #importJobs(String, FileType, RundeckJobsImportMethod) -503 */ -504 public RundeckJobsImportResult importJobs(String filename, FileType fileType) throws RundeckApiException, -505 RundeckApiLoginException, IllegalArgumentException, IOException { -506 return importJobs(filename, fileType, (RundeckJobsImportMethod) null); -507 } -508 -509 /** -510 * Import the definitions of jobs, from the given file, using the given behavior -511 * -512 * @param filename of the file containing the jobs definitions - mandatory -513 * @param fileType type of the file. See {@link FileType} - mandatory -514 * @param importBehavior see {@link RundeckJobsImportMethod} -515 * @return a {@link RundeckJobsImportResult} instance - won't be null -516 * @throws RundeckApiException in case of error when calling the API -517 * @throws RundeckApiLoginException if the login failed -518 * @throws IllegalArgumentException if the filename or fileType is blank (null, empty or whitespace), or the -519 * fileType or behavior is not valid -520 * @throws IOException if we failed to read the file -521 * @see #importJobs(InputStream, String, String) -522 * @see #importJobs(String, FileType, RundeckJobsImportMethod) -523 */ -524 public RundeckJobsImportResult importJobs(String filename, String fileType, String importBehavior) -525 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException, IOException { -526 AssertUtil.notBlank(fileType, "fileType is mandatory to import jobs !"); -527 return importJobs(filename, -528 FileType.valueOf(StringUtils.upperCase(fileType)), -529 RundeckJobsImportMethod.valueOf(StringUtils.upperCase(importBehavior))); -530 } -531 -532 /** -533 * Import the definitions of jobs, from the given file, using the given behavior -534 * -535 * @param filename of the file containing the jobs definitions - mandatory -536 * @param fileType type of the file. See {@link FileType} - mandatory -537 * @param importBehavior see {@link RundeckJobsImportMethod} -538 * @return a {@link RundeckJobsImportResult} instance - won't be null -539 * @throws RundeckApiException in case of error when calling the API -540 * @throws RundeckApiLoginException if the login failed -541 * @throws IllegalArgumentException if the filename is blank (null, empty or whitespace), or the fileType is null -542 * @throws IOException if we failed to read the file -543 * @see #importJobs(InputStream, FileType, RundeckJobsImportMethod) -544 */ -545 public RundeckJobsImportResult importJobs(String filename, FileType fileType, RundeckJobsImportMethod importBehavior) -546 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException, IOException { -547 AssertUtil.notBlank(filename, "filename (of jobs file) is mandatory to import jobs !"); -548 FileInputStream stream = null; -549 try { -550 stream = FileUtils.openInputStream(new File(filename)); -551 return importJobs(stream, fileType, importBehavior); -552 } finally { -553 IOUtils.closeQuietly(stream); -554 } -555 } -556 -557 /** -558 * Import the definitions of jobs, from the given input stream -559 * -560 * @param stream inputStream for reading the definitions - mandatory -561 * @param fileType type of the file. See {@link FileType} - mandatory -562 * @return a {@link RundeckJobsImportResult} instance - won't be null -563 * @throws RundeckApiException in case of error when calling the API -564 * @throws RundeckApiLoginException if the login failed -565 * @throws IllegalArgumentException if the stream is null, or the fileType is blank (null, empty or whitespace) or -566 * invalid -567 * @see #importJobs(String, String) -568 * @see #importJobs(InputStream, FileType, RundeckJobsImportMethod) -569 */ -570 public RundeckJobsImportResult importJobs(InputStream stream, String fileType) throws RundeckApiException, -571 RundeckApiLoginException, IllegalArgumentException { -572 AssertUtil.notBlank(fileType, "fileType is mandatory to import jobs !"); -573 return importJobs(stream, FileType.valueOf(StringUtils.upperCase(fileType))); -574 } -575 -576 /** -577 * Import the definitions of jobs, from the given input stream -578 * -579 * @param stream inputStream for reading the definitions - mandatory -580 * @param fileType type of the file. See {@link FileType} - mandatory -581 * @return a {@link RundeckJobsImportResult} instance - won't be null -582 * @throws RundeckApiException in case of error when calling the API -583 * @throws RundeckApiLoginException if the login failed -584 * @throws IllegalArgumentException if the stream or fileType is null -585 * @see #importJobs(String, FileType) -586 * @see #importJobs(InputStream, FileType, RundeckJobsImportMethod) -587 */ -588 public RundeckJobsImportResult importJobs(InputStream stream, FileType fileType) throws RundeckApiException, -589 RundeckApiLoginException, IllegalArgumentException { -590 return importJobs(stream, fileType, (RundeckJobsImportMethod) null); -591 } -592 -593 /** -594 * Import the definitions of jobs, from the given input stream, using the given behavior -595 * -596 * @param stream inputStream for reading the definitions - mandatory -597 * @param fileType type of the file. See {@link FileType} - mandatory -598 * @param importBehavior see {@link RundeckJobsImportMethod} -599 * @return a {@link RundeckJobsImportResult} instance - won't be null -600 * @throws RundeckApiException in case of error when calling the API -601 * @throws RundeckApiLoginException if the login failed -602 * @throws IllegalArgumentException if the stream is null, or the fileType is blank (null, empty or whitespace), or -603 * the fileType or behavior is not valid -604 * @see #importJobs(String, String, String) -605 * @see #importJobs(InputStream, FileType, RundeckJobsImportMethod) -606 */ -607 public RundeckJobsImportResult importJobs(InputStream stream, String fileType, String importBehavior) -608 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { -609 AssertUtil.notBlank(fileType, "fileType is mandatory to import jobs !"); -610 return importJobs(stream, -611 FileType.valueOf(StringUtils.upperCase(fileType)), -612 RundeckJobsImportMethod.valueOf(StringUtils.upperCase(importBehavior))); -613 } -614 -615 /** -616 * Import the definitions of jobs, from the given input stream, using the given behavior -617 * -618 * @param stream inputStream for reading the definitions - mandatory -619 * @param fileType type of the file. See {@link FileType} - mandatory -620 * @param importBehavior see {@link RundeckJobsImportMethod} -621 * @return a {@link RundeckJobsImportResult} instance - won't be null -622 * @throws RundeckApiException in case of error when calling the API -623 * @throws RundeckApiLoginException if the login failed -624 * @throws IllegalArgumentException if the stream or fileType is null -625 * @see #importJobs(String, FileType, RundeckJobsImportMethod) -626 */ -627 public RundeckJobsImportResult importJobs(InputStream stream, FileType fileType, -628 RundeckJobsImportMethod importBehavior) throws RundeckApiException, RundeckApiLoginException, -629 IllegalArgumentException { -630 AssertUtil.notNull(stream, "inputStream of jobs is mandatory to import jobs !"); -631 AssertUtil.notNull(fileType, "fileType is mandatory to import jobs !"); -632 return new ApiCall(this).post(new ApiPathBuilder("/jobs/import").param("format", fileType) -633 .param("dupeOption", importBehavior) -634 .attach("xmlBatch", stream), -635 new JobsImportResultParser("result")); -636 } -637 -638 /** -639 * Find a job, identified by its project, group and name. Note that the groupPath is optional, as a job does not -640 * need to belong to a group (either pass null, or an empty string). -641 * -642 * @param project name of the project - mandatory -643 * @param groupPath group to which the job belongs (if it belongs to a group) - optional -644 * @param name of the job to find - mandatory -645 * @return a {@link RundeckJob} instance - null if not found -646 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) -647 * @throws RundeckApiLoginException if the login failed -648 * @throws IllegalArgumentException if the project or the name is blank (null, empty or whitespace) -649 * @see #getJob(String) -650 */ -651 public RundeckJob findJob(String project, String groupPath, String name) throws RundeckApiException, -652 RundeckApiLoginException, IllegalArgumentException { -653 AssertUtil.notBlank(project, "project is mandatory to find a job !"); -654 AssertUtil.notBlank(name, "job name is mandatory to find a job !"); -655 List<RundeckJob> jobs = getJobs(project, name, groupPath, new String[0]); -656 return jobs.isEmpty() ? null : jobs.get(0); -657 } -658 -659 /** -660 * Get the definition of a single job, identified by the given ID -661 * -662 * @param jobId identifier of the job - mandatory -663 * @return a {@link RundeckJob} instance - won't be null -664 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) -665 * @throws RundeckApiLoginException if the login failed -666 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) -667 * @see #findJob(String, String, String) -668 * @see #exportJob(String) -669 */ -670 public RundeckJob getJob(String jobId) throws RundeckApiException, RundeckApiLoginException, -671 IllegalArgumentException { -672 AssertUtil.notBlank(jobId, "jobId is mandatory to get the details of a job !"); -673 return new ApiCall(this).get(new ApiPathBuilder("/job/", jobId), new JobParser("joblist/job")); -674 } -675 -676 /** -677 * Delete a single job, identified by the given ID -678 * -679 * @param jobId identifier of the job - mandatory -680 * @return the success message (note that in case of error, you'll get an exception) -681 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) -682 * @throws RundeckApiLoginException if the login failed -683 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) -684 */ -685 public String deleteJob(String jobId) throws RundeckApiException, RundeckApiLoginException, -686 IllegalArgumentException { -687 AssertUtil.notBlank(jobId, "jobId is mandatory to delete a job !"); -688 return new ApiCall(this).delete(new ApiPathBuilder("/job/", jobId), new StringParser("result/success/message")); -689 } -690 -691 /** -692 * Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the -693 * end of the job execution) -694 * -695 * @param jobId identifier of the job - mandatory -696 * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null -697 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) -698 * @throws RundeckApiLoginException if the login failed -699 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) -700 * @see #triggerJob(String, Properties, Properties) -701 * @see #runJob(String) -702 */ -703 public RundeckExecution triggerJob(String jobId) throws RundeckApiException, RundeckApiLoginException, -704 IllegalArgumentException { -705 return triggerJob(jobId, null); -706 } -707 -708 /** -709 * Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the -710 * end of the job execution) -711 * -712 * @param jobId identifier of the job - mandatory -713 * @param options of the job - optional. See {@link OptionsBuilder}. -714 * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null -715 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) -716 * @throws RundeckApiLoginException if the login failed -717 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) -718 * @see #triggerJob(String, Properties, Properties) -719 * @see #runJob(String, Properties) -720 */ -721 public RundeckExecution triggerJob(String jobId, Properties options) throws RundeckApiException, -722 RundeckApiLoginException, IllegalArgumentException { -723 return triggerJob(jobId, options, null); -724 } -725 -726 /** -727 * Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the -728 * end of the job execution) -729 * -730 * @param jobId identifier of the job - mandatory -731 * @param options of the job - optional. See {@link OptionsBuilder}. -732 * @param nodeFilters for overriding the nodes on which the job will be executed - optional. See -733 * {@link NodeFiltersBuilder} -734 * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null -735 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) -736 * @throws RundeckApiLoginException if the login failed -737 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) -738 * @see #triggerJob(String) -739 * @see #runJob(String, Properties, Properties) -740 */ -741 public RundeckExecution triggerJob(String jobId, Properties options, Properties nodeFilters) -742 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { -743 AssertUtil.notBlank(jobId, "jobId is mandatory to trigger a job !"); -744 return new ApiCall(this).get(new ApiPathBuilder("/job/", jobId, "/run").param("argString", -745 ParametersUtil.generateArgString(options)) -746 .nodeFilters(nodeFilters), -747 new ExecutionParser("result/executions/execution")); -748 } -749 -750 /** -751 * Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return. -752 * We will poll the RunDeck server at regular interval (every 5 seconds) to know if the execution is finished (or -753 * aborted) or is still running. -754 * -755 * @param jobId identifier of the job - mandatory -756 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null -757 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) -758 * @throws RundeckApiLoginException if the login failed -759 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) -760 * @see #triggerJob(String) -761 * @see #runJob(String, Properties, Properties, long, TimeUnit) -762 */ -763 public RundeckExecution runJob(String jobId) throws RundeckApiException, RundeckApiLoginException, -764 IllegalArgumentException { -765 return runJob(jobId, null); -766 } -767 -768 /** -769 * Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return. -770 * We will poll the RunDeck server at regular interval (every 5 seconds) to know if the execution is finished (or -771 * aborted) or is still running. -772 * -773 * @param jobId identifier of the job - mandatory -774 * @param options of the job - optional. See {@link OptionsBuilder}. -775 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null -776 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) -777 * @throws RundeckApiLoginException if the login failed -778 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) -779 * @see #triggerJob(String, Properties) -780 * @see #runJob(String, Properties, Properties, long, TimeUnit) -781 */ -782 public RundeckExecution runJob(String jobId, Properties options) throws RundeckApiException, -783 RundeckApiLoginException, IllegalArgumentException { -784 return runJob(jobId, options, null); -785 } -786 -787 /** -788 * Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return. -789 * We will poll the RunDeck server at regular interval (every 5 seconds) to know if the execution is finished (or -790 * aborted) or is still running. -791 * -792 * @param jobId identifier of the job - mandatory -793 * @param options of the job - optional. See {@link OptionsBuilder}. -794 * @param nodeFilters for overriding the nodes on which the job will be executed - optional. See -795 * {@link NodeFiltersBuilder} -796 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null -797 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) -798 * @throws RundeckApiLoginException if the login failed -799 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) -800 * @see #triggerJob(String, Properties, Properties) -801 * @see #runJob(String, Properties, Properties, long, TimeUnit) -802 */ -803 public RundeckExecution runJob(String jobId, Properties options, Properties nodeFilters) -804 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { -805 return runJob(jobId, options, nodeFilters, 5, TimeUnit.SECONDS); -806 } -807 -808 /** -809 * Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return. -810 * We will poll the RunDeck server at regular interval (configured by the poolingInterval/poolingUnit couple) to -811 * know if the execution is finished (or aborted) or is still running. -812 * -813 * @param jobId identifier of the job - mandatory -814 * @param options of the job - optional. See {@link OptionsBuilder}. -815 * @param poolingInterval for checking the status of the execution. Must be > 0. -816 * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds. -817 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null -818 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) -819 * @throws RundeckApiLoginException if the login failed -820 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) -821 * @see #triggerJob(String, Properties) -822 * @see #runJob(String, Properties, Properties, long, TimeUnit) -823 */ -824 public RundeckExecution runJob(String jobId, Properties options, long poolingInterval, TimeUnit poolingUnit) -825 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { -826 return runJob(jobId, options, null, poolingInterval, poolingUnit); -827 } -828 -829 /** -830 * Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return. -831 * We will poll the RunDeck server at regular interval (configured by the poolingInterval/poolingUnit couple) to -832 * know if the execution is finished (or aborted) or is still running. -833 * -834 * @param jobId identifier of the job - mandatory -835 * @param options of the job - optional. See {@link OptionsBuilder}. -836 * @param nodeFilters for overriding the nodes on which the job will be executed - optional. See -837 * {@link NodeFiltersBuilder} -838 * @param poolingInterval for checking the status of the execution. Must be > 0. -839 * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds. -840 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null -841 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) -842 * @throws RundeckApiLoginException if the login failed -843 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) -844 * @see #triggerJob(String, Properties) -845 * @see #runJob(String, Properties, Properties, long, TimeUnit) -846 */ -847 public RundeckExecution runJob(String jobId, Properties options, Properties nodeFilters, long poolingInterval, -848 TimeUnit poolingUnit) throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { -849 if (poolingInterval <= 0) { -850 poolingInterval = 5; -851 poolingUnit = TimeUnit.SECONDS; -852 } -853 if (poolingUnit == null) { -854 poolingUnit = TimeUnit.SECONDS; -855 } -856 -857 RundeckExecution execution = triggerJob(jobId, options, nodeFilters); -858 while (ExecutionStatus.RUNNING.equals(execution.getStatus())) { -859 try { -860 Thread.sleep(poolingUnit.toMillis(poolingInterval)); -861 } catch (InterruptedException e) { -862 break; -863 } -864 execution = getExecution(execution.getId()); -865 } -866 return execution; -867 } -868 -869 /* -870 * Ad-hoc commands -871 */ -872 -873 /** -874 * Trigger the execution of an ad-hoc command, and return immediately (without waiting the end of the execution). -875 * The command will not be dispatched to nodes, but be executed on the RunDeck server. -876 * -877 * @param project name of the project - mandatory -878 * @param command to be executed - mandatory -879 * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null -880 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) -881 * @throws RundeckApiLoginException if the login failed -882 * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace) -883 * @see #triggerAdhocCommand(String, String, Properties, Integer, Boolean) -884 * @see #runAdhocCommand(String, String) -885 */ -886 public RundeckExecution triggerAdhocCommand(String project, String command) throws RundeckApiException, -887 RundeckApiLoginException, IllegalArgumentException { -888 return triggerAdhocCommand(project, command, null); -889 } -890 -891 /** -892 * Trigger the execution of an ad-hoc command, and return immediately (without waiting the end of the execution). -893 * The command will be dispatched to nodes, accordingly to the nodeFilters parameter. -894 * -895 * @param project name of the project - mandatory -896 * @param command to be executed - mandatory -897 * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder} -898 * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null -899 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) -900 * @throws RundeckApiLoginException if the login failed -901 * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace) -902 * @see #triggerAdhocCommand(String, String, Properties, Integer, Boolean) -903 * @see #runAdhocCommand(String, String, Properties) -904 */ -905 public RundeckExecution triggerAdhocCommand(String project, String command, Properties nodeFilters) -906 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { -907 return triggerAdhocCommand(project, command, nodeFilters, null, null); -908 } -909 -910 /** -911 * Trigger the execution of an ad-hoc command, and return immediately (without waiting the end of the execution). -912 * The command will be dispatched to nodes, accordingly to the nodeFilters parameter. -913 * -914 * @param project name of the project - mandatory -915 * @param command to be executed - mandatory -916 * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder} -917 * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional -918 * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional -919 * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null -920 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) -921 * @throws RundeckApiLoginException if the login failed -922 * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace) -923 * @see #triggerAdhocCommand(String, String) -924 * @see #runAdhocCommand(String, String, Properties) -925 */ -926 public RundeckExecution triggerAdhocCommand(String project, String command, Properties nodeFilters, -927 Integer nodeThreadcount, Boolean nodeKeepgoing) throws RundeckApiException, RundeckApiLoginException, -928 IllegalArgumentException { -929 AssertUtil.notBlank(project, "project is mandatory to trigger an ad-hoc command !"); -930 AssertUtil.notBlank(command, "command is mandatory to trigger an ad-hoc command !"); -931 RundeckExecution execution = new ApiCall(this).get(new ApiPathBuilder("/run/command").param("project", project) -932 .param("exec", command) -933 .param("nodeThreadcount", -934 nodeThreadcount) -935 .param("nodeKeepgoing", -936 nodeKeepgoing) -937 .nodeFilters(nodeFilters), -938 new ExecutionParser("result/execution")); -939 // the first call just returns the ID of the execution, so we need another call to get a "real" execution -940 return getExecution(execution.getId()); -941 } -942 -943 /** -944 * Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck -945 * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still -946 * running. The command will not be dispatched to nodes, but be executed on the RunDeck server. -947 * -948 * @param project name of the project - mandatory -949 * @param command to be executed - mandatory -950 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null -951 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) -952 * @throws RundeckApiLoginException if the login failed -953 * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace) -954 * @see #runAdhocCommand(String, String, Properties, Integer, Boolean, long, TimeUnit) -955 * @see #triggerAdhocCommand(String, String) -956 */ -957 public RundeckExecution runAdhocCommand(String project, String command) throws RundeckApiException, -958 RundeckApiLoginException, IllegalArgumentException { -959 return runAdhocCommand(project, command, null); -960 } -961 -962 /** -963 * Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck -964 * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is -965 * finished (or aborted) or is still running. The command will not be dispatched to nodes, but be executed on the -966 * RunDeck server. -967 * -968 * @param project name of the project - mandatory -969 * @param command to be executed - mandatory -970 * @param poolingInterval for checking the status of the execution. Must be > 0. -971 * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds. -972 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null -973 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) -974 * @throws RundeckApiLoginException if the login failed -975 * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace) -976 * @see #runAdhocCommand(String, String, Properties, Integer, Boolean, long, TimeUnit) -977 * @see #triggerAdhocCommand(String, String) -978 */ -979 public RundeckExecution runAdhocCommand(String project, String command, long poolingInterval, TimeUnit poolingUnit) -980 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { -981 return runAdhocCommand(project, command, null, poolingInterval, poolingUnit); -982 } -983 -984 /** -985 * Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck -986 * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still -987 * running. The command will be dispatched to nodes, accordingly to the nodeFilters parameter. -988 * -989 * @param project name of the project - mandatory -990 * @param command to be executed - mandatory -991 * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder} -992 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null -993 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) -994 * @throws RundeckApiLoginException if the login failed -995 * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace) -996 * @see #runAdhocCommand(String, String, Properties, Integer, Boolean, long, TimeUnit) -997 * @see #triggerAdhocCommand(String, String, Properties) -998 */ -999 public RundeckExecution runAdhocCommand(String project, String command, Properties nodeFilters) -1000 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { -1001 return runAdhocCommand(project, command, nodeFilters, null, null); -1002 } -1003 -1004 /** -1005 * Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck -1006 * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is -1007 * finished (or aborted) or is still running. The command will be dispatched to nodes, accordingly to the -1008 * nodeFilters parameter. -1009 * -1010 * @param project name of the project - mandatory -1011 * @param command to be executed - mandatory -1012 * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder} -1013 * @param poolingInterval for checking the status of the execution. Must be > 0. -1014 * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds. -1015 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null -1016 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) -1017 * @throws RundeckApiLoginException if the login failed -1018 * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace) -1019 * @see #runAdhocCommand(String, String, Properties, Integer, Boolean, long, TimeUnit) -1020 * @see #triggerAdhocCommand(String, String, Properties) -1021 */ -1022 public RundeckExecution runAdhocCommand(String project, String command, Properties nodeFilters, -1023 long poolingInterval, TimeUnit poolingUnit) throws RundeckApiException, RundeckApiLoginException, -1024 IllegalArgumentException { -1025 return runAdhocCommand(project, command, nodeFilters, null, null, poolingInterval, poolingUnit); -1026 } -1027 -1028 /** -1029 * Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck -1030 * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still -1031 * running. The command will be dispatched to nodes, accordingly to the nodeFilters parameter. -1032 * -1033 * @param project name of the project - mandatory -1034 * @param command to be executed - mandatory -1035 * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder} -1036 * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional -1037 * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional -1038 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null -1039 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) -1040 * @throws RundeckApiLoginException if the login failed -1041 * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace) -1042 * @see #runAdhocCommand(String, String, Properties, Integer, Boolean, long, TimeUnit) -1043 * @see #triggerAdhocCommand(String, String, Properties, Integer, Boolean) -1044 */ -1045 public RundeckExecution runAdhocCommand(String project, String command, Properties nodeFilters, -1046 Integer nodeThreadcount, Boolean nodeKeepgoing) throws RundeckApiException, RundeckApiLoginException, -1047 IllegalArgumentException { -1048 return runAdhocCommand(project, command, nodeFilters, nodeThreadcount, nodeKeepgoing, 5, TimeUnit.SECONDS); -1049 } -1050 -1051 /** -1052 * Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck -1053 * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is -1054 * finished (or aborted) or is still running. The command will be dispatched to nodes, accordingly to the -1055 * nodeFilters parameter. -1056 * -1057 * @param project name of the project - mandatory -1058 * @param command to be executed - mandatory -1059 * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder} -1060 * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional -1061 * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional -1062 * @param poolingInterval for checking the status of the execution. Must be > 0. -1063 * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds. -1064 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null -1065 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) -1066 * @throws RundeckApiLoginException if the login failed -1067 * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace) -1068 * @see #triggerAdhocCommand(String, String, Properties, Integer, Boolean) -1069 */ -1070 public RundeckExecution runAdhocCommand(String project, String command, Properties nodeFilters, -1071 Integer nodeThreadcount, Boolean nodeKeepgoing, long poolingInterval, TimeUnit poolingUnit) -1072 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { -1073 if (poolingInterval <= 0) { -1074 poolingInterval = 5; -1075 poolingUnit = TimeUnit.SECONDS; -1076 } -1077 if (poolingUnit == null) { -1078 poolingUnit = TimeUnit.SECONDS; -1079 } -1080 -1081 RundeckExecution execution = triggerAdhocCommand(project, command, nodeFilters, nodeThreadcount, nodeKeepgoing); -1082 while (ExecutionStatus.RUNNING.equals(execution.getStatus())) { -1083 try { -1084 Thread.sleep(poolingUnit.toMillis(poolingInterval)); -1085 } catch (InterruptedException e) { -1086 break; -1087 } -1088 execution = getExecution(execution.getId()); -1089 } -1090 return execution; -1091 } -1092 -1093 /* -1094 * Executions -1095 */ -1096 -1097 /** -1098 * Get all running executions (for all projects) -1099 * -1100 * @return a {@link List} of {@link RundeckExecution} : might be empty, but won't be null -1101 * @throws RundeckApiException in case of error when calling the API -1102 * @throws RundeckApiLoginException if the login failed -1103 * @see #getRunningExecutions(String) -1104 */ -1105 public List<RundeckExecution> getRunningExecutions() throws RundeckApiException, RundeckApiLoginException { -1106 List<RundeckExecution> executions = new ArrayList<RundeckExecution>(); -1107 for (RundeckProject project : getProjects()) { -1108 executions.addAll(getRunningExecutions(project.getName())); +149 public List<RundeckProject> getProjects() throws RundeckApiException, RundeckApiLoginException { +150 return new ApiCall(this).get(new ApiPathBuilder("/projects"), +151 new ListParser<RundeckProject>(new ProjectParser(), "result/projects/project")); +152 } +153 +154 /** +155 * Get the definition of a single project, identified by the given name +156 * +157 * @param projectName name of the project - mandatory +158 * @return a {@link RundeckProject} instance - won't be null +159 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +160 * @throws RundeckApiLoginException if the login failed +161 * @throws IllegalArgumentException if the projectName is blank (null, empty or whitespace) +162 */ +163 public RundeckProject getProject(String projectName) throws RundeckApiException, RundeckApiLoginException, +164 IllegalArgumentException { +165 AssertUtil.notBlank(projectName, "projectName is mandatory to get the details of a project !"); +166 return new ApiCall(this).get(new ApiPathBuilder("/project/", projectName), +167 new ProjectParser("result/projects/project")); +168 } +169 +170 /* +171 * Jobs +172 */ +173 +174 /** +175 * List all jobs (for all projects) +176 * +177 * @return a {@link List} of {@link RundeckJob} : might be empty, but won't be null +178 * @throws RundeckApiException in case of error when calling the API +179 * @throws RundeckApiLoginException if the login failed +180 */ +181 public List<RundeckJob> getJobs() throws RundeckApiException, RundeckApiLoginException { +182 List<RundeckJob> jobs = new ArrayList<RundeckJob>(); +183 for (RundeckProject project : getProjects()) { +184 jobs.addAll(getJobs(project.getName())); +185 } +186 return jobs; +187 } +188 +189 /** +190 * List all jobs that belongs to the given project +191 * +192 * @param project name of the project - mandatory +193 * @return a {@link List} of {@link RundeckJob} : might be empty, but won't be null +194 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +195 * @throws RundeckApiLoginException if the login failed +196 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) +197 * @see #getJobs(String, String, String, String...) +198 */ +199 public List<RundeckJob> getJobs(String project) throws RundeckApiException, RundeckApiLoginException, +200 IllegalArgumentException { +201 return getJobs(project, null, null, new String[0]); +202 } +203 +204 /** +205 * List the jobs that belongs to the given project, and matches the given criteria (jobFilter, groupPath and jobIds) +206 * +207 * @param project name of the project - mandatory +208 * @param jobFilter a filter for the job Name - optional +209 * @param groupPath a group or partial group path to include all jobs within that group path - optional +210 * @param jobIds a list of Job IDs to include - optional +211 * @return a {@link List} of {@link RundeckJob} : might be empty, but won't be null +212 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +213 * @throws RundeckApiLoginException if the login failed +214 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) +215 * @see #getJobs(String) +216 */ +217 public List<RundeckJob> getJobs(String project, String jobFilter, String groupPath, String... jobIds) +218 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { +219 AssertUtil.notBlank(project, "project is mandatory to get all jobs !"); +220 return new ApiCall(this).get(new ApiPathBuilder("/jobs").param("project", project) +221 .param("jobFilter", jobFilter) +222 .param("groupPath", groupPath) +223 .param("idlist", StringUtils.join(jobIds, ",")), +224 new ListParser<RundeckJob>(new JobParser(), "result/jobs/job")); +225 } +226 +227 /** +228 * Export the definitions of all jobs that belongs to the given project +229 * +230 * @param filename path of the file where the content should be saved - mandatory +231 * @param format of the export. See {@link FileType} - mandatory +232 * @param project name of the project - mandatory +233 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +234 * @throws RundeckApiLoginException if the login failed +235 * @throws IllegalArgumentException if the format or project is blank (null, empty or whitespace), or the format is +236 * invalid +237 * @throws IOException if we failed to write to the file +238 * @see #exportJobsToFile(String, FileType, String, String, String, String...) +239 * @see #exportJobs(String, String) +240 */ +241 public void exportJobsToFile(String filename, String format, String project) throws RundeckApiException, +242 RundeckApiLoginException, IllegalArgumentException, IOException { +243 AssertUtil.notBlank(format, "format is mandatory to export jobs !"); +244 exportJobsToFile(filename, FileType.valueOf(StringUtils.upperCase(format)), project); +245 } +246 +247 /** +248 * Export the definitions of all jobs that belongs to the given project +249 * +250 * @param filename path of the file where the content should be saved - mandatory +251 * @param format of the export. See {@link FileType} - mandatory +252 * @param project name of the project - mandatory +253 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +254 * @throws RundeckApiLoginException if the login failed +255 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the format is null +256 * @throws IOException if we failed to write to the file +257 * @see #exportJobsToFile(String, FileType, String, String, String, String...) +258 * @see #exportJobs(FileType, String) +259 */ +260 public void exportJobsToFile(String filename, FileType format, String project) throws RundeckApiException, +261 RundeckApiLoginException, IllegalArgumentException, IOException { +262 exportJobsToFile(filename, format, project, null, null, new String[0]); +263 } +264 +265 /** +266 * Export the definitions of the jobs that belongs to the given project, and matches the given criteria (jobFilter, +267 * groupPath and jobIds) +268 * +269 * @param filename path of the file where the content should be saved - mandatory +270 * @param format of the export. See {@link FileType} - mandatory +271 * @param project name of the project - mandatory +272 * @param jobFilter a filter for the job Name - optional +273 * @param groupPath a group or partial group path to include all jobs within that group path - optional +274 * @param jobIds a list of Job IDs to include - optional +275 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +276 * @throws RundeckApiLoginException if the login failed +277 * @throws IllegalArgumentException if the filename, format or project is blank (null, empty or whitespace), or the +278 * format is invalid +279 * @throws IOException if we failed to write to the file +280 * @see #exportJobsToFile(String, FileType, String, String, String, String...) +281 * @see #exportJobs(FileType, String, String, String, String...) +282 */ +283 public void exportJobsToFile(String filename, String format, String project, String jobFilter, String groupPath, +284 String... jobIds) throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException, +285 IOException { +286 AssertUtil.notBlank(format, "format is mandatory to export jobs !"); +287 exportJobsToFile(filename, +288 FileType.valueOf(StringUtils.upperCase(format)), +289 project, +290 jobFilter, +291 groupPath, +292 jobIds); +293 } +294 +295 /** +296 * Export the definitions of the jobs that belongs to the given project, and matches the given criteria (jobFilter, +297 * groupPath and jobIds) +298 * +299 * @param filename path of the file where the content should be saved - mandatory +300 * @param format of the export. See {@link FileType} - mandatory +301 * @param project name of the project - mandatory +302 * @param jobFilter a filter for the job Name - optional +303 * @param groupPath a group or partial group path to include all jobs within that group path - optional +304 * @param jobIds a list of Job IDs to include - optional +305 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +306 * @throws RundeckApiLoginException if the login failed +307 * @throws IllegalArgumentException if the filename or project is blank (null, empty or whitespace), or the format +308 * is null +309 * @throws IOException if we failed to write to the file +310 * @see #exportJobs(FileType, String, String, String, String...) +311 */ +312 public void exportJobsToFile(String filename, FileType format, String project, String jobFilter, String groupPath, +313 String... jobIds) throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException, +314 IOException { +315 AssertUtil.notBlank(filename, "filename is mandatory to export a job !"); +316 InputStream inputStream = exportJobs(format, project, jobFilter, groupPath, jobIds); +317 FileUtils.writeByteArrayToFile(new File(filename), IOUtils.toByteArray(inputStream)); +318 } +319 +320 /** +321 * Export the definitions of all jobs that belongs to the given project +322 * +323 * @param format of the export. See {@link FileType} - mandatory +324 * @param project name of the project - mandatory +325 * @return an {@link InputStream} instance, not linked to any network resources - won't be null +326 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +327 * @throws RundeckApiLoginException if the login failed +328 * @throws IllegalArgumentException if the format or project is blank (null, empty or whitespace), or the format is +329 * invalid +330 * @see #exportJobs(FileType, String, String, String, String...) +331 * @see #exportJobsToFile(String, String, String) +332 */ +333 public InputStream exportJobs(String format, String project) throws RundeckApiException, RundeckApiLoginException, +334 IllegalArgumentException { +335 AssertUtil.notBlank(format, "format is mandatory to export jobs !"); +336 return exportJobs(FileType.valueOf(StringUtils.upperCase(format)), project); +337 } +338 +339 /** +340 * Export the definitions of all jobs that belongs to the given project +341 * +342 * @param format of the export. See {@link FileType} - mandatory +343 * @param project name of the project - mandatory +344 * @return an {@link InputStream} instance, not linked to any network resources - won't be null +345 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +346 * @throws RundeckApiLoginException if the login failed +347 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the format is null +348 * @see #exportJobs(FileType, String, String, String, String...) +349 * @see #exportJobsToFile(String, FileType, String) +350 */ +351 public InputStream exportJobs(FileType format, String project) throws RundeckApiException, +352 RundeckApiLoginException, IllegalArgumentException { +353 return exportJobs(format, project, null, null, new String[0]); +354 } +355 +356 /** +357 * Export the definitions of the jobs that belongs to the given project, and matches the given criteria (jobFilter, +358 * groupPath and jobIds) +359 * +360 * @param format of the export. See {@link FileType} - mandatory +361 * @param project name of the project - mandatory +362 * @param jobFilter a filter for the job Name - optional +363 * @param groupPath a group or partial group path to include all jobs within that group path - optional +364 * @param jobIds a list of Job IDs to include - optional +365 * @return an {@link InputStream} instance, not linked to any network resources - won't be null +366 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +367 * @throws RundeckApiLoginException if the login failed +368 * @throws IllegalArgumentException if the format or project is blank (null, empty or whitespace), or the format is +369 * invalid +370 * @see #exportJobs(FileType, String, String, String, String...) +371 * @see #exportJobsToFile(String, String, String, String, String, String...) +372 */ +373 public InputStream exportJobs(String format, String project, String jobFilter, String groupPath, String... jobIds) +374 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { +375 AssertUtil.notBlank(format, "format is mandatory to export jobs !"); +376 return exportJobs(FileType.valueOf(StringUtils.upperCase(format)), project, jobFilter, groupPath, jobIds); +377 } +378 +379 /** +380 * Export the definitions of the jobs that belongs to the given project, and matches the given criteria (jobFilter, +381 * groupPath and jobIds) +382 * +383 * @param format of the export. See {@link FileType} - mandatory +384 * @param project name of the project - mandatory +385 * @param jobFilter a filter for the job Name - optional +386 * @param groupPath a group or partial group path to include all jobs within that group path - optional +387 * @param jobIds a list of Job IDs to include - optional +388 * @return an {@link InputStream} instance, not linked to any network resources - won't be null +389 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +390 * @throws RundeckApiLoginException if the login failed +391 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the format is null +392 * @see #exportJobsToFile(String, FileType, String, String, String, String...) +393 */ +394 public InputStream exportJobs(FileType format, String project, String jobFilter, String groupPath, String... jobIds) +395 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { +396 AssertUtil.notNull(format, "format is mandatory to export jobs !"); +397 AssertUtil.notBlank(project, "project is mandatory to export jobs !"); +398 return new ApiCall(this).get(new ApiPathBuilder("/jobs/export").param("format", format) +399 .param("project", project) +400 .param("jobFilter", jobFilter) +401 .param("groupPath", groupPath) +402 .param("idlist", StringUtils.join(jobIds, ","))); +403 } +404 +405 /** +406 * Export the definition of a single job (identified by the given ID) +407 * +408 * @param filename path of the file where the content should be saved - mandatory +409 * @param format of the export. See {@link FileType} - mandatory +410 * @param jobId identifier of the job - mandatory +411 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) +412 * @throws RundeckApiLoginException if the login failed +413 * @throws IllegalArgumentException if the filename, format or jobId is blank (null, empty or whitespace), or the +414 * format is invalid +415 * @throws IOException if we failed to write to the file +416 * @see #exportJobToFile(String, FileType, String) +417 * @see #exportJob(String, String) +418 * @see #getJob(String) +419 */ +420 public void exportJobToFile(String filename, String format, String jobId) throws RundeckApiException, +421 RundeckApiLoginException, IllegalArgumentException, IOException { +422 AssertUtil.notBlank(format, "format is mandatory to export a job !"); +423 exportJobToFile(filename, FileType.valueOf(StringUtils.upperCase(format)), jobId); +424 } +425 +426 /** +427 * Export the definition of a single job (identified by the given ID) +428 * +429 * @param filename path of the file where the content should be saved - mandatory +430 * @param format of the export. See {@link FileType} - mandatory +431 * @param jobId identifier of the job - mandatory +432 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) +433 * @throws RundeckApiLoginException if the login failed +434 * @throws IllegalArgumentException if the filename or jobId is blank (null, empty or whitespace), or the format is +435 * null +436 * @throws IOException if we failed to write to the file +437 * @see #exportJob(FileType, String) +438 * @see #getJob(String) +439 */ +440 public void exportJobToFile(String filename, FileType format, String jobId) throws RundeckApiException, +441 RundeckApiLoginException, IllegalArgumentException, IOException { +442 AssertUtil.notBlank(filename, "filename is mandatory to export a job !"); +443 InputStream inputStream = exportJob(format, jobId); +444 FileUtils.writeByteArrayToFile(new File(filename), IOUtils.toByteArray(inputStream)); +445 } +446 +447 /** +448 * Export the definition of a single job, identified by the given ID +449 * +450 * @param format of the export. See {@link FileType} - mandatory +451 * @param jobId identifier of the job - mandatory +452 * @return an {@link InputStream} instance, not linked to any network resources - won't be null +453 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) +454 * @throws RundeckApiLoginException if the login failed +455 * @throws IllegalArgumentException if the format or jobId is blank (null, empty or whitespace), or the format is +456 * invalid +457 * @see #exportJobToFile(String, String, String) +458 * @see #getJob(String) +459 */ +460 public InputStream exportJob(String format, String jobId) throws RundeckApiException, RundeckApiLoginException, +461 IllegalArgumentException { +462 AssertUtil.notBlank(format, "format is mandatory to export a job !"); +463 return exportJob(FileType.valueOf(StringUtils.upperCase(format)), jobId); +464 } +465 +466 /** +467 * Export the definition of a single job, identified by the given ID +468 * +469 * @param format of the export. See {@link FileType} - mandatory +470 * @param jobId identifier of the job - mandatory +471 * @return an {@link InputStream} instance, not linked to any network resources - won't be null +472 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) +473 * @throws RundeckApiLoginException if the login failed +474 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace), or the format is null +475 * @see #exportJobToFile(String, FileType, String) +476 * @see #getJob(String) +477 */ +478 public InputStream exportJob(FileType format, String jobId) throws RundeckApiException, RundeckApiLoginException, +479 IllegalArgumentException { +480 AssertUtil.notNull(format, "format is mandatory to export a job !"); +481 AssertUtil.notBlank(jobId, "jobId is mandatory to export a job !"); +482 return new ApiCall(this).get(new ApiPathBuilder("/job/", jobId).param("format", format)); +483 } +484 +485 /** +486 * Import the definitions of jobs, from the given file +487 * +488 * @param filename of the file containing the jobs definitions - mandatory +489 * @param fileType type of the file. See {@link FileType} - mandatory +490 * @return a {@link RundeckJobsImportResult} instance - won't be null +491 * @throws RundeckApiException in case of error when calling the API +492 * @throws RundeckApiLoginException if the login failed +493 * @throws IllegalArgumentException if the filename or fileType is blank (null, empty or whitespace), or the +494 * fileType is invalid +495 * @throws IOException if we failed to read the file +496 * @see #importJobs(InputStream, String) +497 * @see #importJobs(String, FileType, RundeckJobsImportMethod) +498 */ +499 public RundeckJobsImportResult importJobs(String filename, String fileType) throws RundeckApiException, +500 RundeckApiLoginException, IllegalArgumentException, IOException { +501 AssertUtil.notBlank(fileType, "fileType is mandatory to import jobs !"); +502 return importJobs(filename, FileType.valueOf(StringUtils.upperCase(fileType))); +503 } +504 +505 /** +506 * Import the definitions of jobs, from the given file +507 * +508 * @param filename of the file containing the jobs definitions - mandatory +509 * @param fileType type of the file. See {@link FileType} - mandatory +510 * @return a {@link RundeckJobsImportResult} instance - won't be null +511 * @throws RundeckApiException in case of error when calling the API +512 * @throws RundeckApiLoginException if the login failed +513 * @throws IllegalArgumentException if the filename is blank (null, empty or whitespace), or the fileType is null +514 * @throws IOException if we failed to read the file +515 * @see #importJobs(InputStream, FileType) +516 * @see #importJobs(String, FileType, RundeckJobsImportMethod) +517 */ +518 public RundeckJobsImportResult importJobs(String filename, FileType fileType) throws RundeckApiException, +519 RundeckApiLoginException, IllegalArgumentException, IOException { +520 return importJobs(filename, fileType, (RundeckJobsImportMethod) null); +521 } +522 +523 /** +524 * Import the definitions of jobs, from the given file, using the given behavior +525 * +526 * @param filename of the file containing the jobs definitions - mandatory +527 * @param fileType type of the file. See {@link FileType} - mandatory +528 * @param importBehavior see {@link RundeckJobsImportMethod} +529 * @return a {@link RundeckJobsImportResult} instance - won't be null +530 * @throws RundeckApiException in case of error when calling the API +531 * @throws RundeckApiLoginException if the login failed +532 * @throws IllegalArgumentException if the filename or fileType is blank (null, empty or whitespace), or the +533 * fileType or behavior is not valid +534 * @throws IOException if we failed to read the file +535 * @see #importJobs(InputStream, String, String) +536 * @see #importJobs(String, FileType, RundeckJobsImportMethod) +537 */ +538 public RundeckJobsImportResult importJobs(String filename, String fileType, String importBehavior) +539 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException, IOException { +540 AssertUtil.notBlank(fileType, "fileType is mandatory to import jobs !"); +541 return importJobs(filename, +542 FileType.valueOf(StringUtils.upperCase(fileType)), +543 RundeckJobsImportMethod.valueOf(StringUtils.upperCase(importBehavior))); +544 } +545 +546 /** +547 * Import the definitions of jobs, from the given file, using the given behavior +548 * +549 * @param filename of the file containing the jobs definitions - mandatory +550 * @param fileType type of the file. See {@link FileType} - mandatory +551 * @param importBehavior see {@link RundeckJobsImportMethod} +552 * @return a {@link RundeckJobsImportResult} instance - won't be null +553 * @throws RundeckApiException in case of error when calling the API +554 * @throws RundeckApiLoginException if the login failed +555 * @throws IllegalArgumentException if the filename is blank (null, empty or whitespace), or the fileType is null +556 * @throws IOException if we failed to read the file +557 * @see #importJobs(InputStream, FileType, RundeckJobsImportMethod) +558 */ +559 public RundeckJobsImportResult importJobs(String filename, FileType fileType, RundeckJobsImportMethod importBehavior) +560 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException, IOException { +561 AssertUtil.notBlank(filename, "filename (of jobs file) is mandatory to import jobs !"); +562 FileInputStream stream = null; +563 try { +564 stream = FileUtils.openInputStream(new File(filename)); +565 return importJobs(stream, fileType, importBehavior); +566 } finally { +567 IOUtils.closeQuietly(stream); +568 } +569 } +570 +571 /** +572 * Import the definitions of jobs, from the given input stream +573 * +574 * @param stream inputStream for reading the definitions - mandatory +575 * @param fileType type of the file. See {@link FileType} - mandatory +576 * @return a {@link RundeckJobsImportResult} instance - won't be null +577 * @throws RundeckApiException in case of error when calling the API +578 * @throws RundeckApiLoginException if the login failed +579 * @throws IllegalArgumentException if the stream is null, or the fileType is blank (null, empty or whitespace) or +580 * invalid +581 * @see #importJobs(String, String) +582 * @see #importJobs(InputStream, FileType, RundeckJobsImportMethod) +583 */ +584 public RundeckJobsImportResult importJobs(InputStream stream, String fileType) throws RundeckApiException, +585 RundeckApiLoginException, IllegalArgumentException { +586 AssertUtil.notBlank(fileType, "fileType is mandatory to import jobs !"); +587 return importJobs(stream, FileType.valueOf(StringUtils.upperCase(fileType))); +588 } +589 +590 /** +591 * Import the definitions of jobs, from the given input stream +592 * +593 * @param stream inputStream for reading the definitions - mandatory +594 * @param fileType type of the file. See {@link FileType} - mandatory +595 * @return a {@link RundeckJobsImportResult} instance - won't be null +596 * @throws RundeckApiException in case of error when calling the API +597 * @throws RundeckApiLoginException if the login failed +598 * @throws IllegalArgumentException if the stream or fileType is null +599 * @see #importJobs(String, FileType) +600 * @see #importJobs(InputStream, FileType, RundeckJobsImportMethod) +601 */ +602 public RundeckJobsImportResult importJobs(InputStream stream, FileType fileType) throws RundeckApiException, +603 RundeckApiLoginException, IllegalArgumentException { +604 return importJobs(stream, fileType, (RundeckJobsImportMethod) null); +605 } +606 +607 /** +608 * Import the definitions of jobs, from the given input stream, using the given behavior +609 * +610 * @param stream inputStream for reading the definitions - mandatory +611 * @param fileType type of the file. See {@link FileType} - mandatory +612 * @param importBehavior see {@link RundeckJobsImportMethod} +613 * @return a {@link RundeckJobsImportResult} instance - won't be null +614 * @throws RundeckApiException in case of error when calling the API +615 * @throws RundeckApiLoginException if the login failed +616 * @throws IllegalArgumentException if the stream is null, or the fileType is blank (null, empty or whitespace), or +617 * the fileType or behavior is not valid +618 * @see #importJobs(String, String, String) +619 * @see #importJobs(InputStream, FileType, RundeckJobsImportMethod) +620 */ +621 public RundeckJobsImportResult importJobs(InputStream stream, String fileType, String importBehavior) +622 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { +623 AssertUtil.notBlank(fileType, "fileType is mandatory to import jobs !"); +624 return importJobs(stream, +625 FileType.valueOf(StringUtils.upperCase(fileType)), +626 RundeckJobsImportMethod.valueOf(StringUtils.upperCase(importBehavior))); +627 } +628 +629 /** +630 * Import the definitions of jobs, from the given input stream, using the given behavior +631 * +632 * @param stream inputStream for reading the definitions - mandatory +633 * @param fileType type of the file. See {@link FileType} - mandatory +634 * @param importBehavior see {@link RundeckJobsImportMethod} +635 * @return a {@link RundeckJobsImportResult} instance - won't be null +636 * @throws RundeckApiException in case of error when calling the API +637 * @throws RundeckApiLoginException if the login failed +638 * @throws IllegalArgumentException if the stream or fileType is null +639 * @see #importJobs(String, FileType, RundeckJobsImportMethod) +640 */ +641 public RundeckJobsImportResult importJobs(InputStream stream, FileType fileType, +642 RundeckJobsImportMethod importBehavior) throws RundeckApiException, RundeckApiLoginException, +643 IllegalArgumentException { +644 AssertUtil.notNull(stream, "inputStream of jobs is mandatory to import jobs !"); +645 AssertUtil.notNull(fileType, "fileType is mandatory to import jobs !"); +646 return new ApiCall(this).post(new ApiPathBuilder("/jobs/import").param("format", fileType) +647 .param("dupeOption", importBehavior) +648 .attach("xmlBatch", stream), +649 new JobsImportResultParser("result")); +650 } +651 +652 /** +653 * Find a job, identified by its project, group and name. Note that the groupPath is optional, as a job does not +654 * need to belong to a group (either pass null, or an empty string). +655 * +656 * @param project name of the project - mandatory +657 * @param groupPath group to which the job belongs (if it belongs to a group) - optional +658 * @param name of the job to find - mandatory +659 * @return a {@link RundeckJob} instance - null if not found +660 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +661 * @throws RundeckApiLoginException if the login failed +662 * @throws IllegalArgumentException if the project or the name is blank (null, empty or whitespace) +663 * @see #getJob(String) +664 */ +665 public RundeckJob findJob(String project, String groupPath, String name) throws RundeckApiException, +666 RundeckApiLoginException, IllegalArgumentException { +667 AssertUtil.notBlank(project, "project is mandatory to find a job !"); +668 AssertUtil.notBlank(name, "job name is mandatory to find a job !"); +669 List<RundeckJob> jobs = getJobs(project, name, groupPath, new String[0]); +670 return jobs.isEmpty() ? null : jobs.get(0); +671 } +672 +673 /** +674 * Get the definition of a single job, identified by the given ID +675 * +676 * @param jobId identifier of the job - mandatory +677 * @return a {@link RundeckJob} instance - won't be null +678 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) +679 * @throws RundeckApiLoginException if the login failed +680 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) +681 * @see #findJob(String, String, String) +682 * @see #exportJob(String, String) +683 */ +684 public RundeckJob getJob(String jobId) throws RundeckApiException, RundeckApiLoginException, +685 IllegalArgumentException { +686 AssertUtil.notBlank(jobId, "jobId is mandatory to get the details of a job !"); +687 return new ApiCall(this).get(new ApiPathBuilder("/job/", jobId), new JobParser("joblist/job")); +688 } +689 +690 /** +691 * Delete a single job, identified by the given ID +692 * +693 * @param jobId identifier of the job - mandatory +694 * @return the success message (note that in case of error, you'll get an exception) +695 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) +696 * @throws RundeckApiLoginException if the login failed +697 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) +698 */ +699 public String deleteJob(String jobId) throws RundeckApiException, RundeckApiLoginException, +700 IllegalArgumentException { +701 AssertUtil.notBlank(jobId, "jobId is mandatory to delete a job !"); +702 return new ApiCall(this).delete(new ApiPathBuilder("/job/", jobId), new StringParser("result/success/message")); +703 } +704 +705 /** +706 * Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the +707 * end of the job execution) +708 * +709 * @param jobId identifier of the job - mandatory +710 * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null +711 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) +712 * @throws RundeckApiLoginException if the login failed +713 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) +714 * @see #triggerJob(String, Properties, Properties) +715 * @see #runJob(String) +716 */ +717 public RundeckExecution triggerJob(String jobId) throws RundeckApiException, RundeckApiLoginException, +718 IllegalArgumentException { +719 return triggerJob(jobId, null); +720 } +721 +722 /** +723 * Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the +724 * end of the job execution) +725 * +726 * @param jobId identifier of the job - mandatory +727 * @param options of the job - optional. See {@link OptionsBuilder}. +728 * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null +729 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) +730 * @throws RundeckApiLoginException if the login failed +731 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) +732 * @see #triggerJob(String, Properties, Properties) +733 * @see #runJob(String, Properties) +734 */ +735 public RundeckExecution triggerJob(String jobId, Properties options) throws RundeckApiException, +736 RundeckApiLoginException, IllegalArgumentException { +737 return triggerJob(jobId, options, null); +738 } +739 +740 /** +741 * Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the +742 * end of the job execution) +743 * +744 * @param jobId identifier of the job - mandatory +745 * @param options of the job - optional. See {@link OptionsBuilder}. +746 * @param nodeFilters for overriding the nodes on which the job will be executed - optional. See +747 * {@link NodeFiltersBuilder} +748 * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null +749 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) +750 * @throws RundeckApiLoginException if the login failed +751 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) +752 * @see #triggerJob(String) +753 * @see #runJob(String, Properties, Properties) +754 */ +755 public RundeckExecution triggerJob(String jobId, Properties options, Properties nodeFilters) +756 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { +757 AssertUtil.notBlank(jobId, "jobId is mandatory to trigger a job !"); +758 return new ApiCall(this).get(new ApiPathBuilder("/job/", jobId, "/run").param("argString", +759 ParametersUtil.generateArgString(options)) +760 .nodeFilters(nodeFilters), +761 new ExecutionParser("result/executions/execution")); +762 } +763 +764 /** +765 * Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return. +766 * We will poll the RunDeck server at regular interval (every 5 seconds) to know if the execution is finished (or +767 * aborted) or is still running. +768 * +769 * @param jobId identifier of the job - mandatory +770 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +771 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) +772 * @throws RundeckApiLoginException if the login failed +773 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) +774 * @see #triggerJob(String) +775 * @see #runJob(String, Properties, Properties, long, TimeUnit) +776 */ +777 public RundeckExecution runJob(String jobId) throws RundeckApiException, RundeckApiLoginException, +778 IllegalArgumentException { +779 return runJob(jobId, null); +780 } +781 +782 /** +783 * Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return. +784 * We will poll the RunDeck server at regular interval (every 5 seconds) to know if the execution is finished (or +785 * aborted) or is still running. +786 * +787 * @param jobId identifier of the job - mandatory +788 * @param options of the job - optional. See {@link OptionsBuilder}. +789 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +790 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) +791 * @throws RundeckApiLoginException if the login failed +792 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) +793 * @see #triggerJob(String, Properties) +794 * @see #runJob(String, Properties, Properties, long, TimeUnit) +795 */ +796 public RundeckExecution runJob(String jobId, Properties options) throws RundeckApiException, +797 RundeckApiLoginException, IllegalArgumentException { +798 return runJob(jobId, options, null); +799 } +800 +801 /** +802 * Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return. +803 * We will poll the RunDeck server at regular interval (every 5 seconds) to know if the execution is finished (or +804 * aborted) or is still running. +805 * +806 * @param jobId identifier of the job - mandatory +807 * @param options of the job - optional. See {@link OptionsBuilder}. +808 * @param nodeFilters for overriding the nodes on which the job will be executed - optional. See +809 * {@link NodeFiltersBuilder} +810 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +811 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) +812 * @throws RundeckApiLoginException if the login failed +813 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) +814 * @see #triggerJob(String, Properties, Properties) +815 * @see #runJob(String, Properties, Properties, long, TimeUnit) +816 */ +817 public RundeckExecution runJob(String jobId, Properties options, Properties nodeFilters) +818 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { +819 return runJob(jobId, options, nodeFilters, DEFAULT_POOLING_INTERVAL, DEFAULT_POOLING_UNIT); +820 } +821 +822 /** +823 * Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return. +824 * We will poll the RunDeck server at regular interval (configured by the poolingInterval/poolingUnit couple) to +825 * know if the execution is finished (or aborted) or is still running. +826 * +827 * @param jobId identifier of the job - mandatory +828 * @param options of the job - optional. See {@link OptionsBuilder}. +829 * @param poolingInterval for checking the status of the execution. Must be > 0. +830 * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds. +831 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +832 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) +833 * @throws RundeckApiLoginException if the login failed +834 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) +835 * @see #triggerJob(String, Properties) +836 * @see #runJob(String, Properties, Properties, long, TimeUnit) +837 */ +838 public RundeckExecution runJob(String jobId, Properties options, long poolingInterval, TimeUnit poolingUnit) +839 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { +840 return runJob(jobId, options, null, poolingInterval, poolingUnit); +841 } +842 +843 /** +844 * Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return. +845 * We will poll the RunDeck server at regular interval (configured by the poolingInterval/poolingUnit couple) to +846 * know if the execution is finished (or aborted) or is still running. +847 * +848 * @param jobId identifier of the job - mandatory +849 * @param options of the job - optional. See {@link OptionsBuilder}. +850 * @param nodeFilters for overriding the nodes on which the job will be executed - optional. See +851 * {@link NodeFiltersBuilder} +852 * @param poolingInterval for checking the status of the execution. Must be > 0. +853 * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds. +854 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +855 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) +856 * @throws RundeckApiLoginException if the login failed +857 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) +858 * @see #triggerJob(String, Properties) +859 * @see #runJob(String, Properties, Properties, long, TimeUnit) +860 */ +861 public RundeckExecution runJob(String jobId, Properties options, Properties nodeFilters, long poolingInterval, +862 TimeUnit poolingUnit) throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { +863 if (poolingInterval <= 0) { +864 poolingInterval = DEFAULT_POOLING_INTERVAL; +865 poolingUnit = DEFAULT_POOLING_UNIT; +866 } +867 if (poolingUnit == null) { +868 poolingUnit = DEFAULT_POOLING_UNIT; +869 } +870 +871 RundeckExecution execution = triggerJob(jobId, options, nodeFilters); +872 while (ExecutionStatus.RUNNING.equals(execution.getStatus())) { +873 try { +874 Thread.sleep(poolingUnit.toMillis(poolingInterval)); +875 } catch (InterruptedException e) { +876 break; +877 } +878 execution = getExecution(execution.getId()); +879 } +880 return execution; +881 } +882 +883 /* +884 * Ad-hoc commands +885 */ +886 +887 /** +888 * Trigger the execution of an ad-hoc command, and return immediately (without waiting the end of the execution). +889 * The command will not be dispatched to nodes, but be executed on the RunDeck server. +890 * +891 * @param project name of the project - mandatory +892 * @param command to be executed - mandatory +893 * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null +894 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +895 * @throws RundeckApiLoginException if the login failed +896 * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace) +897 * @see #triggerAdhocCommand(String, String, Properties, Integer, Boolean) +898 * @see #runAdhocCommand(String, String) +899 */ +900 public RundeckExecution triggerAdhocCommand(String project, String command) throws RundeckApiException, +901 RundeckApiLoginException, IllegalArgumentException { +902 return triggerAdhocCommand(project, command, null); +903 } +904 +905 /** +906 * Trigger the execution of an ad-hoc command, and return immediately (without waiting the end of the execution). +907 * The command will be dispatched to nodes, accordingly to the nodeFilters parameter. +908 * +909 * @param project name of the project - mandatory +910 * @param command to be executed - mandatory +911 * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder} +912 * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null +913 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +914 * @throws RundeckApiLoginException if the login failed +915 * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace) +916 * @see #triggerAdhocCommand(String, String, Properties, Integer, Boolean) +917 * @see #runAdhocCommand(String, String, Properties) +918 */ +919 public RundeckExecution triggerAdhocCommand(String project, String command, Properties nodeFilters) +920 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { +921 return triggerAdhocCommand(project, command, nodeFilters, null, null); +922 } +923 +924 /** +925 * Trigger the execution of an ad-hoc command, and return immediately (without waiting the end of the execution). +926 * The command will be dispatched to nodes, accordingly to the nodeFilters parameter. +927 * +928 * @param project name of the project - mandatory +929 * @param command to be executed - mandatory +930 * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder} +931 * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional +932 * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional +933 * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null +934 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +935 * @throws RundeckApiLoginException if the login failed +936 * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace) +937 * @see #triggerAdhocCommand(String, String) +938 * @see #runAdhocCommand(String, String, Properties) +939 */ +940 public RundeckExecution triggerAdhocCommand(String project, String command, Properties nodeFilters, +941 Integer nodeThreadcount, Boolean nodeKeepgoing) throws RundeckApiException, RundeckApiLoginException, +942 IllegalArgumentException { +943 AssertUtil.notBlank(project, "project is mandatory to trigger an ad-hoc command !"); +944 AssertUtil.notBlank(command, "command is mandatory to trigger an ad-hoc command !"); +945 RundeckExecution execution = new ApiCall(this).get(new ApiPathBuilder("/run/command").param("project", project) +946 .param("exec", command) +947 .param("nodeThreadcount", +948 nodeThreadcount) +949 .param("nodeKeepgoing", +950 nodeKeepgoing) +951 .nodeFilters(nodeFilters), +952 new ExecutionParser("result/execution")); +953 // the first call just returns the ID of the execution, so we need another call to get a "real" execution +954 return getExecution(execution.getId()); +955 } +956 +957 /** +958 * Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck +959 * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still +960 * running. The command will not be dispatched to nodes, but be executed on the RunDeck server. +961 * +962 * @param project name of the project - mandatory +963 * @param command to be executed - mandatory +964 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +965 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +966 * @throws RundeckApiLoginException if the login failed +967 * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace) +968 * @see #runAdhocCommand(String, String, Properties, Integer, Boolean, long, TimeUnit) +969 * @see #triggerAdhocCommand(String, String) +970 */ +971 public RundeckExecution runAdhocCommand(String project, String command) throws RundeckApiException, +972 RundeckApiLoginException, IllegalArgumentException { +973 return runAdhocCommand(project, command, null); +974 } +975 +976 /** +977 * Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck +978 * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is +979 * finished (or aborted) or is still running. The command will not be dispatched to nodes, but be executed on the +980 * RunDeck server. +981 * +982 * @param project name of the project - mandatory +983 * @param command to be executed - mandatory +984 * @param poolingInterval for checking the status of the execution. Must be > 0. +985 * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds. +986 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +987 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +988 * @throws RundeckApiLoginException if the login failed +989 * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace) +990 * @see #runAdhocCommand(String, String, Properties, Integer, Boolean, long, TimeUnit) +991 * @see #triggerAdhocCommand(String, String) +992 */ +993 public RundeckExecution runAdhocCommand(String project, String command, long poolingInterval, TimeUnit poolingUnit) +994 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { +995 return runAdhocCommand(project, command, null, poolingInterval, poolingUnit); +996 } +997 +998 /** +999 * Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck +1000 * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still +1001 * running. The command will be dispatched to nodes, accordingly to the nodeFilters parameter. +1002 * +1003 * @param project name of the project - mandatory +1004 * @param command to be executed - mandatory +1005 * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder} +1006 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +1007 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1008 * @throws RundeckApiLoginException if the login failed +1009 * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace) +1010 * @see #runAdhocCommand(String, String, Properties, Integer, Boolean, long, TimeUnit) +1011 * @see #triggerAdhocCommand(String, String, Properties) +1012 */ +1013 public RundeckExecution runAdhocCommand(String project, String command, Properties nodeFilters) +1014 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { +1015 return runAdhocCommand(project, command, nodeFilters, null, null); +1016 } +1017 +1018 /** +1019 * Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck +1020 * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is +1021 * finished (or aborted) or is still running. The command will be dispatched to nodes, accordingly to the +1022 * nodeFilters parameter. +1023 * +1024 * @param project name of the project - mandatory +1025 * @param command to be executed - mandatory +1026 * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder} +1027 * @param poolingInterval for checking the status of the execution. Must be > 0. +1028 * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds. +1029 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +1030 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1031 * @throws RundeckApiLoginException if the login failed +1032 * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace) +1033 * @see #runAdhocCommand(String, String, Properties, Integer, Boolean, long, TimeUnit) +1034 * @see #triggerAdhocCommand(String, String, Properties) +1035 */ +1036 public RundeckExecution runAdhocCommand(String project, String command, Properties nodeFilters, +1037 long poolingInterval, TimeUnit poolingUnit) throws RundeckApiException, RundeckApiLoginException, +1038 IllegalArgumentException { +1039 return runAdhocCommand(project, command, nodeFilters, null, null, poolingInterval, poolingUnit); +1040 } +1041 +1042 /** +1043 * Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck +1044 * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still +1045 * running. The command will be dispatched to nodes, accordingly to the nodeFilters parameter. +1046 * +1047 * @param project name of the project - mandatory +1048 * @param command to be executed - mandatory +1049 * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder} +1050 * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional +1051 * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional +1052 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +1053 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1054 * @throws RundeckApiLoginException if the login failed +1055 * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace) +1056 * @see #runAdhocCommand(String, String, Properties, Integer, Boolean, long, TimeUnit) +1057 * @see #triggerAdhocCommand(String, String, Properties, Integer, Boolean) +1058 */ +1059 public RundeckExecution runAdhocCommand(String project, String command, Properties nodeFilters, +1060 Integer nodeThreadcount, Boolean nodeKeepgoing) throws RundeckApiException, RundeckApiLoginException, +1061 IllegalArgumentException { +1062 return runAdhocCommand(project, +1063 command, +1064 nodeFilters, +1065 nodeThreadcount, +1066 nodeKeepgoing, +1067 DEFAULT_POOLING_INTERVAL, +1068 DEFAULT_POOLING_UNIT); +1069 } +1070 +1071 /** +1072 * Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck +1073 * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is +1074 * finished (or aborted) or is still running. The command will be dispatched to nodes, accordingly to the +1075 * nodeFilters parameter. +1076 * +1077 * @param project name of the project - mandatory +1078 * @param command to be executed - mandatory +1079 * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder} +1080 * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional +1081 * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional +1082 * @param poolingInterval for checking the status of the execution. Must be > 0. +1083 * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds. +1084 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +1085 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1086 * @throws RundeckApiLoginException if the login failed +1087 * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace) +1088 * @see #triggerAdhocCommand(String, String, Properties, Integer, Boolean) +1089 */ +1090 public RundeckExecution runAdhocCommand(String project, String command, Properties nodeFilters, +1091 Integer nodeThreadcount, Boolean nodeKeepgoing, long poolingInterval, TimeUnit poolingUnit) +1092 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { +1093 if (poolingInterval <= 0) { +1094 poolingInterval = DEFAULT_POOLING_INTERVAL; +1095 poolingUnit = DEFAULT_POOLING_UNIT; +1096 } +1097 if (poolingUnit == null) { +1098 poolingUnit = DEFAULT_POOLING_UNIT; +1099 } +1100 +1101 RundeckExecution execution = triggerAdhocCommand(project, command, nodeFilters, nodeThreadcount, nodeKeepgoing); +1102 while (ExecutionStatus.RUNNING.equals(execution.getStatus())) { +1103 try { +1104 Thread.sleep(poolingUnit.toMillis(poolingInterval)); +1105 } catch (InterruptedException e) { +1106 break; +1107 } +1108 execution = getExecution(execution.getId()); 1109 } -1110 return executions; +1110 return execution; 1111 } 1112 -1113 /** -1114 * Get the running executions for the given project -1115 * -1116 * @param project name of the project - mandatory -1117 * @return a {@link List} of {@link RundeckExecution} : might be empty, but won't be null -1118 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) -1119 * @throws RundeckApiLoginException if the login failed -1120 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) -1121 * @see #getRunningExecutions() -1122 */ -1123 public List<RundeckExecution> getRunningExecutions(String project) throws RundeckApiException, -1124 RundeckApiLoginException, IllegalArgumentException { -1125 AssertUtil.notBlank(project, "project is mandatory get all running executions !"); -1126 return new ApiCall(this).get(new ApiPathBuilder("/executions/running").param("project", project), -1127 new ListParser<RundeckExecution>(new ExecutionParser(), -1128 "result/executions/execution")); -1129 } -1130 -1131 /** -1132 * Get the executions of the given job -1133 * -1134 * @param jobId identifier of the job - mandatory -1135 * @return a {@link List} of {@link RundeckExecution} : might be empty, but won't be null -1136 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) -1137 * @throws RundeckApiLoginException if the login failed -1138 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) -1139 * @see #getJobExecutions(String, ExecutionStatus, Long, Long) -1140 */ -1141 public List<RundeckExecution> getJobExecutions(String jobId) throws RundeckApiException, RundeckApiLoginException, -1142 IllegalArgumentException { -1143 return getJobExecutions(jobId, (ExecutionStatus) null); -1144 } -1145 -1146 /** -1147 * Get the executions of the given job -1148 * -1149 * @param jobId identifier of the job - mandatory -1150 * @param status of the executions, see {@link ExecutionStatus} - optional (null for all) -1151 * @return a {@link List} of {@link RundeckExecution} : might be empty, but won't be null -1152 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) -1153 * @throws RundeckApiLoginException if the login failed -1154 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace), or the executionStatus is -1155 * invalid -1156 * @see #getJobExecutions(String, ExecutionStatus, Long, Long) -1157 */ -1158 public List<RundeckExecution> getJobExecutions(String jobId, String status) throws RundeckApiException, -1159 RundeckApiLoginException, IllegalArgumentException { -1160 return getJobExecutions(jobId, -1161 StringUtils.isBlank(status) ? null : ExecutionStatus.valueOf(StringUtils.upperCase(status))); -1162 } -1163 -1164 /** -1165 * Get the executions of the given job -1166 * -1167 * @param jobId identifier of the job - mandatory -1168 * @param status of the executions, see {@link ExecutionStatus} - optional (null for all) -1169 * @return a {@link List} of {@link RundeckExecution} : might be empty, but won't be null -1170 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) -1171 * @throws RundeckApiLoginException if the login failed -1172 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) -1173 * @see #getJobExecutions(String, ExecutionStatus, Long, Long) -1174 */ -1175 public List<RundeckExecution> getJobExecutions(String jobId, ExecutionStatus status) throws RundeckApiException, -1176 RundeckApiLoginException, IllegalArgumentException { -1177 return getJobExecutions(jobId, status, null, null); -1178 } -1179 -1180 /** -1181 * Get the executions of the given job -1182 * -1183 * @param jobId identifier of the job - mandatory -1184 * @param status of the executions, see {@link ExecutionStatus} - optional (null for all) -1185 * @param max number of results to return - optional (null for all) -1186 * @param offset the 0-indexed offset for the first result to return - optional -1187 * @return a {@link List} of {@link RundeckExecution} : might be empty, but won't be null -1188 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) -1189 * @throws RundeckApiLoginException if the login failed -1190 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace), or the executionStatus is -1191 * invalid -1192 * @see #getJobExecutions(String, ExecutionStatus, Long, Long) -1193 */ -1194 public List<RundeckExecution> getJobExecutions(String jobId, String status, Long max, Long offset) -1195 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { -1196 return getJobExecutions(jobId, -1197 StringUtils.isBlank(status) ? null : ExecutionStatus.valueOf(StringUtils.upperCase(status)), -1198 max, -1199 offset); -1200 } -1201 -1202 /** -1203 * Get the executions of the given job -1204 * -1205 * @param jobId identifier of the job - mandatory -1206 * @param status of the executions, see {@link ExecutionStatus} - optional (null for all) -1207 * @param max number of results to return - optional (null for all) -1208 * @param offset the 0-indexed offset for the first result to return - optional -1209 * @return a {@link List} of {@link RundeckExecution} : might be empty, but won't be null -1210 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) -1211 * @throws RundeckApiLoginException if the login failed -1212 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) -1213 */ -1214 public List<RundeckExecution> getJobExecutions(String jobId, ExecutionStatus status, Long max, Long offset) -1215 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { -1216 AssertUtil.notBlank(jobId, "jobId is mandatory to get the executions of a job !"); -1217 return new ApiCall(this).get(new ApiPathBuilder("/job/", jobId, "/executions").param("status", status) -1218 .param("max", max) -1219 .param("offset", offset), -1220 new ListParser<RundeckExecution>(new ExecutionParser(), -1221 "result/executions/execution")); -1222 } -1223 -1224 /** -1225 * Get a single execution, identified by the given ID -1226 * -1227 * @param executionId identifier of the execution - mandatory -1228 * @return a {@link RundeckExecution} instance - won't be null -1229 * @throws RundeckApiException in case of error when calling the API (non-existent execution with this ID) -1230 * @throws RundeckApiLoginException if the login failed -1231 * @throws IllegalArgumentException if the executionId is null -1232 */ -1233 public RundeckExecution getExecution(Long executionId) throws RundeckApiException, RundeckApiLoginException, -1234 IllegalArgumentException { -1235 AssertUtil.notNull(executionId, "executionId is mandatory to get the details of an execution !"); -1236 return new ApiCall(this).get(new ApiPathBuilder("/execution/", executionId.toString()), -1237 new ExecutionParser("result/executions/execution")); -1238 } -1239 -1240 /** -1241 * Abort an execution (identified by the given ID). The execution should be running... -1242 * -1243 * @param executionId identifier of the execution - mandatory -1244 * @return a {@link RundeckAbort} instance - won't be null -1245 * @throws RundeckApiException in case of error when calling the API (non-existent execution with this ID) -1246 * @throws RundeckApiLoginException if the login failed -1247 * @throws IllegalArgumentException if the executionId is null -1248 */ -1249 public RundeckAbort abortExecution(Long executionId) throws RundeckApiException, RundeckApiLoginException, -1250 IllegalArgumentException { -1251 AssertUtil.notNull(executionId, "executionId is mandatory to abort an execution !"); -1252 return new ApiCall(this).get(new ApiPathBuilder("/execution/", executionId.toString(), "/abort"), -1253 new AbortParser("result/abort")); -1254 } -1255 -1256 /* -1257 * Nodes -1258 */ -1259 -1260 /** -1261 * List all nodes (for all projects) -1262 * -1263 * @return a {@link List} of {@link RundeckNode} : might be empty, but won't be null -1264 * @throws RundeckApiException in case of error when calling the API -1265 * @throws RundeckApiLoginException if the login failed -1266 */ -1267 public List<RundeckNode> getNodes() throws RundeckApiException, RundeckApiLoginException { -1268 List<RundeckNode> nodes = new ArrayList<RundeckNode>(); -1269 for (RundeckProject project : getProjects()) { -1270 nodes.addAll(getNodes(project.getName())); -1271 } -1272 return nodes; -1273 } -1274 -1275 /** -1276 * List all nodes that belongs to the given project -1277 * -1278 * @param project name of the project - mandatory -1279 * @return a {@link List} of {@link RundeckNode} : might be empty, but won't be null -1280 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) -1281 * @throws RundeckApiLoginException if the login failed -1282 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) -1283 * @see #getNodes(String, Properties) -1284 */ -1285 public List<RundeckNode> getNodes(String project) throws RundeckApiException, RundeckApiLoginException, -1286 IllegalArgumentException { -1287 return getNodes(project, null); -1288 } -1289 -1290 /** -1291 * List nodes that belongs to the given project -1292 * -1293 * @param project name of the project - mandatory -1294 * @param nodeFilters for filtering the nodes - optional. See {@link NodeFiltersBuilder} -1295 * @return a {@link List} of {@link RundeckNode} : might be empty, but won't be null -1296 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) -1297 * @throws RundeckApiLoginException if the login failed -1298 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) -1299 */ -1300 public List<RundeckNode> getNodes(String project, Properties nodeFilters) throws RundeckApiException, -1301 RundeckApiLoginException, IllegalArgumentException { -1302 AssertUtil.notBlank(project, "project is mandatory to get all nodes !"); -1303 return new ApiCall(this).get(new ApiPathBuilder("/resources").param("project", project) -1304 .nodeFilters(nodeFilters), -1305 new ListParser<RundeckNode>(new NodeParser(), "project/node")); -1306 } -1307 -1308 /** -1309 * Get the definition of a single node -1310 * -1311 * @param name of the node - mandatory -1312 * @param project name of the project - mandatory -1313 * @return a {@link RundeckNode} instance - won't be null -1314 * @throws RundeckApiException in case of error when calling the API (non-existent name or project with this name) -1315 * @throws RundeckApiLoginException if the login failed -1316 * @throws IllegalArgumentException if the name or project is blank (null, empty or whitespace) +1113 /* +1114 * Ad-hoc scripts +1115 */ +1116 +1117 /** +1118 * Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The +1119 * script will not be dispatched to nodes, but be executed on the RunDeck server. +1120 * +1121 * @param project name of the project - mandatory +1122 * @param scriptFilename filename of the script to be executed - mandatory +1123 * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null +1124 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1125 * @throws RundeckApiLoginException if the login failed +1126 * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace) +1127 * @throws IOException if we failed to read the file +1128 * @see #triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean) +1129 * @see #runAdhocScript(String, String) +1130 */ +1131 public RundeckExecution triggerAdhocScript(String project, String scriptFilename) throws RundeckApiException, +1132 RundeckApiLoginException, IllegalArgumentException, IOException { +1133 return triggerAdhocScript(project, scriptFilename, null); +1134 } +1135 +1136 /** +1137 * Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The +1138 * script will not be dispatched to nodes, but be executed on the RunDeck server. +1139 * +1140 * @param project name of the project - mandatory +1141 * @param scriptFilename filename of the script to be executed - mandatory +1142 * @param options of the script - optional. See {@link OptionsBuilder}. +1143 * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null +1144 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1145 * @throws RundeckApiLoginException if the login failed +1146 * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace) +1147 * @throws IOException if we failed to read the file +1148 * @see #triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean) +1149 * @see #runAdhocScript(String, String, Properties) +1150 */ +1151 public RundeckExecution triggerAdhocScript(String project, String scriptFilename, Properties options) +1152 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException, IOException { +1153 return triggerAdhocScript(project, scriptFilename, options, null); +1154 } +1155 +1156 /** +1157 * Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The +1158 * script will be dispatched to nodes, accordingly to the nodeFilters parameter. +1159 * +1160 * @param project name of the project - mandatory +1161 * @param scriptFilename filename of the script to be executed - mandatory +1162 * @param options of the script - optional. See {@link OptionsBuilder}. +1163 * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder} +1164 * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null +1165 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1166 * @throws RundeckApiLoginException if the login failed +1167 * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace) +1168 * @throws IOException if we failed to read the file +1169 * @see #triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean) +1170 * @see #runAdhocScript(String, String, Properties, Properties) +1171 */ +1172 public RundeckExecution triggerAdhocScript(String project, String scriptFilename, Properties options, +1173 Properties nodeFilters) throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException, +1174 IOException { +1175 return triggerAdhocScript(project, scriptFilename, options, nodeFilters, null, null); +1176 } +1177 +1178 /** +1179 * Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The +1180 * script will be dispatched to nodes, accordingly to the nodeFilters parameter. +1181 * +1182 * @param project name of the project - mandatory +1183 * @param scriptFilename filename of the script to be executed - mandatory +1184 * @param options of the script - optional. See {@link OptionsBuilder}. +1185 * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder} +1186 * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional +1187 * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional +1188 * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null +1189 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1190 * @throws RundeckApiLoginException if the login failed +1191 * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace) +1192 * @throws IOException if we failed to read the file +1193 * @see #triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean) +1194 * @see #runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit) +1195 */ +1196 public RundeckExecution triggerAdhocScript(String project, String scriptFilename, Properties options, +1197 Properties nodeFilters, Integer nodeThreadcount, Boolean nodeKeepgoing) throws RundeckApiException, +1198 RundeckApiLoginException, IllegalArgumentException, IOException { +1199 AssertUtil.notBlank(scriptFilename, "scriptFilename is mandatory to trigger an ad-hoc script !"); +1200 FileInputStream stream = null; +1201 try { +1202 stream = FileUtils.openInputStream(new File(scriptFilename)); +1203 return triggerAdhocScript(project, stream, options, nodeFilters, nodeThreadcount, nodeKeepgoing); +1204 } finally { +1205 IOUtils.closeQuietly(stream); +1206 } +1207 } +1208 +1209 /** +1210 * Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The +1211 * script will not be dispatched to nodes, but be executed on the RunDeck server. +1212 * +1213 * @param project name of the project - mandatory +1214 * @param script inputStream for reading the script to be executed - mandatory +1215 * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null +1216 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1217 * @throws RundeckApiLoginException if the login failed +1218 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null +1219 * @see #triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean) +1220 * @see #runAdhocScript(String, InputStream) +1221 */ +1222 public RundeckExecution triggerAdhocScript(String project, InputStream script) throws RundeckApiException, +1223 RundeckApiLoginException, IllegalArgumentException { +1224 return triggerAdhocScript(project, script, null); +1225 } +1226 +1227 /** +1228 * Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The +1229 * script will not be dispatched to nodes, but be executed on the RunDeck server. +1230 * +1231 * @param project name of the project - mandatory +1232 * @param script inputStream for reading the script to be executed - mandatory +1233 * @param options of the script - optional. See {@link OptionsBuilder}. +1234 * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null +1235 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1236 * @throws RundeckApiLoginException if the login failed +1237 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null +1238 * @see #triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean) +1239 * @see #runAdhocScript(String, InputStream, Properties) +1240 */ +1241 public RundeckExecution triggerAdhocScript(String project, InputStream script, Properties options) +1242 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { +1243 return triggerAdhocScript(project, script, options, null); +1244 } +1245 +1246 /** +1247 * Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The +1248 * script will be dispatched to nodes, accordingly to the nodeFilters parameter. +1249 * +1250 * @param project name of the project - mandatory +1251 * @param script inputStream for reading the script to be executed - mandatory +1252 * @param options of the script - optional. See {@link OptionsBuilder}. +1253 * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder} +1254 * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null +1255 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1256 * @throws RundeckApiLoginException if the login failed +1257 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null +1258 * @see #triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean) +1259 * @see #runAdhocScript(String, InputStream, Properties, Properties) +1260 */ +1261 public RundeckExecution triggerAdhocScript(String project, InputStream script, Properties options, +1262 Properties nodeFilters) throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { +1263 return triggerAdhocScript(project, script, options, nodeFilters, null, null); +1264 } +1265 +1266 /** +1267 * Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The +1268 * script will be dispatched to nodes, accordingly to the nodeFilters parameter. +1269 * +1270 * @param project name of the project - mandatory +1271 * @param script inputStream for reading the script to be executed - mandatory +1272 * @param options of the script - optional. See {@link OptionsBuilder}. +1273 * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder} +1274 * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional +1275 * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional +1276 * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null +1277 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1278 * @throws RundeckApiLoginException if the login failed +1279 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null +1280 * @see #triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean) +1281 * @see #runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit) +1282 */ +1283 public RundeckExecution triggerAdhocScript(String project, InputStream script, Properties options, +1284 Properties nodeFilters, Integer nodeThreadcount, Boolean nodeKeepgoing) throws RundeckApiException, +1285 RundeckApiLoginException, IllegalArgumentException { +1286 AssertUtil.notBlank(project, "project is mandatory to trigger an ad-hoc script !"); +1287 AssertUtil.notNull(script, "script is mandatory to trigger an ad-hoc script !"); +1288 RundeckExecution execution = new ApiCall(this).post(new ApiPathBuilder("/run/script").param("project", project) +1289 .attach("scriptFile", +1290 script) +1291 .param("argString", +1292 ParametersUtil.generateArgString(options)) +1293 .param("nodeThreadcount", +1294 nodeThreadcount) +1295 .param("nodeKeepgoing", +1296 nodeKeepgoing) +1297 .nodeFilters(nodeFilters), +1298 new ExecutionParser("result/execution")); +1299 // the first call just returns the ID of the execution, so we need another call to get a "real" execution +1300 return getExecution(execution.getId()); +1301 } +1302 +1303 /** +1304 * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck +1305 * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still +1306 * running. The script will not be dispatched to nodes, but be executed on the RunDeck server. +1307 * +1308 * @param project name of the project - mandatory +1309 * @param scriptFilename filename of the script to be executed - mandatory +1310 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +1311 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1312 * @throws RundeckApiLoginException if the login failed +1313 * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace) +1314 * @throws IOException if we failed to read the file +1315 * @see #runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit) +1316 * @see #triggerAdhocScript(String, String) 1317 */ -1318 public RundeckNode getNode(String name, String project) throws RundeckApiException, RundeckApiLoginException, -1319 IllegalArgumentException { -1320 AssertUtil.notBlank(name, "the name of the node is mandatory to get a node !"); -1321 AssertUtil.notBlank(project, "project is mandatory to get a node !"); -1322 return new ApiCall(this).get(new ApiPathBuilder("/resource/", name).param("project", project), -1323 new NodeParser("project/node")); -1324 } -1325 -1326 /* -1327 * System Info -1328 */ -1329 -1330 /** -1331 * Get system informations about the RunDeck server -1332 * -1333 * @return a {@link RundeckSystemInfo} instance - won't be null -1334 * @throws RundeckApiException in case of error when calling the API -1335 * @throws RundeckApiException if the login failed -1336 */ -1337 public RundeckSystemInfo getSystemInfo() throws RundeckApiException, RundeckApiLoginException { -1338 return new ApiCall(this).get(new ApiPathBuilder("/system/info"), new SystemInfoParser("result/system")); -1339 } -1340 -1341 public String getUrl() { -1342 return url; -1343 } -1344 -1345 public String getLogin() { -1346 return login; -1347 } -1348 -1349 public String getPassword() { -1350 return password; -1351 } -1352 -1353 @Override -1354 public String toString() { -1355 return "RundeckClient [url=" + url + ", login=" + login + ", password=" + password + "]"; -1356 } -1357 -1358 @Override -1359 public int hashCode() { -1360 final int prime = 31; -1361 int result = 1; -1362 result = prime * result + ((login == null) ? 0 : login.hashCode()); -1363 result = prime * result + ((password == null) ? 0 : password.hashCode()); -1364 result = prime * result + ((url == null) ? 0 : url.hashCode()); -1365 return result; +1318 public RundeckExecution runAdhocScript(String project, String scriptFilename) throws RundeckApiException, +1319 RundeckApiLoginException, IllegalArgumentException, IOException { +1320 return runAdhocScript(project, scriptFilename, null); +1321 } +1322 +1323 /** +1324 * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck +1325 * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is +1326 * finished (or aborted) or is still running. The script will not be dispatched to nodes, but be executed on the +1327 * RunDeck server. +1328 * +1329 * @param project name of the project - mandatory +1330 * @param scriptFilename filename of the script to be executed - mandatory +1331 * @param poolingInterval for checking the status of the execution. Must be > 0. +1332 * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds. +1333 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +1334 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1335 * @throws RundeckApiLoginException if the login failed +1336 * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace) +1337 * @throws IOException if we failed to read the file +1338 * @see #runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit) +1339 * @see #triggerAdhocScript(String, String) +1340 */ +1341 public RundeckExecution runAdhocScript(String project, String scriptFilename, long poolingInterval, +1342 TimeUnit poolingUnit) throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException, +1343 IOException { +1344 return runAdhocScript(project, scriptFilename, null, poolingInterval, poolingUnit); +1345 } +1346 +1347 /** +1348 * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck +1349 * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still +1350 * running. The script will not be dispatched to nodes, but be executed on the RunDeck server. +1351 * +1352 * @param project name of the project - mandatory +1353 * @param scriptFilename filename of the script to be executed - mandatory +1354 * @param options of the script - optional. See {@link OptionsBuilder}. +1355 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +1356 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1357 * @throws RundeckApiLoginException if the login failed +1358 * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace) +1359 * @throws IOException if we failed to read the file +1360 * @see #runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit) +1361 * @see #triggerAdhocScript(String, String, Properties) +1362 */ +1363 public RundeckExecution runAdhocScript(String project, String scriptFilename, Properties options) +1364 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException, IOException { +1365 return runAdhocScript(project, scriptFilename, options, null); 1366 } 1367 -1368 @Override -1369 public boolean equals(Object obj) { -1370 if (this == obj) -1371 return true; -1372 if (obj == null) -1373 return false; -1374 if (getClass() != obj.getClass()) -1375 return false; -1376 RundeckClient other = (RundeckClient) obj; -1377 if (login == null) { -1378 if (other.login != null) -1379 return false; -1380 } else if (!login.equals(other.login)) -1381 return false; -1382 if (password == null) { -1383 if (other.password != null) -1384 return false; -1385 } else if (!password.equals(other.password)) -1386 return false; -1387 if (url == null) { -1388 if (other.url != null) -1389 return false; -1390 } else if (!url.equals(other.url)) -1391 return false; -1392 return true; -1393 } -1394 -1395 } +1368 /** +1369 * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck +1370 * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is +1371 * finished (or aborted) or is still running. The script will not be dispatched to nodes, but be executed on the +1372 * RunDeck server. +1373 * +1374 * @param project name of the project - mandatory +1375 * @param scriptFilename filename of the script to be executed - mandatory +1376 * @param options of the script - optional. See {@link OptionsBuilder}. +1377 * @param poolingInterval for checking the status of the execution. Must be > 0. +1378 * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds. +1379 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +1380 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1381 * @throws RundeckApiLoginException if the login failed +1382 * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace) +1383 * @throws IOException if we failed to read the file +1384 * @see #runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit) +1385 * @see #triggerAdhocScript(String, String, Properties) +1386 */ +1387 public RundeckExecution runAdhocScript(String project, String scriptFilename, Properties options, +1388 long poolingInterval, TimeUnit poolingUnit) throws RundeckApiException, RundeckApiLoginException, +1389 IllegalArgumentException, IOException { +1390 return runAdhocScript(project, scriptFilename, options, null, poolingInterval, poolingUnit); +1391 } +1392 +1393 /** +1394 * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck +1395 * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still +1396 * running. The script will be dispatched to nodes, accordingly to the nodeFilters parameter. +1397 * +1398 * @param project name of the project - mandatory +1399 * @param scriptFilename filename of the script to be executed - mandatory +1400 * @param options of the script - optional. See {@link OptionsBuilder}. +1401 * @param nodeFilters for selecting nodes on which the script will be executed. See {@link NodeFiltersBuilder} +1402 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +1403 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1404 * @throws RundeckApiLoginException if the login failed +1405 * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace) +1406 * @throws IOException if we failed to read the file +1407 * @see #runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit) +1408 * @see #triggerAdhocScript(String, String, Properties, Properties) +1409 */ +1410 public RundeckExecution runAdhocScript(String project, String scriptFilename, Properties options, +1411 Properties nodeFilters) throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException, +1412 IOException { +1413 return runAdhocScript(project, scriptFilename, options, nodeFilters, null, null); +1414 } +1415 +1416 /** +1417 * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck +1418 * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is +1419 * finished (or aborted) or is still running. The script will be dispatched to nodes, accordingly to the nodeFilters +1420 * parameter. +1421 * +1422 * @param project name of the project - mandatory +1423 * @param scriptFilename filename of the script to be executed - mandatory +1424 * @param options of the script - optional. See {@link OptionsBuilder}. +1425 * @param nodeFilters for selecting nodes on which the script will be executed. See {@link NodeFiltersBuilder} +1426 * @param poolingInterval for checking the status of the execution. Must be > 0. +1427 * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds. +1428 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +1429 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1430 * @throws RundeckApiLoginException if the login failed +1431 * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace) +1432 * @throws IOException if we failed to read the file +1433 * @see #runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit) +1434 * @see #triggerAdhocScript(String, String, Properties, Properties) +1435 */ +1436 public RundeckExecution runAdhocScript(String project, String scriptFilename, Properties options, +1437 Properties nodeFilters, long poolingInterval, TimeUnit poolingUnit) throws RundeckApiException, +1438 RundeckApiLoginException, IllegalArgumentException, IOException { +1439 return runAdhocScript(project, scriptFilename, options, nodeFilters, null, null, poolingInterval, poolingUnit); +1440 } +1441 +1442 /** +1443 * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck +1444 * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still +1445 * running. The script will be dispatched to nodes, accordingly to the nodeFilters parameter. +1446 * +1447 * @param project name of the project - mandatory +1448 * @param scriptFilename filename of the script to be executed - mandatory +1449 * @param options of the script - optional. See {@link OptionsBuilder}. +1450 * @param nodeFilters for selecting nodes on which the script will be executed. See {@link NodeFiltersBuilder} +1451 * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional +1452 * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional +1453 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +1454 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1455 * @throws RundeckApiLoginException if the login failed +1456 * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace) +1457 * @throws IOException if we failed to read the file +1458 * @see #runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit) +1459 * @see #triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean) +1460 */ +1461 public RundeckExecution runAdhocScript(String project, String scriptFilename, Properties options, +1462 Properties nodeFilters, Integer nodeThreadcount, Boolean nodeKeepgoing) throws RundeckApiException, +1463 RundeckApiLoginException, IllegalArgumentException, IOException { +1464 return runAdhocScript(project, +1465 scriptFilename, +1466 options, +1467 nodeFilters, +1468 nodeThreadcount, +1469 nodeKeepgoing, +1470 DEFAULT_POOLING_INTERVAL, +1471 DEFAULT_POOLING_UNIT); +1472 } +1473 +1474 /** +1475 * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck +1476 * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is +1477 * finished (or aborted) or is still running. The script will be dispatched to nodes, accordingly to the nodeFilters +1478 * parameter. +1479 * +1480 * @param project name of the project - mandatory +1481 * @param scriptFilename filename of the script to be executed - mandatory +1482 * @param options of the script - optional. See {@link OptionsBuilder}. +1483 * @param nodeFilters for selecting nodes on which the script will be executed. See {@link NodeFiltersBuilder} +1484 * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional +1485 * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional +1486 * @param poolingInterval for checking the status of the execution. Must be > 0. +1487 * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds. +1488 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +1489 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1490 * @throws RundeckApiLoginException if the login failed +1491 * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace) +1492 * @throws IOException if we failed to read the file +1493 * @see #runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit) +1494 * @see #triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean) +1495 */ +1496 public RundeckExecution runAdhocScript(String project, String scriptFilename, Properties options, +1497 Properties nodeFilters, Integer nodeThreadcount, Boolean nodeKeepgoing, long poolingInterval, +1498 TimeUnit poolingUnit) throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException, +1499 IOException { +1500 AssertUtil.notBlank(scriptFilename, "scriptFilename is mandatory to run an ad-hoc script !"); +1501 FileInputStream stream = null; +1502 try { +1503 stream = FileUtils.openInputStream(new File(scriptFilename)); +1504 return runAdhocScript(project, +1505 stream, +1506 options, +1507 nodeFilters, +1508 nodeThreadcount, +1509 nodeKeepgoing, +1510 poolingInterval, +1511 poolingUnit); +1512 } finally { +1513 IOUtils.closeQuietly(stream); +1514 } +1515 } +1516 +1517 /** +1518 * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck +1519 * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still +1520 * running. The script will not be dispatched to nodes, but be executed on the RunDeck server. +1521 * +1522 * @param project name of the project - mandatory +1523 * @param script inputStream for reading the script to be executed - mandatory +1524 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +1525 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1526 * @throws RundeckApiLoginException if the login failed +1527 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null +1528 * @throws IOException if we failed to read the file +1529 * @see #runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit) +1530 * @see #triggerAdhocScript(String, InputStream) +1531 */ +1532 public RundeckExecution runAdhocScript(String project, InputStream script) throws RundeckApiException, +1533 RundeckApiLoginException, IllegalArgumentException, IOException { +1534 return runAdhocScript(project, script, null); +1535 } +1536 +1537 /** +1538 * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck +1539 * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is +1540 * finished (or aborted) or is still running. The script will not be dispatched to nodes, but be executed on the +1541 * RunDeck server. +1542 * +1543 * @param project name of the project - mandatory +1544 * @param script inputStream for reading the script to be executed - mandatory +1545 * @param poolingInterval for checking the status of the execution. Must be > 0. +1546 * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds. +1547 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +1548 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1549 * @throws RundeckApiLoginException if the login failed +1550 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null +1551 * @throws IOException if we failed to read the file +1552 * @see #runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit) +1553 * @see #triggerAdhocScript(String, InputStream) +1554 */ +1555 public RundeckExecution runAdhocScript(String project, InputStream script, long poolingInterval, +1556 TimeUnit poolingUnit) throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException, +1557 IOException { +1558 return runAdhocScript(project, script, null, poolingInterval, poolingUnit); +1559 } +1560 +1561 /** +1562 * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck +1563 * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still +1564 * running. The script will not be dispatched to nodes, but be executed on the RunDeck server. +1565 * +1566 * @param project name of the project - mandatory +1567 * @param script inputStream for reading the script to be executed - mandatory +1568 * @param options of the script - optional. See {@link OptionsBuilder}. +1569 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +1570 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1571 * @throws RundeckApiLoginException if the login failed +1572 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null +1573 * @throws IOException if we failed to read the file +1574 * @see #runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit) +1575 * @see #triggerAdhocScript(String, InputStream, Properties) +1576 */ +1577 public RundeckExecution runAdhocScript(String project, InputStream script, Properties options) +1578 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException, IOException { +1579 return runAdhocScript(project, script, options, null); +1580 } +1581 +1582 /** +1583 * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck +1584 * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is +1585 * finished (or aborted) or is still running. The script will not be dispatched to nodes, but be executed on the +1586 * RunDeck server. +1587 * +1588 * @param project name of the project - mandatory +1589 * @param script inputStream for reading the script to be executed - mandatory +1590 * @param options of the script - optional. See {@link OptionsBuilder}. +1591 * @param poolingInterval for checking the status of the execution. Must be > 0. +1592 * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds. +1593 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +1594 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1595 * @throws RundeckApiLoginException if the login failed +1596 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null +1597 * @throws IOException if we failed to read the file +1598 * @see #runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit) +1599 * @see #triggerAdhocScript(String, InputStream, Properties) +1600 */ +1601 public RundeckExecution runAdhocScript(String project, InputStream script, Properties options, +1602 long poolingInterval, TimeUnit poolingUnit) throws RundeckApiException, RundeckApiLoginException, +1603 IllegalArgumentException, IOException { +1604 return runAdhocScript(project, script, options, null, poolingInterval, poolingUnit); +1605 } +1606 +1607 /** +1608 * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck +1609 * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still +1610 * running. The script will be dispatched to nodes, accordingly to the nodeFilters parameter. +1611 * +1612 * @param project name of the project - mandatory +1613 * @param script inputStream for reading the script to be executed - mandatory +1614 * @param options of the script - optional. See {@link OptionsBuilder}. +1615 * @param nodeFilters for selecting nodes on which the script will be executed. See {@link NodeFiltersBuilder} +1616 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +1617 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1618 * @throws RundeckApiLoginException if the login failed +1619 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null +1620 * @throws IOException if we failed to read the file +1621 * @see #runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit) +1622 * @see #triggerAdhocScript(String, InputStream, Properties, Properties) +1623 */ +1624 public RundeckExecution runAdhocScript(String project, InputStream script, Properties options, +1625 Properties nodeFilters) throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException, +1626 IOException { +1627 return runAdhocScript(project, script, options, nodeFilters, null, null); +1628 } +1629 +1630 /** +1631 * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck +1632 * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is +1633 * finished (or aborted) or is still running. The script will be dispatched to nodes, accordingly to the nodeFilters +1634 * parameter. +1635 * +1636 * @param project name of the project - mandatory +1637 * @param script inputStream for reading the script to be executed - mandatory +1638 * @param options of the script - optional. See {@link OptionsBuilder}. +1639 * @param nodeFilters for selecting nodes on which the script will be executed. See {@link NodeFiltersBuilder} +1640 * @param poolingInterval for checking the status of the execution. Must be > 0. +1641 * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds. +1642 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +1643 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1644 * @throws RundeckApiLoginException if the login failed +1645 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null +1646 * @throws IOException if we failed to read the file +1647 * @see #runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit) +1648 * @see #triggerAdhocScript(String, InputStream, Properties, Properties) +1649 */ +1650 public RundeckExecution runAdhocScript(String project, InputStream script, Properties options, +1651 Properties nodeFilters, long poolingInterval, TimeUnit poolingUnit) throws RundeckApiException, +1652 RundeckApiLoginException, IllegalArgumentException, IOException { +1653 return runAdhocScript(project, script, options, nodeFilters, null, null, poolingInterval, poolingUnit); +1654 } +1655 +1656 /** +1657 * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck +1658 * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still +1659 * running. The script will be dispatched to nodes, accordingly to the nodeFilters parameter. +1660 * +1661 * @param project name of the project - mandatory +1662 * @param script inputStream for reading the script to be executed - mandatory +1663 * @param options of the script - optional. See {@link OptionsBuilder}. +1664 * @param nodeFilters for selecting nodes on which the script will be executed. See {@link NodeFiltersBuilder} +1665 * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional +1666 * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional +1667 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +1668 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1669 * @throws RundeckApiLoginException if the login failed +1670 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null +1671 * @throws IOException if we failed to read the file +1672 * @see #runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit) +1673 * @see #triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean) +1674 */ +1675 public RundeckExecution runAdhocScript(String project, InputStream script, Properties options, +1676 Properties nodeFilters, Integer nodeThreadcount, Boolean nodeKeepgoing) throws RundeckApiException, +1677 RundeckApiLoginException, IllegalArgumentException, IOException { +1678 return runAdhocScript(project, +1679 script, +1680 options, +1681 nodeFilters, +1682 nodeThreadcount, +1683 nodeKeepgoing, +1684 DEFAULT_POOLING_INTERVAL, +1685 DEFAULT_POOLING_UNIT); +1686 } +1687 +1688 /** +1689 * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck +1690 * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is +1691 * finished (or aborted) or is still running. The script will be dispatched to nodes, accordingly to the nodeFilters +1692 * parameter. +1693 * +1694 * @param project name of the project - mandatory +1695 * @param script inputStream for reading the script to be executed - mandatory +1696 * @param options of the script - optional. See {@link OptionsBuilder}. +1697 * @param nodeFilters for selecting nodes on which the script will be executed. See {@link NodeFiltersBuilder} +1698 * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional +1699 * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional +1700 * @param poolingInterval for checking the status of the execution. Must be > 0. +1701 * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds. +1702 * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null +1703 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1704 * @throws RundeckApiLoginException if the login failed +1705 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null +1706 * @throws IOException if we failed to read the file +1707 * @see #runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit) +1708 * @see #triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean) +1709 */ +1710 public RundeckExecution runAdhocScript(String project, InputStream script, Properties options, +1711 Properties nodeFilters, Integer nodeThreadcount, Boolean nodeKeepgoing, long poolingInterval, +1712 TimeUnit poolingUnit) throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { +1713 if (poolingInterval <= 0) { +1714 poolingInterval = DEFAULT_POOLING_INTERVAL; +1715 poolingUnit = DEFAULT_POOLING_UNIT; +1716 } +1717 if (poolingUnit == null) { +1718 poolingUnit = DEFAULT_POOLING_UNIT; +1719 } +1720 +1721 RundeckExecution execution = triggerAdhocScript(project, +1722 script, +1723 options, +1724 nodeFilters, +1725 nodeThreadcount, +1726 nodeKeepgoing); +1727 while (ExecutionStatus.RUNNING.equals(execution.getStatus())) { +1728 try { +1729 Thread.sleep(poolingUnit.toMillis(poolingInterval)); +1730 } catch (InterruptedException e) { +1731 break; +1732 } +1733 execution = getExecution(execution.getId()); +1734 } +1735 return execution; +1736 } +1737 +1738 /* +1739 * Executions +1740 */ +1741 +1742 /** +1743 * Get all running executions (for all projects) +1744 * +1745 * @return a {@link List} of {@link RundeckExecution} : might be empty, but won't be null +1746 * @throws RundeckApiException in case of error when calling the API +1747 * @throws RundeckApiLoginException if the login failed +1748 * @see #getRunningExecutions(String) +1749 */ +1750 public List<RundeckExecution> getRunningExecutions() throws RundeckApiException, RundeckApiLoginException { +1751 List<RundeckExecution> executions = new ArrayList<RundeckExecution>(); +1752 for (RundeckProject project : getProjects()) { +1753 executions.addAll(getRunningExecutions(project.getName())); +1754 } +1755 return executions; +1756 } +1757 +1758 /** +1759 * Get the running executions for the given project +1760 * +1761 * @param project name of the project - mandatory +1762 * @return a {@link List} of {@link RundeckExecution} : might be empty, but won't be null +1763 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1764 * @throws RundeckApiLoginException if the login failed +1765 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) +1766 * @see #getRunningExecutions() +1767 */ +1768 public List<RundeckExecution> getRunningExecutions(String project) throws RundeckApiException, +1769 RundeckApiLoginException, IllegalArgumentException { +1770 AssertUtil.notBlank(project, "project is mandatory get all running executions !"); +1771 return new ApiCall(this).get(new ApiPathBuilder("/executions/running").param("project", project), +1772 new ListParser<RundeckExecution>(new ExecutionParser(), +1773 "result/executions/execution")); +1774 } +1775 +1776 /** +1777 * Get the executions of the given job +1778 * +1779 * @param jobId identifier of the job - mandatory +1780 * @return a {@link List} of {@link RundeckExecution} : might be empty, but won't be null +1781 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) +1782 * @throws RundeckApiLoginException if the login failed +1783 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) +1784 * @see #getJobExecutions(String, RundeckExecution.ExecutionStatus, Long, Long) +1785 */ +1786 public List<RundeckExecution> getJobExecutions(String jobId) throws RundeckApiException, RundeckApiLoginException, +1787 IllegalArgumentException { +1788 return getJobExecutions(jobId, (ExecutionStatus) null); +1789 } +1790 +1791 /** +1792 * Get the executions of the given job +1793 * +1794 * @param jobId identifier of the job - mandatory +1795 * @param status of the executions, see {@link ExecutionStatus} - optional (null for all) +1796 * @return a {@link List} of {@link RundeckExecution} : might be empty, but won't be null +1797 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) +1798 * @throws RundeckApiLoginException if the login failed +1799 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace), or the executionStatus is +1800 * invalid +1801 * @see #getJobExecutions(String, String, Long, Long) +1802 */ +1803 public List<RundeckExecution> getJobExecutions(String jobId, String status) throws RundeckApiException, +1804 RundeckApiLoginException, IllegalArgumentException { +1805 return getJobExecutions(jobId, +1806 StringUtils.isBlank(status) ? null : ExecutionStatus.valueOf(StringUtils.upperCase(status))); +1807 } +1808 +1809 /** +1810 * Get the executions of the given job +1811 * +1812 * @param jobId identifier of the job - mandatory +1813 * @param status of the executions, see {@link ExecutionStatus} - optional (null for all) +1814 * @return a {@link List} of {@link RundeckExecution} : might be empty, but won't be null +1815 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) +1816 * @throws RundeckApiLoginException if the login failed +1817 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) +1818 * @see #getJobExecutions(String, RundeckExecution.ExecutionStatus, Long, Long) +1819 */ +1820 public List<RundeckExecution> getJobExecutions(String jobId, ExecutionStatus status) throws RundeckApiException, +1821 RundeckApiLoginException, IllegalArgumentException { +1822 return getJobExecutions(jobId, status, null, null); +1823 } +1824 +1825 /** +1826 * Get the executions of the given job +1827 * +1828 * @param jobId identifier of the job - mandatory +1829 * @param status of the executions, see {@link ExecutionStatus} - optional (null for all) +1830 * @param max number of results to return - optional (null for all) +1831 * @param offset the 0-indexed offset for the first result to return - optional +1832 * @return a {@link List} of {@link RundeckExecution} : might be empty, but won't be null +1833 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) +1834 * @throws RundeckApiLoginException if the login failed +1835 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace), or the executionStatus is +1836 * invalid +1837 * @see #getJobExecutions(String, RundeckExecution.ExecutionStatus, Long, Long) +1838 */ +1839 public List<RundeckExecution> getJobExecutions(String jobId, String status, Long max, Long offset) +1840 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { +1841 return getJobExecutions(jobId, +1842 StringUtils.isBlank(status) ? null : ExecutionStatus.valueOf(StringUtils.upperCase(status)), +1843 max, +1844 offset); +1845 } +1846 +1847 /** +1848 * Get the executions of the given job +1849 * +1850 * @param jobId identifier of the job - mandatory +1851 * @param status of the executions, see {@link ExecutionStatus} - optional (null for all) +1852 * @param max number of results to return - optional (null for all) +1853 * @param offset the 0-indexed offset for the first result to return - optional +1854 * @return a {@link List} of {@link RundeckExecution} : might be empty, but won't be null +1855 * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID) +1856 * @throws RundeckApiLoginException if the login failed +1857 * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace) +1858 */ +1859 public List<RundeckExecution> getJobExecutions(String jobId, ExecutionStatus status, Long max, Long offset) +1860 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { +1861 AssertUtil.notBlank(jobId, "jobId is mandatory to get the executions of a job !"); +1862 return new ApiCall(this).get(new ApiPathBuilder("/job/", jobId, "/executions").param("status", status) +1863 .param("max", max) +1864 .param("offset", offset), +1865 new ListParser<RundeckExecution>(new ExecutionParser(), +1866 "result/executions/execution")); +1867 } +1868 +1869 /** +1870 * Get a single execution, identified by the given ID +1871 * +1872 * @param executionId identifier of the execution - mandatory +1873 * @return a {@link RundeckExecution} instance - won't be null +1874 * @throws RundeckApiException in case of error when calling the API (non-existent execution with this ID) +1875 * @throws RundeckApiLoginException if the login failed +1876 * @throws IllegalArgumentException if the executionId is null +1877 */ +1878 public RundeckExecution getExecution(Long executionId) throws RundeckApiException, RundeckApiLoginException, +1879 IllegalArgumentException { +1880 AssertUtil.notNull(executionId, "executionId is mandatory to get the details of an execution !"); +1881 return new ApiCall(this).get(new ApiPathBuilder("/execution/", executionId.toString()), +1882 new ExecutionParser("result/executions/execution")); +1883 } +1884 +1885 /** +1886 * Abort an execution (identified by the given ID). The execution should be running... +1887 * +1888 * @param executionId identifier of the execution - mandatory +1889 * @return a {@link RundeckAbort} instance - won't be null +1890 * @throws RundeckApiException in case of error when calling the API (non-existent execution with this ID) +1891 * @throws RundeckApiLoginException if the login failed +1892 * @throws IllegalArgumentException if the executionId is null +1893 */ +1894 public RundeckAbort abortExecution(Long executionId) throws RundeckApiException, RundeckApiLoginException, +1895 IllegalArgumentException { +1896 AssertUtil.notNull(executionId, "executionId is mandatory to abort an execution !"); +1897 return new ApiCall(this).get(new ApiPathBuilder("/execution/", executionId.toString(), "/abort"), +1898 new AbortParser("result/abort")); +1899 } +1900 +1901 /* +1902 * History +1903 */ +1904 +1905 /** +1906 * Get the (events) history for the given project +1907 * +1908 * @param project name of the project - mandatory +1909 * @return a {@link RundeckHistory} instance - won't be null +1910 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1911 * @throws RundeckApiLoginException if the login failed +1912 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) +1913 * @see #getHistory(String, String, String, String, String, Date, Date, Long, Long) +1914 */ +1915 public RundeckHistory getHistory(String project) throws RundeckApiException, RundeckApiLoginException, +1916 IllegalArgumentException { +1917 return getHistory(project, null, null, null, null, null, null, null, null); +1918 } +1919 +1920 /** +1921 * Get the (events) history for the given project +1922 * +1923 * @param project name of the project - mandatory +1924 * @param max number of results to return - optional (default to 20) +1925 * @param offset the 0-indexed offset for the first result to return - optional (default to O) +1926 * @return a {@link RundeckHistory} instance - won't be null +1927 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1928 * @throws RundeckApiLoginException if the login failed +1929 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) +1930 * @see #getHistory(String, String, String, String, String, Date, Date, Long, Long) +1931 */ +1932 public RundeckHistory getHistory(String project, Long max, Long offset) throws RundeckApiException, +1933 RundeckApiLoginException, IllegalArgumentException { +1934 return getHistory(project, null, null, null, null, null, null, max, offset); +1935 } +1936 +1937 /** +1938 * Get the (events) history for the given project +1939 * +1940 * @param project name of the project - mandatory +1941 * @param jobId include only events matching the given job ID - optional +1942 * @param reportId include only events matching the given report ID - optional +1943 * @param user include only events created by the given user - optional +1944 * @return a {@link RundeckHistory} instance - won't be null +1945 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1946 * @throws RundeckApiLoginException if the login failed +1947 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) +1948 * @see #getHistory(String, String, String, String, String, Date, Date, Long, Long) +1949 */ +1950 public RundeckHistory getHistory(String project, String jobId, String reportId, String user) +1951 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { +1952 return getHistory(project, jobId, reportId, user, null, null, null, null, null); +1953 } +1954 +1955 /** +1956 * Get the (events) history for the given project +1957 * +1958 * @param project name of the project - mandatory +1959 * @param jobId include only events matching the given job ID - optional +1960 * @param reportId include only events matching the given report ID - optional +1961 * @param user include only events created by the given user - optional +1962 * @param max number of results to return - optional (default to 20) +1963 * @param offset the 0-indexed offset for the first result to return - optional (default to O) +1964 * @return a {@link RundeckHistory} instance - won't be null +1965 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1966 * @throws RundeckApiLoginException if the login failed +1967 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) +1968 * @see #getHistory(String, String, String, String, String, Date, Date, Long, Long) +1969 */ +1970 public RundeckHistory getHistory(String project, String jobId, String reportId, String user, Long max, Long offset) +1971 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { +1972 return getHistory(project, jobId, reportId, user, null, null, null, max, offset); +1973 } +1974 +1975 /** +1976 * Get the (events) history for the given project +1977 * +1978 * @param project name of the project - mandatory +1979 * @param recent include only events matching the given period of time. Format : "XY", where X is an integer, and Y +1980 * is one of : "h" (hour), "d" (day), "w" (week), "m" (month), "y" (year). Example : "2w" (= last 2 +1981 * weeks), "5d" (= last 5 days), etc. Optional. +1982 * @return a {@link RundeckHistory} instance - won't be null +1983 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +1984 * @throws RundeckApiLoginException if the login failed +1985 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) +1986 * @see #getHistory(String, String, String, String, String, Date, Date, Long, Long) +1987 */ +1988 public RundeckHistory getHistory(String project, String recent) throws RundeckApiException, +1989 RundeckApiLoginException, IllegalArgumentException { +1990 return getHistory(project, null, null, null, recent, null, null, null, null); +1991 } +1992 +1993 /** +1994 * Get the (events) history for the given project +1995 * +1996 * @param project name of the project - mandatory +1997 * @param recent include only events matching the given period of time. Format : "XY", where X is an integer, and Y +1998 * is one of : "h" (hour), "d" (day), "w" (week), "m" (month), "y" (year). Example : "2w" (= last 2 +1999 * weeks), "5d" (= last 5 days), etc. Optional. +2000 * @param max number of results to return - optional (default to 20) +2001 * @param offset the 0-indexed offset for the first result to return - optional (default to O) +2002 * @return a {@link RundeckHistory} instance - won't be null +2003 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +2004 * @throws RundeckApiLoginException if the login failed +2005 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) +2006 * @see #getHistory(String, String, String, String, String, Date, Date, Long, Long) +2007 */ +2008 public RundeckHistory getHistory(String project, String recent, Long max, Long offset) throws RundeckApiException, +2009 RundeckApiLoginException, IllegalArgumentException { +2010 return getHistory(project, null, null, null, recent, null, null, max, offset); +2011 } +2012 +2013 /** +2014 * Get the (events) history for the given project +2015 * +2016 * @param project name of the project - mandatory +2017 * @param begin date for the earlier events to retrieve - optional +2018 * @param end date for the latest events to retrieve - optional +2019 * @return a {@link RundeckHistory} instance - won't be null +2020 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +2021 * @throws RundeckApiLoginException if the login failed +2022 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) +2023 * @see #getHistory(String, String, String, String, String, Date, Date, Long, Long) +2024 */ +2025 public RundeckHistory getHistory(String project, Date begin, Date end) throws RundeckApiException, +2026 RundeckApiLoginException, IllegalArgumentException { +2027 return getHistory(project, null, null, null, null, begin, end, null, null); +2028 } +2029 +2030 /** +2031 * Get the (events) history for the given project +2032 * +2033 * @param project name of the project - mandatory +2034 * @param begin date for the earlier events to retrieve - optional +2035 * @param end date for the latest events to retrieve - optional +2036 * @param max number of results to return - optional (default to 20) +2037 * @param offset the 0-indexed offset for the first result to return - optional (default to O) +2038 * @return a {@link RundeckHistory} instance - won't be null +2039 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +2040 * @throws RundeckApiLoginException if the login failed +2041 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) +2042 * @see #getHistory(String, String, String, String, String, Date, Date, Long, Long) +2043 */ +2044 public RundeckHistory getHistory(String project, Date begin, Date end, Long max, Long offset) +2045 throws RundeckApiException, RundeckApiLoginException, IllegalArgumentException { +2046 return getHistory(project, null, null, null, null, begin, end, max, offset); +2047 } +2048 +2049 /** +2050 * Get the (events) history for the given project +2051 * +2052 * @param project name of the project - mandatory +2053 * @param jobId include only events matching the given job ID - optional +2054 * @param reportId include only events matching the given report ID - optional +2055 * @param user include only events created by the given user - optional +2056 * @param recent include only events matching the given period of time. Format : "XY", where X is an integer, and Y +2057 * is one of : "h" (hour), "d" (day), "w" (week), "m" (month), "y" (year). Example : "2w" (= last 2 +2058 * weeks), "5d" (= last 5 days), etc. Optional. +2059 * @param begin date for the earlier events to retrieve - optional +2060 * @param end date for the latest events to retrieve - optional +2061 * @param max number of results to return - optional (default to 20) +2062 * @param offset the 0-indexed offset for the first result to return - optional (default to O) +2063 * @return a {@link RundeckHistory} instance - won't be null +2064 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +2065 * @throws RundeckApiLoginException if the login failed +2066 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) +2067 */ +2068 public RundeckHistory getHistory(String project, String jobId, String reportId, String user, String recent, +2069 Date begin, Date end, Long max, Long offset) throws RundeckApiException, RundeckApiLoginException, +2070 IllegalArgumentException { +2071 AssertUtil.notBlank(project, "project is mandatory to get the history !"); +2072 return new ApiCall(this).get(new ApiPathBuilder("/history").param("project", project) +2073 .param("jobIdFilter", jobId) +2074 .param("reportIdFilter", reportId) +2075 .param("userFilter", user) +2076 .param("recentFilter", recent) +2077 .param("begin", begin) +2078 .param("end", end) +2079 .param("max", max) +2080 .param("offset", offset), +2081 new HistoryParser("result/events")); +2082 } +2083 +2084 /* +2085 * Nodes +2086 */ +2087 +2088 /** +2089 * List all nodes (for all projects) +2090 * +2091 * @return a {@link List} of {@link RundeckNode} : might be empty, but won't be null +2092 * @throws RundeckApiException in case of error when calling the API +2093 * @throws RundeckApiLoginException if the login failed +2094 */ +2095 public List<RundeckNode> getNodes() throws RundeckApiException, RundeckApiLoginException { +2096 List<RundeckNode> nodes = new ArrayList<RundeckNode>(); +2097 for (RundeckProject project : getProjects()) { +2098 nodes.addAll(getNodes(project.getName())); +2099 } +2100 return nodes; +2101 } +2102 +2103 /** +2104 * List all nodes that belongs to the given project +2105 * +2106 * @param project name of the project - mandatory +2107 * @return a {@link List} of {@link RundeckNode} : might be empty, but won't be null +2108 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +2109 * @throws RundeckApiLoginException if the login failed +2110 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) +2111 * @see #getNodes(String, Properties) +2112 */ +2113 public List<RundeckNode> getNodes(String project) throws RundeckApiException, RundeckApiLoginException, +2114 IllegalArgumentException { +2115 return getNodes(project, null); +2116 } +2117 +2118 /** +2119 * List nodes that belongs to the given project +2120 * +2121 * @param project name of the project - mandatory +2122 * @param nodeFilters for filtering the nodes - optional. See {@link NodeFiltersBuilder} +2123 * @return a {@link List} of {@link RundeckNode} : might be empty, but won't be null +2124 * @throws RundeckApiException in case of error when calling the API (non-existent project with this name) +2125 * @throws RundeckApiLoginException if the login failed +2126 * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) +2127 */ +2128 public List<RundeckNode> getNodes(String project, Properties nodeFilters) throws RundeckApiException, +2129 RundeckApiLoginException, IllegalArgumentException { +2130 AssertUtil.notBlank(project, "project is mandatory to get all nodes !"); +2131 return new ApiCall(this).get(new ApiPathBuilder("/resources").param("project", project) +2132 .nodeFilters(nodeFilters), +2133 new ListParser<RundeckNode>(new NodeParser(), "project/node")); +2134 } +2135 +2136 /** +2137 * Get the definition of a single node +2138 * +2139 * @param name of the node - mandatory +2140 * @param project name of the project - mandatory +2141 * @return a {@link RundeckNode} instance - won't be null +2142 * @throws RundeckApiException in case of error when calling the API (non-existent name or project with this name) +2143 * @throws RundeckApiLoginException if the login failed +2144 * @throws IllegalArgumentException if the name or project is blank (null, empty or whitespace) +2145 */ +2146 public RundeckNode getNode(String name, String project) throws RundeckApiException, RundeckApiLoginException, +2147 IllegalArgumentException { +2148 AssertUtil.notBlank(name, "the name of the node is mandatory to get a node !"); +2149 AssertUtil.notBlank(project, "project is mandatory to get a node !"); +2150 return new ApiCall(this).get(new ApiPathBuilder("/resource/", name).param("project", project), +2151 new NodeParser("project/node")); +2152 } +2153 +2154 /* +2155 * System Info +2156 */ +2157 +2158 /** +2159 * Get system informations about the RunDeck server +2160 * +2161 * @return a {@link RundeckSystemInfo} instance - won't be null +2162 * @throws RundeckApiException in case of error when calling the API +2163 * @throws RundeckApiException if the login failed +2164 */ +2165 public RundeckSystemInfo getSystemInfo() throws RundeckApiException, RundeckApiLoginException { +2166 return new ApiCall(this).get(new ApiPathBuilder("/system/info"), new SystemInfoParser("result/system")); +2167 } +2168 +2169 /** +2170 * @return the URL of the RunDeck instance ("http://localhost:4440", "http://rundeck.your-compagny.com/", etc) +2171 */ +2172 public String getUrl() { +2173 return url; +2174 } +2175 +2176 /** +2177 * @return the login used for authentication on the RunDeck instance +2178 */ +2179 public String getLogin() { +2180 return login; +2181 } +2182 +2183 /** +2184 * @return the password used for authentication on the RunDeck instance +2185 */ +2186 public String getPassword() { +2187 return password; +2188 } +2189 +2190 @Override +2191 public String toString() { +2192 return "RundeckClient " + API_VERSION + " [" + url + "] (credentials=" + login + "|" + password + ")"; +2193 } +2194 +2195 @Override +2196 public int hashCode() { +2197 final int prime = 31; +2198 int result = 1; +2199 result = prime * result + ((login == null) ? 0 : login.hashCode()); +2200 result = prime * result + ((password == null) ? 0 : password.hashCode()); +2201 result = prime * result + ((url == null) ? 0 : url.hashCode()); +2202 return result; +2203 } +2204 +2205 @Override +2206 public boolean equals(Object obj) { +2207 if (this == obj) +2208 return true; +2209 if (obj == null) +2210 return false; +2211 if (getClass() != obj.getClass()) +2212 return false; +2213 RundeckClient other = (RundeckClient) obj; +2214 if (login == null) { +2215 if (other.login != null) +2216 return false; +2217 } else if (!login.equals(other.login)) +2218 return false; +2219 if (password == null) { +2220 if (other.password != null) +2221 return false; +2222 } else if (!password.equals(other.password)) +2223 return false; +2224 if (url == null) { +2225 if (other.url != null) +2226 return false; +2227 } else if (!url.equals(other.url)) +2228 return false; +2229 return true; +2230 } +2231 +2232 }
    diff --git a/xref/org/rundeck/api/domain/RundeckEvent.html b/xref/org/rundeck/api/domain/RundeckEvent.html new file mode 100644 index 0000000..cde27a6 --- /dev/null +++ b/xref/org/rundeck/api/domain/RundeckEvent.html @@ -0,0 +1,386 @@ + + + + +RundeckEvent xref + + + +
    +
+1   /*
+2    * Copyright 2011 Vincent Behar
+3    *
+4    * Licensed under the Apache License, Version 2.0 (the "License");
+5    * you may not use this file except in compliance with the License.
+6    * You may obtain a copy of the License at
+7    *
+8    *     http://www.apache.org/licenses/LICENSE-2.0
+9    *
+10   * Unless required by applicable law or agreed to in writing, software
+11   * distributed under the License is distributed on an "AS IS" BASIS,
+12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+13   * See the License for the specific language governing permissions and
+14   * limitations under the License.
+15   */
+16  package org.rundeck.api.domain;
+17  
+18  import java.io.Serializable;
+19  import java.util.Date;
+20  import java.util.concurrent.TimeUnit;
+21  import org.apache.commons.lang.time.DurationFormatUtils;
+22  
+23  /**
+24   * Represents a RunDeck event
+25   * 
+26   * @author Vincent Behar
+27   */
+28  public class RundeckEvent implements Serializable {
+29  
+30      private static final long serialVersionUID = 1L;
+31  
+32      private String title;
+33  
+34      private EventStatus status;
+35  
+36      private String summary;
+37  
+38      private NodeSummary nodeSummary;
+39  
+40      private String user;
+41  
+42      private String project;
+43  
+44      private Date startedAt;
+45  
+46      private Date endedAt;
+47  
+48      /** only if the execution was aborted */
+49      private String abortedBy;
+50  
+51      /** only if associated with an execution */
+52      private Long executionId;
+53  
+54      /** only if associated with a job */
+55      private String jobId;
+56  
+57      /**
+58       * @return the duration of the event in milliseconds (or null if the dates are invalid)
+59       */
+60      public Long getDurationInMillis() {
+61          if (startedAt == null || endedAt == null) {
+62              return null;
+63          }
+64          return endedAt.getTime() - startedAt.getTime();
+65      }
+66  
+67      /**
+68       * @return the duration of the event in seconds (or null if the dates are invalid)
+69       */
+70      public Long getDurationInSeconds() {
+71          Long durationInMillis = getDurationInMillis();
+72          return durationInMillis != null ? TimeUnit.MILLISECONDS.toSeconds(durationInMillis) : null;
+73      }
+74  
+75      /**
+76       * @return the duration of the event, as a human-readable string : "3 minutes 34 seconds" (or null if the dates are
+77       *         invalid)
+78       */
+79      public String getDuration() {
+80          Long durationInMillis = getDurationInMillis();
+81          return durationInMillis != null ? DurationFormatUtils.formatDurationWords(durationInMillis, true, true) : null;
+82      }
+83  
+84      /**
+85       * @return the duration of the event, as a "short" human-readable string : "0:03:34.187" (or null if the dates are
+86       *         invalid)
+87       */
+88      public String getShortDuration() {
+89          Long durationInMillis = getDurationInMillis();
+90          return durationInMillis != null ? DurationFormatUtils.formatDurationHMS(durationInMillis) : null;
+91      }
+92  
+93      /**
+94       * @return true if this event is for an ad-hoc command or script, false otherwise (for a job)
+95       */
+96      public boolean isAdhoc() {
+97          return "adhoc".equals(title);
+98      }
+99  
+100     public String getTitle() {
+101         return title;
+102     }
+103 
+104     public void setTitle(String title) {
+105         this.title = title;
+106     }
+107 
+108     /**
+109      * @return the status of the event - see {@link EventStatus}
+110      */
+111     public EventStatus getStatus() {
+112         return status;
+113     }
+114 
+115     public void setStatus(EventStatus status) {
+116         this.status = status;
+117     }
+118 
+119     public String getSummary() {
+120         return summary;
+121     }
+122 
+123     public void setSummary(String summary) {
+124         this.summary = summary;
+125     }
+126 
+127     /**
+128      * @return the node summary - see {@link NodeSummary}
+129      */
+130     public NodeSummary getNodeSummary() {
+131         return nodeSummary;
+132     }
+133 
+134     public void setNodeSummary(NodeSummary nodeSummary) {
+135         this.nodeSummary = nodeSummary;
+136     }
+137 
+138     public String getUser() {
+139         return user;
+140     }
+141 
+142     public void setUser(String user) {
+143         this.user = user;
+144     }
+145 
+146     public String getProject() {
+147         return project;
+148     }
+149 
+150     public void setProject(String project) {
+151         this.project = project;
+152     }
+153 
+154     public Date getStartedAt() {
+155         return (startedAt != null) ? new Date(startedAt.getTime()) : null;
+156     }
+157 
+158     public void setStartedAt(Date startedAt) {
+159         this.startedAt = ((startedAt != null) ? new Date(startedAt.getTime()) : null);
+160     }
+161 
+162     public Date getEndedAt() {
+163         return (endedAt != null) ? new Date(endedAt.getTime()) : null;
+164     }
+165 
+166     public void setEndedAt(Date endedAt) {
+167         this.endedAt = ((endedAt != null) ? new Date(endedAt.getTime()) : null);
+168     }
+169 
+170     public String getAbortedBy() {
+171         return abortedBy;
+172     }
+173 
+174     public void setAbortedBy(String abortedBy) {
+175         this.abortedBy = abortedBy;
+176     }
+177 
+178     /**
+179      * @return the ID of the execution associated with this event, or null if there is not
+180      */
+181     public Long getExecutionId() {
+182         return executionId;
+183     }
+184 
+185     public void setExecutionId(Long executionId) {
+186         this.executionId = executionId;
+187     }
+188 
+189     /**
+190      * @return the ID of the job associated with this event, or null in the case of an ad-hoc command or script
+191      */
+192     public String getJobId() {
+193         return jobId;
+194     }
+195 
+196     public void setJobId(String jobId) {
+197         this.jobId = jobId;
+198     }
+199 
+200     @Override
+201     public String toString() {
+202         return "RundeckEvent [abortedBy=" + abortedBy + ", endedAt=" + endedAt + ", executionId=" + executionId
+203                + ", jobId=" + jobId + ", nodeSummary=" + nodeSummary + ", project=" + project + ", startedAt="
+204                + startedAt + ", status=" + status + ", summary=" + summary + ", title=" + title + ", user=" + user
+205                + "]";
+206     }
+207 
+208     @Override
+209     public int hashCode() {
+210         final int prime = 31;
+211         int result = 1;
+212         result = prime * result + ((abortedBy == null) ? 0 : abortedBy.hashCode());
+213         result = prime * result + ((endedAt == null) ? 0 : endedAt.hashCode());
+214         result = prime * result + ((executionId == null) ? 0 : executionId.hashCode());
+215         result = prime * result + ((jobId == null) ? 0 : jobId.hashCode());
+216         result = prime * result + ((nodeSummary == null) ? 0 : nodeSummary.hashCode());
+217         result = prime * result + ((project == null) ? 0 : project.hashCode());
+218         result = prime * result + ((startedAt == null) ? 0 : startedAt.hashCode());
+219         result = prime * result + ((status == null) ? 0 : status.hashCode());
+220         result = prime * result + ((summary == null) ? 0 : summary.hashCode());
+221         result = prime * result + ((title == null) ? 0 : title.hashCode());
+222         result = prime * result + ((user == null) ? 0 : user.hashCode());
+223         return result;
+224     }
+225 
+226     @Override
+227     public boolean equals(Object obj) {
+228         if (this == obj)
+229             return true;
+230         if (obj == null)
+231             return false;
+232         if (getClass() != obj.getClass())
+233             return false;
+234         RundeckEvent other = (RundeckEvent) obj;
+235         if (abortedBy == null) {
+236             if (other.abortedBy != null)
+237                 return false;
+238         } else if (!abortedBy.equals(other.abortedBy))
+239             return false;
+240         if (endedAt == null) {
+241             if (other.endedAt != null)
+242                 return false;
+243         } else if (!endedAt.equals(other.endedAt))
+244             return false;
+245         if (executionId == null) {
+246             if (other.executionId != null)
+247                 return false;
+248         } else if (!executionId.equals(other.executionId))
+249             return false;
+250         if (jobId == null) {
+251             if (other.jobId != null)
+252                 return false;
+253         } else if (!jobId.equals(other.jobId))
+254             return false;
+255         if (nodeSummary == null) {
+256             if (other.nodeSummary != null)
+257                 return false;
+258         } else if (!nodeSummary.equals(other.nodeSummary))
+259             return false;
+260         if (project == null) {
+261             if (other.project != null)
+262                 return false;
+263         } else if (!project.equals(other.project))
+264             return false;
+265         if (startedAt == null) {
+266             if (other.startedAt != null)
+267                 return false;
+268         } else if (!startedAt.equals(other.startedAt))
+269             return false;
+270         if (status == null) {
+271             if (other.status != null)
+272                 return false;
+273         } else if (!status.equals(other.status))
+274             return false;
+275         if (summary == null) {
+276             if (other.summary != null)
+277                 return false;
+278         } else if (!summary.equals(other.summary))
+279             return false;
+280         if (title == null) {
+281             if (other.title != null)
+282                 return false;
+283         } else if (!title.equals(other.title))
+284             return false;
+285         if (user == null) {
+286             if (other.user != null)
+287                 return false;
+288         } else if (!user.equals(other.user))
+289             return false;
+290         return true;
+291     }
+292 
+293     /**
+294      * Summary for nodes
+295      */
+296     public static class NodeSummary implements Serializable {
+297 
+298         private static final long serialVersionUID = 1L;
+299 
+300         private int succeeded;
+301 
+302         private int failed;
+303 
+304         private int total;
+305 
+306         public int getSucceeded() {
+307             return succeeded;
+308         }
+309 
+310         public void setSucceeded(int succeeded) {
+311             this.succeeded = succeeded;
+312         }
+313 
+314         public int getFailed() {
+315             return failed;
+316         }
+317 
+318         public void setFailed(int failed) {
+319             this.failed = failed;
+320         }
+321 
+322         public int getTotal() {
+323             return total;
+324         }
+325 
+326         public void setTotal(int total) {
+327             this.total = total;
+328         }
+329 
+330         @Override
+331         public String toString() {
+332             return "NodeSummary [succeeded=" + succeeded + ", failed=" + failed + ", total=" + total + "]";
+333         }
+334 
+335         @Override
+336         public int hashCode() {
+337             final int prime = 31;
+338             int result = 1;
+339             result = prime * result + failed;
+340             result = prime * result + succeeded;
+341             result = prime * result + total;
+342             return result;
+343         }
+344 
+345         @Override
+346         public boolean equals(Object obj) {
+347             if (this == obj)
+348                 return true;
+349             if (obj == null)
+350                 return false;
+351             if (getClass() != obj.getClass())
+352                 return false;
+353             NodeSummary other = (NodeSummary) obj;
+354             if (failed != other.failed)
+355                 return false;
+356             if (succeeded != other.succeeded)
+357                 return false;
+358             if (total != other.total)
+359                 return false;
+360             return true;
+361         }
+362 
+363     }
+364 
+365     /**
+366      * The status of an event
+367      */
+368     public static enum EventStatus {
+369         SUCCEEDED, FAILED, ABORTED;
+370     }
+371 
+372 }
+
    +
    + + diff --git a/xref/org/rundeck/api/domain/RundeckHistory.html b/xref/org/rundeck/api/domain/RundeckHistory.html new file mode 100644 index 0000000..f2d45d9 --- /dev/null +++ b/xref/org/rundeck/api/domain/RundeckHistory.html @@ -0,0 +1,144 @@ + + + + +RundeckHistory xref + + + +
    +
+1   /*
+2    * Copyright 2011 Vincent Behar
+3    *
+4    * Licensed under the Apache License, Version 2.0 (the "License");
+5    * you may not use this file except in compliance with the License.
+6    * You may obtain a copy of the License at
+7    *
+8    *     http://www.apache.org/licenses/LICENSE-2.0
+9    *
+10   * Unless required by applicable law or agreed to in writing, software
+11   * distributed under the License is distributed on an "AS IS" BASIS,
+12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+13   * See the License for the specific language governing permissions and
+14   * limitations under the License.
+15   */
+16  package org.rundeck.api.domain;
+17  
+18  import java.io.Serializable;
+19  import java.util.ArrayList;
+20  import java.util.List;
+21  
+22  /**
+23   * Represents a portion of the RunDeck (events) history
+24   * 
+25   * @author Vincent Behar
+26   */
+27  public class RundeckHistory implements Serializable {
+28  
+29      private static final long serialVersionUID = 1L;
+30  
+31      private List<RundeckEvent> events;
+32  
+33      private int count;
+34  
+35      private int total;
+36  
+37      private int max;
+38  
+39      private int offset;
+40  
+41      public void addEvent(RundeckEvent event) {
+42          if (events == null) {
+43              events = new ArrayList<RundeckEvent>();
+44          }
+45          events.add(event);
+46      }
+47  
+48      public List<RundeckEvent> getEvents() {
+49          return events;
+50      }
+51  
+52      public void setEvents(List<RundeckEvent> events) {
+53          this.events = events;
+54      }
+55  
+56      public int getCount() {
+57          return count;
+58      }
+59  
+60      public void setCount(int count) {
+61          this.count = count;
+62      }
+63  
+64      public int getTotal() {
+65          return total;
+66      }
+67  
+68      public void setTotal(int total) {
+69          this.total = total;
+70      }
+71  
+72      public int getMax() {
+73          return max;
+74      }
+75  
+76      public void setMax(int max) {
+77          this.max = max;
+78      }
+79  
+80      public int getOffset() {
+81          return offset;
+82      }
+83  
+84      public void setOffset(int offset) {
+85          this.offset = offset;
+86      }
+87  
+88      @Override
+89      public String toString() {
+90          return "RundeckHistory [count=" + count + ", max=" + max + ", offset=" + offset + ", total=" + total + "]";
+91      }
+92  
+93      @Override
+94      public int hashCode() {
+95          final int prime = 31;
+96          int result = 1;
+97          result = prime * result + count;
+98          result = prime * result + ((events == null) ? 0 : events.hashCode());
+99          result = prime * result + max;
+100         result = prime * result + offset;
+101         result = prime * result + total;
+102         return result;
+103     }
+104 
+105     @Override
+106     public boolean equals(Object obj) {
+107         if (this == obj)
+108             return true;
+109         if (obj == null)
+110             return false;
+111         if (getClass() != obj.getClass())
+112             return false;
+113         RundeckHistory other = (RundeckHistory) obj;
+114         if (count != other.count)
+115             return false;
+116         if (events == null) {
+117             if (other.events != null)
+118                 return false;
+119         } else if (!events.equals(other.events))
+120             return false;
+121         if (max != other.max)
+122             return false;
+123         if (offset != other.offset)
+124             return false;
+125         if (total != other.total)
+126             return false;
+127         return true;
+128     }
+129 
+130 }
+
    +
    + + diff --git a/xref/org/rundeck/api/domain/package-frame.html b/xref/org/rundeck/api/domain/package-frame.html index e067c26..0f94162 100644 --- a/xref/org/rundeck/api/domain/package-frame.html +++ b/xref/org/rundeck/api/domain/package-frame.html @@ -3,7 +3,7 @@ - RunDeck API - Java Client 1.1 Reference Package org.rundeck.api.domain + RunDeck API - Java Client 1.2 Reference Package org.rundeck.api.domain @@ -17,15 +17,27 @@
    • AbortStatus +
      • +
    • + EventStatus
    • ExecutionStatus +
      • +
    • + NodeSummary
    • RundeckAbort +
      • +
    • + RundeckEvent
    • RundeckExecution +
      • +
    • + RundeckHistory
    • RundeckJob diff --git a/xref/org/rundeck/api/domain/package-summary.html b/xref/org/rundeck/api/domain/package-summary.html index b55565b..f048f52 100644 --- a/xref/org/rundeck/api/domain/package-summary.html +++ b/xref/org/rundeck/api/domain/package-summary.html @@ -3,7 +3,7 @@ - RunDeck API - Java Client 1.1 Reference Package org.rundeck.api.domain + RunDeck API - Java Client 1.2 Reference Package org.rundeck.api.domain @@ -39,21 +39,41 @@
    • + + + + + + + + + + + + + + + + + +
    AbortStatus
    + EventStatus +
    ExecutionStatus
    + NodeSummary +
    RundeckAbort
    + RundeckEvent +
    RundeckExecution
    + RundeckHistory +
    diff --git a/xref/org/rundeck/api/package-frame.html b/xref/org/rundeck/api/package-frame.html index eabe74b..41279b5 100644 --- a/xref/org/rundeck/api/package-frame.html +++ b/xref/org/rundeck/api/package-frame.html @@ -3,7 +3,7 @@ - RunDeck API - Java Client 1.1 Reference Package org.rundeck.api + RunDeck API - Java Client 1.2 Reference Package org.rundeck.api diff --git a/xref/org/rundeck/api/package-summary.html b/xref/org/rundeck/api/package-summary.html index 2865b34..2ef9a44 100644 --- a/xref/org/rundeck/api/package-summary.html +++ b/xref/org/rundeck/api/package-summary.html @@ -3,7 +3,7 @@ - RunDeck API - Java Client 1.1 Reference Package org.rundeck.api + RunDeck API - Java Client 1.2 Reference Package org.rundeck.api diff --git a/xref/org/rundeck/api/parser/EventParser.html b/xref/org/rundeck/api/parser/EventParser.html new file mode 100644 index 0000000..2274153 --- /dev/null +++ b/xref/org/rundeck/api/parser/EventParser.html @@ -0,0 +1,101 @@ + + + + +EventParser xref + + + +
    +
+1   /*
+2    * Copyright 2011 Vincent Behar
+3    *
+4    * Licensed under the Apache License, Version 2.0 (the "License");
+5    * you may not use this file except in compliance with the License.
+6    * You may obtain a copy of the License at
+7    *
+8    *     http://www.apache.org/licenses/LICENSE-2.0
+9    *
+10   * Unless required by applicable law or agreed to in writing, software
+11   * distributed under the License is distributed on an "AS IS" BASIS,
+12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+13   * See the License for the specific language governing permissions and
+14   * limitations under the License.
+15   */
+16  package org.rundeck.api.parser;
+17  
+18  import java.util.Date;
+19  import org.apache.commons.lang.StringUtils;
+20  import org.dom4j.Node;
+21  import org.rundeck.api.domain.RundeckEvent;
+22  import org.rundeck.api.domain.RundeckEvent.EventStatus;
+23  import org.rundeck.api.domain.RundeckEvent.NodeSummary;
+24  
+25  /**
+26   * Parser for a single {@link RundeckEvent}
+27   * 
+28   * @author Vincent Behar
+29   */
+30  public class EventParser implements XmlNodeParser<RundeckEvent> {
+31  
+32      private String xpath;
+33  
+34      public EventParser() {
+35          super();
+36      }
+37  
+38      /**
+39       * @param xpath of the event element if it is not the root node
+40       */
+41      public EventParser(String xpath) {
+42          super();
+43          this.xpath = xpath;
+44      }
+45  
+46      @Override
+47      public RundeckEvent parseXmlNode(Node node) {
+48          Node eventNode = xpath != null ? node.selectSingleNode(xpath) : node;
+49  
+50          RundeckEvent event = new RundeckEvent();
+51  
+52          event.setTitle(StringUtils.trimToNull(eventNode.valueOf("title")));
+53          try {
+54              event.setStatus(EventStatus.valueOf(StringUtils.upperCase(eventNode.valueOf("status"))));
+55          } catch (IllegalArgumentException e) {
+56              event.setStatus(null);
+57          }
+58          event.setSummary(StringUtils.trimToNull(eventNode.valueOf("summary")));
+59  
+60          NodeSummary nodeSummary = new NodeSummary();
+61          nodeSummary.setSucceeded(Integer.valueOf(eventNode.valueOf("node-summary/@succeeded")));
+62          nodeSummary.setFailed(Integer.valueOf(eventNode.valueOf("node-summary/@failed")));
+63          nodeSummary.setTotal(Integer.valueOf(eventNode.valueOf("node-summary/@total")));
+64          event.setNodeSummary(nodeSummary);
+65  
+66          event.setUser(StringUtils.trimToNull(eventNode.valueOf("user")));
+67          event.setProject(StringUtils.trimToNull(eventNode.valueOf("project")));
+68          String startedAt = StringUtils.trimToNull(eventNode.valueOf("@starttime"));
+69          if (startedAt != null) {
+70              event.setStartedAt(new Date(Long.valueOf(startedAt)));
+71          }
+72          String endedAt = StringUtils.trimToNull(eventNode.valueOf("@endtime"));
+73          if (endedAt != null) {
+74              event.setEndedAt(new Date(Long.valueOf(endedAt)));
+75          }
+76          event.setAbortedBy(StringUtils.trimToNull(eventNode.valueOf("abortedby")));
+77          try {
+78              event.setExecutionId(Long.valueOf(eventNode.valueOf("execution/@id")));
+79          } catch (NumberFormatException e) {
+80              event.setExecutionId(null);
+81          }
+82          event.setJobId(StringUtils.trimToNull(eventNode.valueOf("job/@id")));
+83  
+84          return event;
+85      }
+86  
+87  }
+
    +
    + + diff --git a/xref/org/rundeck/api/parser/HistoryParser.html b/xref/org/rundeck/api/parser/HistoryParser.html new file mode 100644 index 0000000..8497a29 --- /dev/null +++ b/xref/org/rundeck/api/parser/HistoryParser.html @@ -0,0 +1,81 @@ + + + + +HistoryParser xref + + + +
    +
+1   /*
+2    * Copyright 2011 Vincent Behar
+3    *
+4    * Licensed under the Apache License, Version 2.0 (the "License");
+5    * you may not use this file except in compliance with the License.
+6    * You may obtain a copy of the License at
+7    *
+8    *     http://www.apache.org/licenses/LICENSE-2.0
+9    *
+10   * Unless required by applicable law or agreed to in writing, software
+11   * distributed under the License is distributed on an "AS IS" BASIS,
+12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+13   * See the License for the specific language governing permissions and
+14   * limitations under the License.
+15   */
+16  package org.rundeck.api.parser;
+17  
+18  import java.util.List;
+19  import org.dom4j.Node;
+20  import org.rundeck.api.domain.RundeckEvent;
+21  import org.rundeck.api.domain.RundeckHistory;
+22  
+23  /**
+24   * Parser for a single {@link RundeckHistory}
+25   * 
+26   * @author Vincent Behar
+27   */
+28  public class HistoryParser implements XmlNodeParser<RundeckHistory> {
+29  
+30      private String xpath;
+31  
+32      public HistoryParser() {
+33          super();
+34      }
+35  
+36      /**
+37       * @param xpath of the history element if it is not the root node
+38       */
+39      public HistoryParser(String xpath) {
+40          super();
+41          this.xpath = xpath;
+42      }
+43  
+44      @Override
+45      public RundeckHistory parseXmlNode(Node node) {
+46          Node eventsNode = xpath != null ? node.selectSingleNode(xpath) : node;
+47  
+48          RundeckHistory history = new RundeckHistory();
+49  
+50          history.setCount(Integer.valueOf(eventsNode.valueOf("@count")));
+51          history.setTotal(Integer.valueOf(eventsNode.valueOf("@total")));
+52          history.setMax(Integer.valueOf(eventsNode.valueOf("@max")));
+53          history.setOffset(Integer.valueOf(eventsNode.valueOf("@offset")));
+54  
+55          @SuppressWarnings("unchecked")
+56          List<Node> eventNodes = eventsNode.selectNodes("event");
+57          EventParser eventParser = new EventParser();
+58  
+59          for (Node eventNode : eventNodes) {
+60              RundeckEvent event = eventParser.parseXmlNode(eventNode);
+61              history.addEvent(event);
+62          }
+63  
+64          return history;
+65      }
+66  
+67  }
+
    +
    + + diff --git a/xref/org/rundeck/api/parser/package-frame.html b/xref/org/rundeck/api/parser/package-frame.html index 6a4ae6f..5dc0089 100644 --- a/xref/org/rundeck/api/parser/package-frame.html +++ b/xref/org/rundeck/api/parser/package-frame.html @@ -3,7 +3,7 @@ - RunDeck API - Java Client 1.1 Reference Package org.rundeck.api.parser + RunDeck API - Java Client 1.2 Reference Package org.rundeck.api.parser @@ -17,9 +17,15 @@
    • AbortParser +
      • +
    • + EventParser
    • ExecutionParser +
      • +
    • + HistoryParser
    • JobParser diff --git a/xref/org/rundeck/api/parser/package-summary.html b/xref/org/rundeck/api/parser/package-summary.html index 49d0367..e248261 100644 --- a/xref/org/rundeck/api/parser/package-summary.html +++ b/xref/org/rundeck/api/parser/package-summary.html @@ -3,7 +3,7 @@ - RunDeck API - Java Client 1.1 Reference Package org.rundeck.api.parser + RunDeck API - Java Client 1.2 Reference Package org.rundeck.api.parser @@ -39,11 +39,21 @@
    		AbortParser
    + EventParser +
    ExecutionParser
    + HistoryParser +
    diff --git a/xref/org/rundeck/api/util/package-frame.html b/xref/org/rundeck/api/util/package-frame.html index d77efbc..9eae2b7 100644 --- a/xref/org/rundeck/api/util/package-frame.html +++ b/xref/org/rundeck/api/util/package-frame.html @@ -3,7 +3,7 @@ - RunDeck API - Java Client 1.1 Reference Package org.rundeck.api.util + RunDeck API - Java Client 1.2 Reference Package org.rundeck.api.util diff --git a/xref/org/rundeck/api/util/package-summary.html b/xref/org/rundeck/api/util/package-summary.html index 900aa7e..985ab36 100644 --- a/xref/org/rundeck/api/util/package-summary.html +++ b/xref/org/rundeck/api/util/package-summary.html @@ -3,7 +3,7 @@ - RunDeck API - Java Client 1.1 Reference Package org.rundeck.api.util + RunDeck API - Java Client 1.2 Reference Package org.rundeck.api.util diff --git a/xref/overview-frame.html b/xref/overview-frame.html index cc84782..dc9737c 100644 --- a/xref/overview-frame.html +++ b/xref/overview-frame.html @@ -3,7 +3,7 @@ - RunDeck API - Java Client 1.1 Reference + RunDeck API - Java Client 1.2 Reference diff --git a/xref/overview-summary.html b/xref/overview-summary.html index 86d028d..1d0d416 100644 --- a/xref/overview-summary.html +++ b/xref/overview-summary.html @@ -3,7 +3,7 @@ - RunDeck API - Java Client 1.1 Reference + RunDeck API - Java Client 1.2 Reference @@ -24,7 +24,7 @@ -

    RunDeck API - Java Client 1.1 Reference

    +

    RunDeck API - Java Client 1.2 Reference