mirror of
https://github.com/Fishwaldo/rundeck-api-java-client.git
synced 2025-07-11 23:48:33 +00:00
163 lines
8.6 KiB
HTML
163 lines
8.6 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 Jul 8, 2011 -->
|
|
<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>
|
|
<style type="text/css" media="all">
|
|
@import url("./css/maven-base.css");
|
|
@import url("./css/maven-theme.css");
|
|
@import url("./css/site.css");
|
|
</style>
|
|
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
|
|
<meta name="Date-Revision-yyyymmdd" content="20110708" />
|
|
<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 class="composite">
|
|
<div id="banner">
|
|
<div id="bannerLeft">
|
|
RunDeck API - Java Client
|
|
</div>
|
|
<div class="clear">
|
|
<hr/>
|
|
</div>
|
|
</div>
|
|
<div id="breadcrumbs">
|
|
|
|
|
|
<div class="xleft">
|
|
<a href="http://rundeck.org" class="externalLink" title="RunDeck">RunDeck</a>
|
|
>
|
|
<a href="./" title="RunDeck API - Java Client">RunDeck API - Java Client</a>
|
|
>
|
|
|
|
</div>
|
|
<div class="xright">
|
|
|
|
<span id="publishDate">Last Published: 2011-07-08</span>
|
|
| <span id="projectVersion">Version: 1.0</span>
|
|
</div>
|
|
<div class="clear">
|
|
<hr/>
|
|
</div>
|
|
</div>
|
|
<div id="leftColumn">
|
|
<div id="navcolumn">
|
|
|
|
|
|
<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="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">
|
|
<strong>About</strong>
|
|
</li>
|
|
<li class="none">
|
|
<a href="distribution-management.html" title="Distribution Management">Distribution Management</a>
|
|
</li>
|
|
<li class="none">
|
|
<a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a>
|
|
</li>
|
|
<li class="none">
|
|
<a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</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>
|
|
<li class="none">
|
|
<a href="dependencies.html" title="Dependencies">Dependencies</a>
|
|
</li>
|
|
<li class="none">
|
|
<a href="integration.html" title="Continuous Integration">Continuous Integration</a>
|
|
</li>
|
|
<li class="none">
|
|
<a href="team-list.html" title="Project Team">Project Team</a>
|
|
</li>
|
|
<li class="none">
|
|
<a href="license.html" title="Project License">Project License</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="collapsed">
|
|
<a href="project-reports.html" title="Project Reports">Project Reports</a>
|
|
</li>
|
|
</ul>
|
|
<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 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 <a class="externalLink" href="http://rundeck.org">RunDeck</a> HTTP REST API.</p><p>RunDeck 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><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.</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>And the code is available on <a class="externalLink" href="https://github.com/vbehar/rundeck-api-java-client">GitHub</a>.</li><li>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>
|
|
</div>
|
|
<div class="clear">
|
|
<hr/>
|
|
</div>
|
|
<div id="footer">
|
|
<div class="xright">
|
|
Copyright © 2011.
|
|
All Rights Reserved.
|
|
|
|
</div>
|
|
<div class="clear">
|
|
<hr/>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|