mirror of
https://github.com/Fishwaldo/rundeck-api-java-client.git
synced 2025-07-23 05:18:39 +00:00
169 lines
9.8 KiB
HTML
169 lines
9.8 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<!-- Generated by Apache Maven Doxia at Feb 21, 2013 -->
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
|
<title></title>
|
|
<link rel="stylesheet" href="./css/apache-maven-fluido.min.css" />
|
|
<link rel="stylesheet" href="./css/site.css" />
|
|
<link rel="stylesheet" href="./css/print.css" media="print" />
|
|
<style>body{padding-top: 20px;}</style>
|
|
|
|
<script type="text/javascript" src="./js/apache-maven-fluido.min.js"></script>
|
|
|
|
|
|
<meta name="Date-Revision-yyyymmdd" content="20130221" />
|
|
<meta http-equiv="Content-Language" content="en" />
|
|
|
|
<!-- Google Analytics -->
|
|
<script type="text/javascript">
|
|
|
|
var _gaq = _gaq || [];
|
|
_gaq.push(['_setAccount', 'UA-23435653-1']);
|
|
_gaq.push(['_trackPageview']);
|
|
|
|
(function() {
|
|
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
|
|
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
|
|
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
|
|
})();
|
|
|
|
</script>
|
|
</head>
|
|
<body>
|
|
|
|
|
|
<div class="container-fluid">
|
|
|
|
<div id="breadcrumbs">
|
|
<ul class="breadcrumb">
|
|
|
|
|
|
<li class="">
|
|
<a href="http://rundeck.org" class="externalLink" title="RunDeck">RunDeck</a>
|
|
<li class="divider ">/</li>
|
|
</li>
|
|
<li class="">
|
|
<a href="./" title="RunDeck API - Java Client">RunDeck API - Java Client</a>
|
|
<li class="divider ">/</li>
|
|
</li>
|
|
<li class=""></li>
|
|
|
|
|
|
<li id="publishDate" class="pull-right">Last Published: 2013-02-21</li> <li class="divider pull-right">|</li>
|
|
<li id="projectVersion" class="pull-right">Version: 6.0</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div id="leftColumn" class="sidebar">
|
|
<div class="well">
|
|
|
|
|
|
<h5>RunDeck API - Java Client</h5>
|
|
<ul>
|
|
<li class="none">
|
|
<strong>Introduction</strong>
|
|
</li>
|
|
<li class="none">
|
|
<a href="status.html" title="Status">Status</a>
|
|
</li>
|
|
<li class="none">
|
|
<a href="faq.html" title="FAQ">FAQ</a>
|
|
</li>
|
|
<li class="none">
|
|
<a href="download.html" title="Download">Download</a>
|
|
</li>
|
|
<li class="none">
|
|
<a href="changes-report.html" title="Changelog">Changelog</a>
|
|
</li>
|
|
<li class="none">
|
|
<a href="apidocs/index.html" title="API Documentation">API Documentation</a>
|
|
</li>
|
|
</ul>
|
|
<h5>Scripting examples</h5>
|
|
<ul>
|
|
<li class="none">
|
|
<a href="scripting.html" title="Introduction">Introduction</a>
|
|
</li>
|
|
<li class="none">
|
|
<a href="groovy.html" title="Groovy">Groovy</a>
|
|
</li>
|
|
<li class="none">
|
|
<a href="jruby.html" title="JRuby">JRuby</a>
|
|
</li>
|
|
<li class="none">
|
|
<a href="jython.html" title="Jython">Jython</a>
|
|
</li>
|
|
</ul>
|
|
<h5>Project Documentation</h5>
|
|
<ul>
|
|
<li class="expanded">
|
|
<a href="project-info.html" title="Project Information">Project Information</a>
|
|
<ul>
|
|
<li class="none">
|
|
<a href="integration.html" title="Continuous Integration">Continuous Integration</a>
|
|
</li>
|
|
<li class="none">
|
|
<a href="dependencies.html" title="Dependencies">Dependencies</a>
|
|
</li>
|
|
<li class="none">
|
|
<a href="distribution-management.html" title="Distribution Management">Distribution Management</a>
|
|
</li>
|
|
<li class="none">
|
|
<strong>About</strong>
|
|
</li>
|
|
<li class="none">
|
|
<a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
|
|
</li>
|
|
<li class="none">
|
|
<a href="license.html" title="Project License">Project License</a>
|
|
</li>
|
|
<li class="none">
|
|
<a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a>
|
|
</li>
|
|
<li class="none">
|
|
<a href="team-list.html" title="Project Team">Project Team</a>
|
|
</li>
|
|
<li class="none">
|
|
<a href="source-repository.html" title="Source Repository">Source Repository</a>
|
|
</li>
|
|
<li class="none">
|
|
<a href="project-summary.html" title="Project Summary">Project Summary</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="collapsed">
|
|
<a href="project-reports.html" title="Project Reports">Project Reports</a>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<div id="poweredBy">
|
|
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
|
|
<img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
|
|
</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="bodyColumn" class="content">
|
|
<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/api/index.html">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 class="section"><h3>Credit<a name="Credit"></a></h3></div><ul><li>Many thanks to <a class="externalLink" href="https://vbehar.github.com">Vincent Behar</a> for initial creation and development of this project!</li></ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer class="footer">
|
|
<div class="container-fluid">
|
|
<div class="row span16">Copyright © 2011-2013.
|
|
All Rights Reserved.
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</footer>
|
|
</body>
|
|
</html>
|