mirror of
https://github.com/Fishwaldo/rundeck-api-java-client.git
synced 2025-07-05 12:39:05 +00:00
Wagon: Deploying site to repository
This commit is contained in:
Vincent Behar
parent
da44f0d1db
commit
858ffde9e8
7 changed files with 89 additions and 89 deletions
File diff suppressed because one or more lines are too long
|
|
@ -191,7 +191,7 @@ rundeck = new RundeckClient("http://localhost:4440", "admin"
|
|||
|
||||
result = rundeck.importJobs("/tmp/jobs.xml", "xml")
|
||||
println "${result.succeededJobs.size} jobs successfully imported, ${result.skippedJobs.size} jobs skipped, and ${result.failedJobs.size} jobs failed"
|
||||
</pre></div><div class="section"><h3>And more...<a name="And_more..."></a></h3></div><p>See the API documentation of the <a href="./apidocs/org/rundeck/api/RundeckClient.html">RundeckClient</a> class for more interactions with your RunDeck instance...</p>
|
||||
</pre></div><div class="section"><h3>And more...<a name="And_more..."></a></h3></div><p>See the API documentation of the <a href="./apidocs/reference/org/rundeck/api/RundeckClient.html">RundeckClient</a> class for more interactions with your RunDeck instance...</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clear">
|
||||
|
|
|
|||
|
|
@ -152,7 +152,7 @@
|
|||
</div>
|
||||
<div id="bodyColumn">
|
||||
<div id="contentBox">
|
||||
<div class="section"><h2>Java client for the RunDeck REST API<a name="Java_client_for_the_RunDeck_REST_API"></a></h2></div><div class="section"><h3>What is it ?<a name="What_is_it_"></a></h3></div><p>A Java client (library) for the RunDeck HTTP REST API.</p><p><a class="externalLink" href="http://rundeck.org/">RunDeck</a> is an open-source tool for automating tasks on multiple nodes, with a CLI, a web-based interface and an HTTP REST API. You can read more about its API on the <a class="externalLink" href="http://rundeck.org/docs/RunDeck-Guide.html#rundeck-api">RunDeck User Manual</a>.</p><img src="images/rundeck.png" alt="" /><div class="section"><h3>What can I do with it ?<a name="What_can_I_do_with_it_"></a></h3></div><ul><li>Use it to write <a href="./scripting.html">scripts</a> (in <a href="./groovy.html">Groovy</a>, <a href="./jruby.html">JRuby</a> or <a href="./jython.html">Jython</a>), for example if you want to automate the execution of RunDeck jobs based on external events.</li><li>Use it in a Java application. A good example would be the <a class="externalLink" href="http://wiki.jenkins-ci.org/display/JENKINS/RunDeck+Plugin">Jenkins RunDeck plugin</a>, that needs to trigger RunDeck jobs from within the <a class="externalLink" href="http://jenkins-ci.org">Jenkins</a> continuous-integration server. Or the <a class="externalLink" href="https://github.com/vbehar/rundeck-remote-cli">RunDeck Remote CLI</a>, that provides a java-based CLI on top of the API.</li></ul><div class="section"><h3>Where can I get more information ?<a name="Where_can_I_get_more_information_"></a></h3></div><ul><li>You can read the <a href="./apidocs/index.html">API documentation</a>, starting with the <a href="./apidocs/org/rundeck/api/RundeckClient.html">RundeckClient</a> class.</li><li>Or you can "Use the <a href="./source-repository.html">Source</a>, Luke !"</li><li>Read more on the Maven auto-generated pages : <a href="./project-info.html">project information</a> and <a href="./project-reports.html">project reports</a>.</li></ul><div class="section"><h3>Thanks to...<a name="Thanks_to..."></a></h3></div><ul><li><a class="externalLink" href="https://github.com">GitHub</a> for the <a href="./source-repository.html">source code</a> and <a href="./index.html">website</a> hosting</li><li><a class="externalLink" href="http://cloudbees.com">CloudBees</a> for the <a href="./integration.html">continuous integration</a> hosting</li><li><a class="externalLink" href="http://www.sonatype.com">Sonatype</a> for the <a href="./distribution-management.html">Nexus repository</a> hosting (and sync to Maven Central)</li></ul><img src="images/github.png" alt="" /><img src="images/cloudbees.png" alt="" />
|
||||
<div class="section"><h2>Java client for the RunDeck REST API<a name="Java_client_for_the_RunDeck_REST_API"></a></h2></div><div class="section"><h3>What is it ?<a name="What_is_it_"></a></h3></div><p>A Java client (library) for the RunDeck HTTP REST API.</p><p><a class="externalLink" href="http://rundeck.org/">RunDeck</a> is an open-source tool for automating tasks on multiple nodes, with a CLI, a web-based interface and an HTTP REST API. You can read more about its API on the <a class="externalLink" href="http://rundeck.org/docs/RunDeck-Guide.html#rundeck-api">RunDeck User Manual</a>.</p><img src="images/rundeck.png" alt="" /><div class="section"><h3>What can I do with it ?<a name="What_can_I_do_with_it_"></a></h3></div><ul><li>Use it to write <a href="./scripting.html">scripts</a> (in <a href="./groovy.html">Groovy</a>, <a href="./jruby.html">JRuby</a> or <a href="./jython.html">Jython</a>), for example if you want to automate the execution of RunDeck jobs based on external events.</li><li>Use it in a Java application. A good example would be the <a class="externalLink" href="http://wiki.jenkins-ci.org/display/JENKINS/RunDeck+Plugin">Jenkins RunDeck plugin</a>, that needs to trigger RunDeck jobs from within the <a class="externalLink" href="http://jenkins-ci.org">Jenkins</a> continuous-integration server. Or the <a class="externalLink" href="https://github.com/vbehar/rundeck-remote-cli">RunDeck Remote CLI</a>, that provides a java-based CLI on top of the API.</li></ul><div class="section"><h3>Where can I get more information ?<a name="Where_can_I_get_more_information_"></a></h3></div><ul><li>You can read the <a href="./apidocs/index.html">API documentation</a>, starting with the <a href="./apidocs/reference/org/rundeck/api/RundeckClient.html">RundeckClient</a> class.</li><li>Or you can "Use the <a href="./source-repository.html">Source</a>, Luke !"</li><li>Read more on the Maven auto-generated pages : <a href="./project-info.html">project information</a> and <a href="./project-reports.html">project reports</a>.</li></ul><div class="section"><h3>Thanks to...<a name="Thanks_to..."></a></h3></div><ul><li><a class="externalLink" href="https://github.com">GitHub</a> for the <a href="./source-repository.html">source code</a> and <a href="./index.html">website</a> hosting</li><li><a class="externalLink" href="http://cloudbees.com">CloudBees</a> for the <a href="./integration.html">continuous integration</a> hosting</li><li><a class="externalLink" href="http://www.sonatype.com">Sonatype</a> for the <a href="./distribution-management.html">Nexus repository</a> hosting (and sync to Maven Central)</li></ul><img src="images/github.png" alt="" /><img src="images/cloudbees.png" alt="" />
|
||||
</div>
|
||||
</div>
|
||||
<div class="clear">
|
||||
|
|
|
|||
|
|
@ -199,7 +199,7 @@ rundeck = RundeckClient.new("http://localhost:4440", "admin"
|
|||
|
||||
result = rundeck.importJobs("/tmp/jobs.xml", "xml")
|
||||
puts "#{result.succeededJobs.size} jobs successfully imported, #{result.skippedJobs.size} jobs skipped, and #{result.failedJobs.size} jobs failed"
|
||||
</pre></div><div class="section"><h3>And more...<a name="And_more..."></a></h3></div><p>See the API documentation of the <a href="./apidocs/org/rundeck/api/RundeckClient.html">RundeckClient</a> class for more interactions with your RunDeck instance...</p>
|
||||
</pre></div><div class="section"><h3>And more...<a name="And_more..."></a></h3></div><p>See the API documentation of the <a href="./apidocs/reference/org/rundeck/api/RundeckClient.html">RundeckClient</a> class for more interactions with your RunDeck instance...</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clear">
|
||||
|
|
|
|||
|
|
@ -188,7 +188,7 @@ rundeck = RundeckClient("http://localhost:4440", "admin", &q
|
|||
|
||||
result = rundeck.importJobs("/tmp/jobs.xml", "xml")
|
||||
print("%s jobs successfully imported, %s jobs skipped, and %s jobs failed" % (result.succeededJobs.size, result.skippedJobs.size, result.failedJobs.size))
|
||||
</pre></div><div class="section"><h3>And more...<a name="And_more..."></a></h3></div><p>See the API documentation of the <a href="./apidocs/org/rundeck/api/RundeckClient.html">RundeckClient</a> class for more interactions with your RunDeck instance...</p>
|
||||
</pre></div><div class="section"><h3>And more...<a name="And_more..."></a></h3></div><p>See the API documentation of the <a href="./apidocs/reference/org/rundeck/api/RundeckClient.html">RundeckClient</a> class for more interactions with your RunDeck instance...</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clear">
|
||||
|
|
|
|||
2
pmd.xml
2
pmd.xml
|
|
@ -1,3 +1,3 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<pmd version="4.2.5" timestamp="2011-08-03T22:00:34.473">
|
||||
<pmd version="4.2.5" timestamp="2011-08-03T22:07:56.921">
|
||||
</pmd>
|
||||
|
|
@ -10,6 +10,83 @@ javadoc proofread file: ./proof-read.txt
|
|||
=== reference/packages.html ===
|
||||
|
||||
|
||||
=== org/rundeck/api/parser/ExecutionParserTest.html ===
|
||||
Test the
|
||||
{@link/ExecutionParser}
|
||||
CONSTRUCTOR: ExecutionParserTest
|
||||
METHOD: parseAdhocExecution
|
||||
METHOD: parseMinimalistExecution
|
||||
METHOD: parseRunningExecution
|
||||
METHOD: parseSucceededExecution
|
||||
|
||||
|
||||
=== org/rundeck/api/parser/AbortParserTest.html ===
|
||||
Test the
|
||||
{@link/AbortParser}
|
||||
CONSTRUCTOR: AbortParserTest
|
||||
METHOD: parseFailedAbort
|
||||
METHOD: parsePendingAbort
|
||||
|
||||
|
||||
=== org/rundeck/api/parser/HistoryParserTest.html ===
|
||||
Test the
|
||||
{@link/HistoryParser}
|
||||
CONSTRUCTOR: HistoryParserTest
|
||||
METHOD: parseHistory
|
||||
|
||||
|
||||
=== org/rundeck/api/parser/ProjectParserTest.html ===
|
||||
Test the
|
||||
{@link/ProjectParser}
|
||||
CONSTRUCTOR: ProjectParserTest
|
||||
METHOD: parseProject
|
||||
|
||||
|
||||
=== org/rundeck/api/parser/JobsImportResultParserTest.html ===
|
||||
Test the
|
||||
{@link/JobsImportResultParser}
|
||||
CONSTRUCTOR: JobsImportResultParserTest
|
||||
METHOD: parseResult
|
||||
|
||||
|
||||
=== org/rundeck/api/parser/ListParserTest.html ===
|
||||
Test the
|
||||
{@link/ListParser}
|
||||
CONSTRUCTOR: ListParserTest
|
||||
METHOD: parseExecutions
|
||||
METHOD: parseJobs
|
||||
METHOD: parseNodes
|
||||
METHOD: parseProjects
|
||||
|
||||
|
||||
=== org/rundeck/api/parser/JobParserTest.html ===
|
||||
Test the
|
||||
{@link/JobParser}
|
||||
CONSTRUCTOR: JobParserTest
|
||||
METHOD: parseJob
|
||||
|
||||
|
||||
=== org/rundeck/api/parser/SystemInfoParserTest.html ===
|
||||
Test the
|
||||
{@link/SystemInfoParser}
|
||||
CONSTRUCTOR: SystemInfoParserTest
|
||||
METHOD: parseProject
|
||||
|
||||
|
||||
=== org/rundeck/api/parser/NodeParserTest.html ===
|
||||
Test the
|
||||
{@link/NodeParser}
|
||||
CONSTRUCTOR: NodeParserTest
|
||||
METHOD: parseNode
|
||||
|
||||
|
||||
=== org/rundeck/api/parser/StringParserTest.html ===
|
||||
Test the
|
||||
{@link/StringParser}
|
||||
CONSTRUCTOR: StringParserTest
|
||||
METHOD: parseJob
|
||||
|
||||
|
||||
=== org/rundeck/api/parser/EventParserTest.html ===
|
||||
Test the
|
||||
{@link/EventParser}
|
||||
|
|
@ -30,83 +107,6 @@ METHOD: loadSuccessDocument
|
|||
XML with an explicit "success" result should NOT throw an exception
|
||||
|
||||
|
||||
=== org/rundeck/api/parser/ProjectParserTest.html ===
|
||||
Test the
|
||||
{@link/ProjectParser}
|
||||
CONSTRUCTOR: ProjectParserTest
|
||||
METHOD: parseProject
|
||||
|
||||
|
||||
=== org/rundeck/api/parser/ListParserTest.html ===
|
||||
Test the
|
||||
{@link/ListParser}
|
||||
CONSTRUCTOR: ListParserTest
|
||||
METHOD: parseExecutions
|
||||
METHOD: parseJobs
|
||||
METHOD: parseNodes
|
||||
METHOD: parseProjects
|
||||
|
||||
|
||||
=== org/rundeck/api/parser/ExecutionParserTest.html ===
|
||||
Test the
|
||||
{@link/ExecutionParser}
|
||||
CONSTRUCTOR: ExecutionParserTest
|
||||
METHOD: parseAdhocExecution
|
||||
METHOD: parseMinimalistExecution
|
||||
METHOD: parseRunningExecution
|
||||
METHOD: parseSucceededExecution
|
||||
|
||||
|
||||
=== org/rundeck/api/parser/SystemInfoParserTest.html ===
|
||||
Test the
|
||||
{@link/SystemInfoParser}
|
||||
CONSTRUCTOR: SystemInfoParserTest
|
||||
METHOD: parseProject
|
||||
|
||||
|
||||
=== org/rundeck/api/parser/StringParserTest.html ===
|
||||
Test the
|
||||
{@link/StringParser}
|
||||
CONSTRUCTOR: StringParserTest
|
||||
METHOD: parseJob
|
||||
|
||||
|
||||
=== org/rundeck/api/parser/AbortParserTest.html ===
|
||||
Test the
|
||||
{@link/AbortParser}
|
||||
CONSTRUCTOR: AbortParserTest
|
||||
METHOD: parseFailedAbort
|
||||
METHOD: parsePendingAbort
|
||||
|
||||
|
||||
=== org/rundeck/api/parser/NodeParserTest.html ===
|
||||
Test the
|
||||
{@link/NodeParser}
|
||||
CONSTRUCTOR: NodeParserTest
|
||||
METHOD: parseNode
|
||||
|
||||
|
||||
=== org/rundeck/api/parser/HistoryParserTest.html ===
|
||||
Test the
|
||||
{@link/HistoryParser}
|
||||
CONSTRUCTOR: HistoryParserTest
|
||||
METHOD: parseHistory
|
||||
|
||||
|
||||
=== org/rundeck/api/parser/JobParserTest.html ===
|
||||
Test the
|
||||
{@link/JobParser}
|
||||
CONSTRUCTOR: JobParserTest
|
||||
METHOD: parseJob
|
||||
|
||||
|
||||
=== org/rundeck/api/parser/JobsImportResultParserTest.html ===
|
||||
Test the
|
||||
{@link/JobsImportResultParser}
|
||||
CONSTRUCTOR: JobsImportResultParserTest
|
||||
METHOD: parseResult
|
||||
|
||||
|
||||
=== org/rundeck/api/util/ParametersUtilTest.html ===
|
||||
Test the
|
||||
{@link/ParametersUtil}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue