diff --git a/apidocs/allclasses-frame.html b/apidocs/allclasses-frame.html new file mode 100644 index 0000000..ce64ab6 --- /dev/null +++ b/apidocs/allclasses-frame.html @@ -0,0 +1,64 @@ + + + + + + + +All Classes (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + +All Classes +
+ + + + + +
ArgsUtil +
+AssertUtil +
+ExecutionParser +
+ExecutionsParser +
+JobParser +
+JobsParser +
+NodeParser +
+ParserHelper +
+ProjectParser +
+ProjectsParser +
+RundeckApiException +
+RundeckApiException.RundeckApiLoginException +
+RundeckClient +
+RundeckExecution +
+RundeckExecution.ExecutionStatus +
+RundeckJob +
+RundeckProject +
+
+ + + diff --git a/apidocs/allclasses-noframe.html b/apidocs/allclasses-noframe.html new file mode 100644 index 0000000..b8af368 --- /dev/null +++ b/apidocs/allclasses-noframe.html @@ -0,0 +1,64 @@ + + + + + + + +All Classes (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + +All Classes +
+ + + + + +
ArgsUtil +
+AssertUtil +
+ExecutionParser +
+ExecutionsParser +
+JobParser +
+JobsParser +
+NodeParser +
+ParserHelper +
+ProjectParser +
+ProjectsParser +
+RundeckApiException +
+RundeckApiException.RundeckApiLoginException +
+RundeckClient +
+RundeckExecution +
+RundeckExecution.ExecutionStatus +
+RundeckJob +
+RundeckProject +
+
+ + + diff --git a/apidocs/constant-values.html b/apidocs/constant-values.html new file mode 100644 index 0000000..33fc00d --- /dev/null +++ b/apidocs/constant-values.html @@ -0,0 +1,181 @@ + + + + + + + +Constant Field Values (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Constant Field Values

+
+
+Contents + + + + + + +
+org.rundeck.*
+ +

+ + + + + + + + + + + + + + + + + +
org.rundeck.api.RundeckClient
+public static final transient StringAPI_ENDPOINT"/api/1"
+public static final transient intAPI_VERSION1
+ +

+ +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/deprecated-list.html b/apidocs/deprecated-list.html new file mode 100644 index 0000000..387e61f --- /dev/null +++ b/apidocs/deprecated-list.html @@ -0,0 +1,147 @@ + + + + + + + +Deprecated List (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Deprecated API

+
+
+Contents + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/help-doc.html b/apidocs/help-doc.html new file mode 100644 index 0000000..afaf6c2 --- /dev/null +++ b/apidocs/help-doc.html @@ -0,0 +1,224 @@ + + + + + + + +API Help (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+How This API Document Is Organized

+
+This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

+Overview

+
+ +

+The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

+

+Package

+
+ +

+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

+
+

+Class/Interface

+
+ +

+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+ +

+Annotation Type

+
+ +

+Each annotation type has its own separate page with the following sections:

+
+ +

+Enum

+
+ +

+Each enum has its own separate page with the following sections:

+
+

+Use

+
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+

+Tree (Class Hierarchy)

+
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object. +
+

+Deprecated API

+
+The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+

+Index

+
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+

+Prev/Next

+These links take you to the next or previous class, interface, package, or related page.

+Frames/No Frames

+These links show and hide the HTML frames. All pages are available with or without frames. +

+

+Serialized Form

+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

+

+Constant Field Values

+The Constant Field Values page lists the static final fields and their values. +

+ + +This help file applies to API documentation generated using the standard doclet. + +
+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/index-all.html b/apidocs/index-all.html new file mode 100644 index 0000000..a4db0b7 --- /dev/null +++ b/apidocs/index-all.html @@ -0,0 +1,490 @@ + + + + + + + +Index (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +A E G H J L N O P R S T V
+

+A

+
+
API_ENDPOINT - +Static variable in class org.rundeck.api.RundeckClient +
  +
API_VERSION - +Static variable in class org.rundeck.api.RundeckClient +
  +
ArgsUtil - Class in org.rundeck.api.util
Utility class for RunDeck arguments
ArgsUtil() - +Constructor for class org.rundeck.api.util.ArgsUtil +
  +
AssertUtil - Class in org.rundeck.api.util
Utility class for assertions
AssertUtil() - +Constructor for class org.rundeck.api.util.AssertUtil +
  +
+
+

+E

+
+
equals(Object) - +Method in class org.rundeck.api.domain.RundeckExecution +
  +
equals(Object) - +Method in class org.rundeck.api.domain.RundeckJob +
  +
equals(Object) - +Method in class org.rundeck.api.domain.RundeckProject +
  +
equals(Object) - +Method in class org.rundeck.api.RundeckClient +
  +
ExecutionParser - Class in org.rundeck.api.parser
Parser for a single RundeckExecution
ExecutionParser() - +Constructor for class org.rundeck.api.parser.ExecutionParser +
  +
ExecutionParser(String) - +Constructor for class org.rundeck.api.parser.ExecutionParser +
  +
ExecutionsParser - Class in org.rundeck.api.parser
Parser for a List of RundeckExecution
ExecutionsParser(String) - +Constructor for class org.rundeck.api.parser.ExecutionsParser +
  +
+
+

+G

+
+
generateArgString(Properties) - +Static method in class org.rundeck.api.util.ArgsUtil +
Generates a RunDeck "argString" representing the given options. +
generateUrlEncodedArgString(Properties) - +Static method in class org.rundeck.api.util.ArgsUtil +
Generates and url-encode a RunDeck "argString" representing the given options. +
getAbortedBy() - +Method in class org.rundeck.api.domain.RundeckExecution +
  +
getDescription() - +Method in class org.rundeck.api.domain.RundeckExecution +
  +
getDescription() - +Method in class org.rundeck.api.domain.RundeckJob +
  +
getDescription() - +Method in class org.rundeck.api.domain.RundeckProject +
  +
getEndedAt() - +Method in class org.rundeck.api.domain.RundeckExecution +
  +
getExecution(Long) - +Method in class org.rundeck.api.RundeckClient +
Get a single execution, identified by the given ID +
getFullName() - +Method in class org.rundeck.api.domain.RundeckJob +
  +
getGroup() - +Method in class org.rundeck.api.domain.RundeckJob +
  +
getId() - +Method in class org.rundeck.api.domain.RundeckExecution +
  +
getId() - +Method in class org.rundeck.api.domain.RundeckJob +
  +
getJob() - +Method in class org.rundeck.api.domain.RundeckExecution +
  +
getJob(String) - +Method in class org.rundeck.api.RundeckClient +
Get the definition of a single job, identified by the given ID +
getJobExecutions(String) - +Method in class org.rundeck.api.RundeckClient +
Get the executions of the given job +
getJobs(String) - +Method in class org.rundeck.api.RundeckClient +
List all jobs that belongs to the given project +
getJobs(String, String, String, String...) - +Method in class org.rundeck.api.RundeckClient +
List the jobs that belongs to the given project, and matches the given criteria (jobFilter, groupPath and jobIds) +
getLogin() - +Method in class org.rundeck.api.RundeckClient +
  +
getName() - +Method in class org.rundeck.api.domain.RundeckJob +
  +
getName() - +Method in class org.rundeck.api.domain.RundeckProject +
  +
getPassword() - +Method in class org.rundeck.api.RundeckClient +
  +
getProject() - +Method in class org.rundeck.api.domain.RundeckJob +
  +
getProject(String) - +Method in class org.rundeck.api.RundeckClient +
Get the definition of a single project, identified by the given name +
getProjects() - +Method in class org.rundeck.api.RundeckClient +
List all projects +
getStartedAt() - +Method in class org.rundeck.api.domain.RundeckExecution +
  +
getStartedBy() - +Method in class org.rundeck.api.domain.RundeckExecution +
  +
getStatus() - +Method in class org.rundeck.api.domain.RundeckExecution +
  +
getUrl() - +Method in class org.rundeck.api.domain.RundeckExecution +
  +
getUrl() - +Method in class org.rundeck.api.RundeckClient +
  +
+
+

+H

+
+
hashCode() - +Method in class org.rundeck.api.domain.RundeckExecution +
  +
hashCode() - +Method in class org.rundeck.api.domain.RundeckJob +
  +
hashCode() - +Method in class org.rundeck.api.domain.RundeckProject +
  +
hashCode() - +Method in class org.rundeck.api.RundeckClient +
  +
+
+

+J

+
+
JobParser - Class in org.rundeck.api.parser
Parser for a single RundeckJob
JobParser() - +Constructor for class org.rundeck.api.parser.JobParser +
  +
JobParser(String) - +Constructor for class org.rundeck.api.parser.JobParser +
  +
JobsParser - Class in org.rundeck.api.parser
Parser for a List of RundeckJob
JobsParser(String) - +Constructor for class org.rundeck.api.parser.JobsParser +
  +
+
+

+L

+
+
loadDocument(HttpResponse) - +Static method in class org.rundeck.api.parser.ParserHelper +
Load an XML Document from the given RunDeck HttpResponse. +
loadDocument(InputStream) - +Static method in class org.rundeck.api.parser.ParserHelper +
Load an XML Document from the given InputStream +
+
+

+N

+
+
NodeParser<T> - Interface in org.rundeck.api.parser
Interface to be implemented for parsers that handle XML Nodes
notBlank(String, String) - +Static method in class org.rundeck.api.util.AssertUtil +
Test if the given String is blank (null, empty or only whitespace) +
notNull(Object, String) - +Static method in class org.rundeck.api.util.AssertUtil +
Test if the given Object is null +
+
+

+O

+
+
org.rundeck.api - package org.rundeck.api
 
org.rundeck.api.domain - package org.rundeck.api.domain
 
org.rundeck.api.parser - package org.rundeck.api.parser
 
org.rundeck.api.util - package org.rundeck.api.util
 
+
+

+P

+
+
parseNode(Node) - +Method in class org.rundeck.api.parser.ExecutionParser +
  +
parseNode(Node) - +Method in class org.rundeck.api.parser.ExecutionsParser +
  +
parseNode(Node) - +Method in class org.rundeck.api.parser.JobParser +
  +
parseNode(Node) - +Method in class org.rundeck.api.parser.JobsParser +
  +
parseNode(Node) - +Method in interface org.rundeck.api.parser.NodeParser +
Parse the given XML Node +
parseNode(Node) - +Method in class org.rundeck.api.parser.ProjectParser +
  +
parseNode(Node) - +Method in class org.rundeck.api.parser.ProjectsParser +
  +
ParserHelper - Class in org.rundeck.api.parser
Helper for parsing RunDeck responses
ParserHelper() - +Constructor for class org.rundeck.api.parser.ParserHelper +
  +
ping() - +Method in class org.rundeck.api.RundeckClient +
Try to "ping" the RunDeck instance to see if it is alive +
ProjectParser - Class in org.rundeck.api.parser
Parser for a single RundeckProject
ProjectParser() - +Constructor for class org.rundeck.api.parser.ProjectParser +
  +
ProjectParser(String) - +Constructor for class org.rundeck.api.parser.ProjectParser +
  +
ProjectsParser - Class in org.rundeck.api.parser
Parser for a List of RundeckProject
ProjectsParser(String) - +Constructor for class org.rundeck.api.parser.ProjectsParser +
  +
+
+

+R

+
+
RundeckApiException - Exception in org.rundeck.api
A generic (unchecked) exception when using the RunDeck API
RundeckApiException(String) - +Constructor for exception org.rundeck.api.RundeckApiException +
  +
RundeckApiException(String, Throwable) - +Constructor for exception org.rundeck.api.RundeckApiException +
  +
RundeckApiException.RundeckApiLoginException - Exception in org.rundeck.api
Specific login-related error
RundeckApiException.RundeckApiLoginException(String) - +Constructor for exception org.rundeck.api.RundeckApiException.RundeckApiLoginException +
  +
RundeckApiException.RundeckApiLoginException(String, Throwable) - +Constructor for exception org.rundeck.api.RundeckApiException.RundeckApiLoginException +
  +
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 +
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() - +Constructor for class org.rundeck.api.domain.RundeckJob +
  +
RundeckProject - Class in org.rundeck.api.domain
Represents a RunDeck project
RundeckProject() - +Constructor for class org.rundeck.api.domain.RundeckProject +
  +
+
+

+S

+
+
setAbortedBy(String) - +Method in class org.rundeck.api.domain.RundeckExecution +
  +
setDescription(String) - +Method in class org.rundeck.api.domain.RundeckExecution +
  +
setDescription(String) - +Method in class org.rundeck.api.domain.RundeckJob +
  +
setDescription(String) - +Method in class org.rundeck.api.domain.RundeckProject +
  +
setEndedAt(Date) - +Method in class org.rundeck.api.domain.RundeckExecution +
  +
setGroup(String) - +Method in class org.rundeck.api.domain.RundeckJob +
  +
setId(Long) - +Method in class org.rundeck.api.domain.RundeckExecution +
  +
setId(String) - +Method in class org.rundeck.api.domain.RundeckJob +
  +
setJob(RundeckJob) - +Method in class org.rundeck.api.domain.RundeckExecution +
  +
setName(String) - +Method in class org.rundeck.api.domain.RundeckJob +
  +
setName(String) - +Method in class org.rundeck.api.domain.RundeckProject +
  +
setProject(String) - +Method in class org.rundeck.api.domain.RundeckJob +
  +
setStartedAt(Date) - +Method in class org.rundeck.api.domain.RundeckExecution +
  +
setStartedBy(String) - +Method in class org.rundeck.api.domain.RundeckExecution +
  +
setStatus(RundeckExecution.ExecutionStatus) - +Method in class org.rundeck.api.domain.RundeckExecution +
  +
setUrl(String) - +Method in class org.rundeck.api.domain.RundeckExecution +
  +
+
+

+T

+
+
testCredentials() - +Method in class org.rundeck.api.RundeckClient +
Test your credentials (login/password) on the RunDeck instance +
toString() - +Method in class org.rundeck.api.domain.RundeckExecution +
  +
toString() - +Method in class org.rundeck.api.domain.RundeckJob +
  +
toString() - +Method in class org.rundeck.api.domain.RundeckProject +
  +
toString() - +Method in class org.rundeck.api.RundeckClient +
  +
triggerJob(String, Properties) - +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 + end of the job execution) +
+
+

+V

+
+
valueOf(String) - +Static method in enum org.rundeck.api.domain.RundeckExecution.ExecutionStatus +
Returns the enum constant of this type with the specified name. +
values() - +Static method in enum org.rundeck.api.domain.RundeckExecution.ExecutionStatus +
Returns an array containing the constants of this enum type, in +the order they are declared. +
+
+A E G H J L N O P R S T V + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/index.html b/apidocs/index.html new file mode 100644 index 0000000..ba59f06 --- /dev/null +++ b/apidocs/index.html @@ -0,0 +1,40 @@ + + + + + + + +RunDeck API - Java Client 1.0-SNAPSHOT API + + + + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="overview-summary.html">Non-frame version.</A> + + + diff --git a/apidocs/options b/apidocs/options new file mode 100644 index 0000000..fe3aa54 --- /dev/null +++ b/apidocs/options @@ -0,0 +1,26 @@ +-classpath +'/home/vinz/projects/perso/rundeck/rundeck-api-java-client/target/classes:/home/vinz/.m2/repository/xml-apis/xml-apis/1.0.b2/xml-apis-1.0.b2.jar:/home/vinz/.m2/repository/commons-lang/commons-lang/2.6/commons-lang-2.6.jar:/home/vinz/.m2/repository/org/apache/httpcomponents/httpclient/4.1.1/httpclient-4.1.1.jar:/home/vinz/.m2/repository/org/apache/httpcomponents/httpcore/4.1/httpcore-4.1.jar:/home/vinz/.m2/repository/jaxen/jaxen/1.1.1/jaxen-1.1.1.jar:/home/vinz/.m2/repository/dom4j/dom4j/1.6.1/dom4j-1.6.1.jar:/home/vinz/.m2/repository/xerces/xercesImpl/2.6.2/xercesImpl-2.6.2.jar:/home/vinz/.m2/repository/commons-logging/commons-logging/1.1.1/commons-logging-1.1.1.jar:/home/vinz/.m2/repository/xom/xom/1.0/xom-1.0.jar:/home/vinz/.m2/repository/com/ibm/icu/icu4j/2.6.1/icu4j-2.6.1.jar:/home/vinz/.m2/repository/xerces/xmlParserAPIs/2.6.2/xmlParserAPIs-2.6.2.jar:/home/vinz/.m2/repository/jdom/jdom/1.0/jdom-1.0.jar:/home/vinz/.m2/repository/commons-codec/commons-codec/1.4/commons-codec-1.4.jar:/home/vinz/.m2/repository/xalan/xalan/2.6.0/xalan-2.6.0.jar' +-encoding +'UTF-8' +-protected +-sourcepath +'/home/vinz/projects/perso/rundeck/rundeck-api-java-client/src/main/java' +-author +-bottom +'Copyright © 2011. All Rights Reserved.' +-charset +'UTF-8' +-d +'/home/vinz/projects/perso/rundeck/rundeck-api-java-client/target/site/apidocs' +-docencoding +'UTF-8' +-doctitle +'RunDeck API - Java Client 1.0-SNAPSHOT API' +-link +'http://java.sun.com/javase/6/docs/api' +-linkoffline +'http://download.oracle.com/javase/1.5.0/docs/api' '/home/vinz/projects/perso/rundeck/rundeck-api-java-client/target/javadoc-bundle-options' +-use +-version +-windowtitle +'RunDeck API - Java Client 1.0-SNAPSHOT API' \ No newline at end of file diff --git a/apidocs/org/rundeck/api/RundeckApiException.RundeckApiLoginException.html b/apidocs/org/rundeck/api/RundeckApiException.RundeckApiLoginException.html new file mode 100644 index 0000000..e457858 --- /dev/null +++ b/apidocs/org/rundeck/api/RundeckApiException.RundeckApiLoginException.html @@ -0,0 +1,285 @@ + + + + + + + +RundeckApiException.RundeckApiLoginException (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.rundeck.api +
+Class RundeckApiException.RundeckApiLoginException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.rundeck.api.RundeckApiException
+                  extended by org.rundeck.api.RundeckApiException.RundeckApiLoginException
+
+
+
All Implemented Interfaces:
Serializable
+
+
+
Enclosing class:
RundeckApiException
+
+
+
+
public static class RundeckApiException.RundeckApiLoginException
extends RundeckApiException
+ + +

+Specific login-related error +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from class org.rundeck.api.RundeckApiException
RundeckApiException.RundeckApiLoginException
+  + + + + + + + + + + + + + + +
+Constructor Summary
RundeckApiException.RundeckApiLoginException(String message) + +
+           
RundeckApiException.RundeckApiLoginException(String message, + Throwable cause) + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

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

+RundeckApiException.RundeckApiLoginException

+
+public RundeckApiException.RundeckApiLoginException(String message)
+
+
+
+ +

+RundeckApiException.RundeckApiLoginException

+
+public RundeckApiException.RundeckApiLoginException(String message,
+                                                    Throwable cause)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/RundeckApiException.html b/apidocs/org/rundeck/api/RundeckApiException.html new file mode 100644 index 0000000..09ed61f --- /dev/null +++ b/apidocs/org/rundeck/api/RundeckApiException.html @@ -0,0 +1,284 @@ + + + + + + + +RundeckApiException (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.rundeck.api +
+Class RundeckApiException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.rundeck.api.RundeckApiException
+
+
+
All Implemented Interfaces:
Serializable
+
+
+
Direct Known Subclasses:
RundeckApiException.RundeckApiLoginException
+
+
+
+
public class RundeckApiException
extends RuntimeException
+ + +

+A generic (unchecked) exception when using the RunDeck API +

+ +

+

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

+ + + + + + + + + + + +
+Nested Class Summary
+static classRundeckApiException.RundeckApiLoginException + +
+          Specific login-related error
+  + + + + + + + + + + + + + +
+Constructor Summary
RundeckApiException(String message) + +
+           
RundeckApiException(String message, + Throwable cause) + +
+           
+  + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

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

+RundeckApiException

+
+public RundeckApiException(String message)
+
+
+
+ +

+RundeckApiException

+
+public RundeckApiException(String message,
+                           Throwable cause)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/RundeckClient.html b/apidocs/org/rundeck/api/RundeckClient.html new file mode 100644 index 0000000..3c7f705 --- /dev/null +++ b/apidocs/org/rundeck/api/RundeckClient.html @@ -0,0 +1,757 @@ + + + + + + + +RundeckClient (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.rundeck.api +
+Class RundeckClient

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

+Main entry point to talk to a RunDeck instance +

+ +

+

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

+ + + + + + + + + + + + + + + +
+Field Summary
+static StringAPI_ENDPOINT + +
+           
+static intAPI_VERSION + +
+           
+  + + + + + + + + + + +
+Constructor Summary
RundeckClient(String url, + String login, + String password) + +
+          Instantiate a new RundeckClient for the RunDeck instance at the given url
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleanequals(Object obj) + +
+           
+ RundeckExecutiongetExecution(Long executionId) + +
+          Get a single execution, identified by the given ID
+ RundeckJobgetJob(String jobId) + +
+          Get the definition of a single job, identified by the given ID
+ List<RundeckExecution>getJobExecutions(String jobId) + +
+          Get the executions of the given job
+ List<RundeckJob>getJobs(String project) + +
+          List all jobs that belongs to the given project
+ List<RundeckJob>getJobs(String project, + String jobFilter, + String groupPath, + String... jobIds) + +
+          List the jobs that belongs to the given project, and matches the given criteria (jobFilter, groupPath and jobIds)
+ StringgetLogin() + +
+           
+ StringgetPassword() + +
+           
+ RundeckProjectgetProject(String projectName) + +
+          Get the definition of a single project, identified by the given name
+ List<RundeckProject>getProjects() + +
+          List all projects
+ StringgetUrl() + +
+           
+ inthashCode() + +
+           
+ voidping() + +
+          Try to "ping" the RunDeck instance to see if it is alive
+ voidtestCredentials() + +
+          Test your credentials (login/password) on the RunDeck instance
+ StringtoString() + +
+           
+ RundeckExecutiontriggerJob(String jobId, + Properties options) + +
+          Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the + end of the job execution)
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+API_VERSION

+
+public static final transient int API_VERSION
+
+
+
See Also:
Constant Field Values
+
+
+ +

+API_ENDPOINT

+
+public static final transient String API_ENDPOINT
+
+
+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+RundeckClient

+
+public RundeckClient(String url,
+                     String login,
+                     String password)
+
+
Instantiate a new RundeckClient for the RunDeck instance at the given url +

+

+
Parameters:
url - of the RunDeck instance ("http://localhost:4440", "http://rundeck.your-compagny.com/", etc)
login -
password -
+
+ + + + + + + + +
+Method Detail
+ +

+ping

+
+public void ping()
+          throws RundeckApiException
+
+
Try to "ping" the RunDeck instance to see if it is alive +

+

+
+
+
+ +
Throws: +
RundeckApiException - if the ping fails
+
+
+
+ +

+testCredentials

+
+public void testCredentials()
+                     throws RundeckApiException.RundeckApiLoginException
+
+
Test your credentials (login/password) on the RunDeck instance +

+

+
+
+
+ +
Throws: +
RundeckApiException.RundeckApiLoginException - if the login fails
+
+
+
+ +

+getJobs

+
+public List<RundeckJob> getJobs(String project)
+                         throws RundeckApiException,
+                                RundeckApiException.RundeckApiLoginException,
+                                IllegalArgumentException
+
+
List all jobs that belongs to the given project +

+

+
+
+
+
Parameters:
project - name of the project - mandatory +
Returns:
a List of RundeckJob : might be empty, but won't be null +
Throws: +
RundeckApiException - in case of error when calling the API +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project is blank (null, empty or whitespace)
See Also:
getJobs(String, String, String, String...)
+
+
+
+ +

+getJobs

+
+public List<RundeckJob> getJobs(String project,
+                                String jobFilter,
+                                String groupPath,
+                                String... jobIds)
+                         throws RundeckApiException,
+                                RundeckApiException.RundeckApiLoginException,
+                                IllegalArgumentException
+
+
List the jobs that belongs to the given project, and matches the given criteria (jobFilter, groupPath and jobIds) +

+

+
+
+
+
Parameters:
project - name of the project - mandatory
jobFilter - a filter for the job Name - optional
groupPath - a group or partial group path to include all jobs within that group path - optional
jobIds - a list of Job IDs to include - optional +
Returns:
a List of RundeckJob : might be empty, but won't be null +
Throws: +
RundeckApiException - in case of error when calling the API +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the project is blank (null, empty or whitespace)
See Also:
getJobs(String)
+
+
+
+ +

+getJob

+
+public RundeckJob getJob(String jobId)
+                  throws RundeckApiException,
+                         RundeckApiException.RundeckApiLoginException,
+                         IllegalArgumentException
+
+
Get the definition of a single job, identified by the given ID +

+

+
+
+
+
Parameters:
jobId - identifier of the job - mandatory +
Returns:
a RundeckJob instance +
Throws: +
RundeckApiException - in case of error when calling the API +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the jobId is blank (null, empty or whitespace)
+
+
+
+ +

+getJobExecutions

+
+public List<RundeckExecution> getJobExecutions(String jobId)
+                                        throws RundeckApiException,
+                                               RundeckApiException.RundeckApiLoginException,
+                                               IllegalArgumentException
+
+
Get the executions of the given job +

+

+
+
+
+
Parameters:
jobId - identifier of the job - mandatory +
Returns:
a List of RundeckExecution : might be empty, but won't be null +
Throws: +
RundeckApiException - in case of error when calling the API +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the jobId is blank (null, empty or whitespace)
+
+
+
+ +

+getExecution

+
+public RundeckExecution getExecution(Long executionId)
+                              throws RundeckApiException,
+                                     RundeckApiException.RundeckApiLoginException,
+                                     IllegalArgumentException
+
+
Get a single execution, identified by the given ID +

+

+
+
+
+
Parameters:
executionId - identifier of the execution - mandatory +
Returns:
a RundeckExecution instance +
Throws: +
RundeckApiException - in case of error when calling the API +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the executionId is null
+
+
+
+ +

+triggerJob

+
+public RundeckExecution triggerJob(String jobId,
+                                   Properties options)
+                            throws RundeckApiException,
+                                   RundeckApiException.RundeckApiLoginException,
+                                   IllegalArgumentException
+
+
Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the + end of the job execution) +

+

+
+
+
+
Parameters:
jobId - identifier of the job - mandatory
options - of the job - optional +
Returns:
a RundeckExecution instance representing the newly created (and running) execution +
Throws: +
RundeckApiException - in case of error when calling the API +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the jobId is blank (null, empty or whitespace)
+
+
+
+ +

+getProjects

+
+public List<RundeckProject> getProjects()
+                                 throws RundeckApiException,
+                                        RundeckApiException.RundeckApiLoginException
+
+
List all projects +

+

+
+
+
+ +
Returns:
a List of RundeckProject : might be empty, but won't be null +
Throws: +
RundeckApiException - in case of error when calling the API +
RundeckApiException.RundeckApiLoginException - if the login failed
+
+
+
+ +

+getProject

+
+public RundeckProject getProject(String projectName)
+                          throws RundeckApiException,
+                                 RundeckApiException.RundeckApiLoginException,
+                                 IllegalArgumentException
+
+
Get the definition of a single project, identified by the given name +

+

+
+
+
+
Parameters:
projectName - name of the project - mandatory +
Returns:
a RundeckProject instance +
Throws: +
RundeckApiException - in case of error when calling the API +
RundeckApiException.RundeckApiLoginException - if the login failed +
IllegalArgumentException - if the projectName is blank (null, empty or whitespace)
+
+
+
+ +

+getUrl

+
+public String getUrl()
+
+
+
+
+
+
+
+
+
+ +

+getLogin

+
+public String getLogin()
+
+
+
+
+
+
+
+
+
+ +

+getPassword

+
+public String getPassword()
+
+
+
+
+
+
+
+
+
+ +

+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
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/class-use/RundeckApiException.RundeckApiLoginException.html b/apidocs/org/rundeck/api/class-use/RundeckApiException.RundeckApiLoginException.html new file mode 100644 index 0000000..7778bbc --- /dev/null +++ b/apidocs/org/rundeck/api/class-use/RundeckApiException.RundeckApiLoginException.html @@ -0,0 +1,250 @@ + + + + + + + +Uses of Class org.rundeck.api.RundeckApiException.RundeckApiLoginException (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.rundeck.api.RundeckApiException.RundeckApiLoginException

+
+ + + + + + + + + +
+Packages that use RundeckApiException.RundeckApiLoginException
org.rundeck.api  
+  +

+ + + + + +
+Uses of RundeckApiException.RundeckApiLoginException in org.rundeck.api
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in org.rundeck.api that throw RundeckApiException.RundeckApiLoginException
+ RundeckExecutionRundeckClient.getExecution(Long executionId) + +
+          Get a single execution, identified by the given ID
+ RundeckJobRundeckClient.getJob(String jobId) + +
+          Get the definition of a single job, identified by the given ID
+ List<RundeckExecution>RundeckClient.getJobExecutions(String jobId) + +
+          Get the executions of the given job
+ List<RundeckJob>RundeckClient.getJobs(String project) + +
+          List all jobs that belongs to the given project
+ List<RundeckJob>RundeckClient.getJobs(String project, + String jobFilter, + String groupPath, + String... jobIds) + +
+          List the jobs that belongs to the given project, and matches the given criteria (jobFilter, groupPath and jobIds)
+ RundeckProjectRundeckClient.getProject(String projectName) + +
+          Get the definition of a single project, identified by the given name
+ List<RundeckProject>RundeckClient.getProjects() + +
+          List all projects
+ voidRundeckClient.testCredentials() + +
+          Test your credentials (login/password) on the RunDeck instance
+ RundeckExecutionRundeckClient.triggerJob(String jobId, + Properties options) + +
+          Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the + end of the job execution)
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/class-use/RundeckApiException.html b/apidocs/org/rundeck/api/class-use/RundeckApiException.html new file mode 100644 index 0000000..6186b24 --- /dev/null +++ b/apidocs/org/rundeck/api/class-use/RundeckApiException.html @@ -0,0 +1,303 @@ + + + + + + + +Uses of Class org.rundeck.api.RundeckApiException (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.rundeck.api.RundeckApiException

+
+ + + + + + + + + + + + + +
+Packages that use RundeckApiException
org.rundeck.api  
org.rundeck.api.parser  
+  +

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

+ + + + + + + + + +
Subclasses of RundeckApiException in org.rundeck.api
+static classRundeckApiException.RundeckApiLoginException + +
+          Specific login-related error
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in org.rundeck.api that throw RundeckApiException
+ RundeckExecutionRundeckClient.getExecution(Long executionId) + +
+          Get a single execution, identified by the given ID
+ RundeckJobRundeckClient.getJob(String jobId) + +
+          Get the definition of a single job, identified by the given ID
+ List<RundeckExecution>RundeckClient.getJobExecutions(String jobId) + +
+          Get the executions of the given job
+ List<RundeckJob>RundeckClient.getJobs(String project) + +
+          List all jobs that belongs to the given project
+ List<RundeckJob>RundeckClient.getJobs(String project, + String jobFilter, + String groupPath, + String... jobIds) + +
+          List the jobs that belongs to the given project, and matches the given criteria (jobFilter, groupPath and jobIds)
+ RundeckProjectRundeckClient.getProject(String projectName) + +
+          Get the definition of a single project, identified by the given name
+ List<RundeckProject>RundeckClient.getProjects() + +
+          List all projects
+ voidRundeckClient.ping() + +
+          Try to "ping" the RunDeck instance to see if it is alive
+ RundeckExecutionRundeckClient.triggerJob(String jobId, + Properties options) + +
+          Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the + end of the job execution)
+  +

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

+ + + + + + + + + + + + + +
Methods in org.rundeck.api.parser that throw RundeckApiException
+static org.dom4j.DocumentParserHelper.loadDocument(org.apache.http.HttpResponse httpResponse) + +
+          Load an XML Document from the given RunDeck HttpResponse.
+static org.dom4j.DocumentParserHelper.loadDocument(InputStream inputStream) + +
+          Load an XML Document from the given InputStream
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/class-use/RundeckClient.html b/apidocs/org/rundeck/api/class-use/RundeckClient.html new file mode 100644 index 0000000..ef03293 --- /dev/null +++ b/apidocs/org/rundeck/api/class-use/RundeckClient.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.rundeck.api.RundeckClient (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.rundeck.api.RundeckClient

+
+No usage of org.rundeck.api.RundeckClient +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+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 new file mode 100644 index 0000000..dd3a07b --- /dev/null +++ b/apidocs/org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html @@ -0,0 +1,362 @@ + + + + + + + +RundeckExecution.ExecutionStatus (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.rundeck.api.domain +
+Enum RundeckExecution.ExecutionStatus

+
+java.lang.Object
+  extended by java.lang.Enum<RundeckExecution.ExecutionStatus>
+      extended by org.rundeck.api.domain.RundeckExecution.ExecutionStatus
+
+
+
All Implemented Interfaces:
Serializable, Comparable<RundeckExecution.ExecutionStatus>
+
+
+
Enclosing class:
RundeckExecution
+
+
+
+
public static enum RundeckExecution.ExecutionStatus
extends Enum<RundeckExecution.ExecutionStatus>
+ + +

+The status of an execution +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
ABORTED + +
+           
FAILED + +
+           
RUNNING + +
+           
SUCCEEDED + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static RundeckExecution.ExecutionStatusvalueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static RundeckExecution.ExecutionStatus[]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
+ +

+RUNNING

+
+public static final RundeckExecution.ExecutionStatus RUNNING
+
+
+
+
+
+ +

+SUCCEEDED

+
+public static final RundeckExecution.ExecutionStatus SUCCEEDED
+
+
+
+
+
+ +

+FAILED

+
+public static final RundeckExecution.ExecutionStatus FAILED
+
+
+
+
+
+ +

+ABORTED

+
+public static final RundeckExecution.ExecutionStatus ABORTED
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static RundeckExecution.ExecutionStatus[] 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 (RundeckExecution.ExecutionStatus c : RundeckExecution.ExecutionStatus.values())
+    System.out.println(c);
+
+

+

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

+valueOf

+
+public static RundeckExecution.ExecutionStatus 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
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/domain/RundeckExecution.html b/apidocs/org/rundeck/api/domain/RundeckExecution.html new file mode 100644 index 0000000..5441dc3 --- /dev/null +++ b/apidocs/org/rundeck/api/domain/RundeckExecution.html @@ -0,0 +1,725 @@ + + + + + + + +RundeckExecution (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.rundeck.api.domain +
+Class RundeckExecution

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

+Represents a RunDeck execution, usually triggered by an API call. An execution could be a RundeckJob + execution or an "ad-hoc" execution. +

+ +

+

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

+ + + + + + + + + + + +
+Nested Class Summary
+static classRundeckExecution.ExecutionStatus + +
+          The status of an execution
+  + + + + + + + + + + +
+Constructor Summary
RundeckExecution() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleanequals(Object obj) + +
+           
+ StringgetAbortedBy() + +
+           
+ StringgetDescription() + +
+           
+ DategetEndedAt() + +
+           
+ LonggetId() + +
+           
+ RundeckJobgetJob() + +
+           
+ DategetStartedAt() + +
+           
+ StringgetStartedBy() + +
+           
+ RundeckExecution.ExecutionStatusgetStatus() + +
+           
+ StringgetUrl() + +
+           
+ inthashCode() + +
+           
+ voidsetAbortedBy(String abortedBy) + +
+           
+ voidsetDescription(String description) + +
+           
+ voidsetEndedAt(Date endedAt) + +
+           
+ voidsetId(Long id) + +
+           
+ voidsetJob(RundeckJob job) + +
+           
+ voidsetStartedAt(Date startedAt) + +
+           
+ voidsetStartedBy(String startedBy) + +
+           
+ voidsetStatus(RundeckExecution.ExecutionStatus status) + +
+           
+ voidsetUrl(String url) + +
+           
+ StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

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

+RundeckExecution

+
+public RundeckExecution()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getId

+
+public Long getId()
+
+
+
+
+
+
+
+
+
+ +

+setId

+
+public void setId(Long id)
+
+
+
+
+
+
+
+
+
+ +

+getUrl

+
+public String getUrl()
+
+
+
+
+
+
+
+
+
+ +

+setUrl

+
+public void setUrl(String url)
+
+
+
+
+
+
+
+
+
+ +

+getStatus

+
+public RundeckExecution.ExecutionStatus getStatus()
+
+
+
+
+
+
+
+
+
+ +

+setStatus

+
+public void setStatus(RundeckExecution.ExecutionStatus status)
+
+
+
+
+
+
+
+
+
+ +

+getJob

+
+public RundeckJob getJob()
+
+
+
+
+
+
+
+
+
+ +

+setJob

+
+public void setJob(RundeckJob job)
+
+
+
+
+
+
+
+
+
+ +

+getStartedBy

+
+public String getStartedBy()
+
+
+
+
+
+
+
+
+
+ +

+setStartedBy

+
+public void setStartedBy(String startedBy)
+
+
+
+
+
+
+
+
+
+ +

+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)
+
+
+
+
+
+
+
+
+
+ +

+getDescription

+
+public String getDescription()
+
+
+
+
+
+
+
+
+
+ +

+setDescription

+
+public void setDescription(String description)
+
+
+
+
+
+
+
+
+
+ +

+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
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/domain/RundeckJob.html b/apidocs/org/rundeck/api/domain/RundeckJob.html new file mode 100644 index 0000000..b2818ae --- /dev/null +++ b/apidocs/org/rundeck/api/domain/RundeckJob.html @@ -0,0 +1,554 @@ + + + + + + + +RundeckJob (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.rundeck.api.domain +
+Class RundeckJob

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

+Represents a RunDeck job +

+ +

+

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

+ + + + + + + + + + + +
+Constructor Summary
RundeckJob() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleanequals(Object obj) + +
+           
+ StringgetDescription() + +
+           
+ StringgetFullName() + +
+           
+ StringgetGroup() + +
+           
+ StringgetId() + +
+           
+ StringgetName() + +
+           
+ StringgetProject() + +
+           
+ inthashCode() + +
+           
+ voidsetDescription(String description) + +
+           
+ voidsetGroup(String group) + +
+           
+ voidsetId(String id) + +
+           
+ voidsetName(String name) + +
+           
+ voidsetProject(String project) + +
+           
+ StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

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

+RundeckJob

+
+public RundeckJob()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getFullName

+
+public String getFullName()
+
+
+
+
+
+ +
Returns:
the fullname : group + name (exact format is : "group/name")
+
+
+
+ +

+getId

+
+public String getId()
+
+
+
+
+
+
+
+
+
+ +

+setId

+
+public void setId(String id)
+
+
+
+
+
+
+
+
+
+ +

+getName

+
+public String getName()
+
+
+
+
+
+
+
+
+
+ +

+setName

+
+public void setName(String name)
+
+
+
+
+
+
+
+
+
+ +

+getGroup

+
+public String getGroup()
+
+
+
+
+
+
+
+
+
+ +

+setGroup

+
+public void setGroup(String group)
+
+
+
+
+
+
+
+
+
+ +

+getProject

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

+setProject

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

+getDescription

+
+public String getDescription()
+
+
+
+
+
+
+
+
+
+ +

+setDescription

+
+public void setDescription(String description)
+
+
+
+
+
+
+
+
+
+ +

+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
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/domain/RundeckProject.html b/apidocs/org/rundeck/api/domain/RundeckProject.html new file mode 100644 index 0000000..55bf608 --- /dev/null +++ b/apidocs/org/rundeck/api/domain/RundeckProject.html @@ -0,0 +1,399 @@ + + + + + + + +RundeckProject (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.rundeck.api.domain +
+Class RundeckProject

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

+Represents a RunDeck project +

+ +

+

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

+ + + + + + + + + + + +
+Constructor Summary
RundeckProject() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleanequals(Object obj) + +
+           
+ StringgetDescription() + +
+           
+ StringgetName() + +
+           
+ inthashCode() + +
+           
+ voidsetDescription(String description) + +
+           
+ voidsetName(String name) + +
+           
+ StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

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

+RundeckProject

+
+public RundeckProject()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getName

+
+public String getName()
+
+
+
+
+
+
+
+
+
+ +

+setName

+
+public void setName(String name)
+
+
+
+
+
+
+
+
+
+ +

+getDescription

+
+public String getDescription()
+
+
+
+
+
+
+
+
+
+ +

+setDescription

+
+public void setDescription(String description)
+
+
+
+
+
+
+
+
+
+ +

+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
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+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 new file mode 100644 index 0000000..7ce1569 --- /dev/null +++ b/apidocs/org/rundeck/api/domain/class-use/RundeckExecution.ExecutionStatus.html @@ -0,0 +1,214 @@ + + + + + + + +Uses of Class org.rundeck.api.domain.RundeckExecution.ExecutionStatus (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.rundeck.api.domain.RundeckExecution.ExecutionStatus

+
+ + + + + + + + + +
+Packages that use RundeckExecution.ExecutionStatus
org.rundeck.api.domain  
+  +

+ + + + + +
+Uses of RundeckExecution.ExecutionStatus in org.rundeck.api.domain
+  +

+ + + + + + + + + + + + + + + + + +
Methods in org.rundeck.api.domain that return RundeckExecution.ExecutionStatus
+ RundeckExecution.ExecutionStatusRundeckExecution.getStatus() + +
+           
+static RundeckExecution.ExecutionStatusRundeckExecution.ExecutionStatus.valueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static RundeckExecution.ExecutionStatus[]RundeckExecution.ExecutionStatus.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 RundeckExecution.ExecutionStatus
+ voidRundeckExecution.setStatus(RundeckExecution.ExecutionStatus status) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/domain/class-use/RundeckExecution.html b/apidocs/org/rundeck/api/domain/class-use/RundeckExecution.html new file mode 100644 index 0000000..6487cbc --- /dev/null +++ b/apidocs/org/rundeck/api/domain/class-use/RundeckExecution.html @@ -0,0 +1,252 @@ + + + + + + + +Uses of Class org.rundeck.api.domain.RundeckExecution (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

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

+
+ + + + + + + + + + + + + +
+Packages that use RundeckExecution
org.rundeck.api  
org.rundeck.api.parser  
+  +

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

+ + + + + + + + + + + + + +
Methods in org.rundeck.api that return RundeckExecution
+ RundeckExecutionRundeckClient.getExecution(Long executionId) + +
+          Get a single execution, identified by the given ID
+ RundeckExecutionRundeckClient.triggerJob(String jobId, + Properties options) + +
+          Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the + end of the job execution)
+  +

+ + + + + + + + + +
Methods in org.rundeck.api that return types with arguments of type RundeckExecution
+ List<RundeckExecution>RundeckClient.getJobExecutions(String jobId) + +
+          Get the executions of the given job
+  +

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

+ + + + + + + + + +
Methods in org.rundeck.api.parser that return RundeckExecution
+ RundeckExecutionExecutionParser.parseNode(org.dom4j.Node node) + +
+           
+  +

+ + + + + + + + + +
Methods in org.rundeck.api.parser that return types with arguments of type RundeckExecution
+ List<RundeckExecution>ExecutionsParser.parseNode(org.dom4j.Node node) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+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 new file mode 100644 index 0000000..82c3b0a --- /dev/null +++ b/apidocs/org/rundeck/api/domain/class-use/RundeckJob.html @@ -0,0 +1,298 @@ + + + + + + + +Uses of Class org.rundeck.api.domain.RundeckJob (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

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

+
+ + + + + + + + + + + + + + + + + +
+Packages that use RundeckJob
org.rundeck.api  
org.rundeck.api.domain  
org.rundeck.api.parser  
+  +

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

+ + + + + + + + + +
Methods in org.rundeck.api that return RundeckJob
+ RundeckJobRundeckClient.getJob(String jobId) + +
+          Get the definition of a single job, identified by the given ID
+  +

+ + + + + + + + + + + + + +
Methods in org.rundeck.api that return types with arguments of type RundeckJob
+ List<RundeckJob>RundeckClient.getJobs(String project) + +
+          List all jobs that belongs to the given project
+ List<RundeckJob>RundeckClient.getJobs(String project, + String jobFilter, + String groupPath, + String... jobIds) + +
+          List the jobs that belongs to the given project, and matches the given criteria (jobFilter, groupPath and jobIds)
+  +

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

+ + + + + + + + + +
Methods in org.rundeck.api.domain that return RundeckJob
+ RundeckJobRundeckExecution.getJob() + +
+           
+  +

+ + + + + + + + + +
Methods in org.rundeck.api.domain with parameters of type RundeckJob
+ voidRundeckExecution.setJob(RundeckJob job) + +
+           
+  +

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

+ + + + + + + + + +
Methods in org.rundeck.api.parser that return RundeckJob
+ RundeckJobJobParser.parseNode(org.dom4j.Node node) + +
+           
+  +

+ + + + + + + + + +
Methods in org.rundeck.api.parser that return types with arguments of type RundeckJob
+ List<RundeckJob>JobsParser.parseNode(org.dom4j.Node node) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/domain/class-use/RundeckProject.html b/apidocs/org/rundeck/api/domain/class-use/RundeckProject.html new file mode 100644 index 0000000..aa48f7d --- /dev/null +++ b/apidocs/org/rundeck/api/domain/class-use/RundeckProject.html @@ -0,0 +1,242 @@ + + + + + + + +Uses of Class org.rundeck.api.domain.RundeckProject (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

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

+
+ + + + + + + + + + + + + +
+Packages that use RundeckProject
org.rundeck.api  
org.rundeck.api.parser  
+  +

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

+ + + + + + + + + +
Methods in org.rundeck.api that return RundeckProject
+ RundeckProjectRundeckClient.getProject(String projectName) + +
+          Get the definition of a single project, identified by the given name
+  +

+ + + + + + + + + +
Methods in org.rundeck.api that return types with arguments of type RundeckProject
+ List<RundeckProject>RundeckClient.getProjects() + +
+          List all projects
+  +

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

+ + + + + + + + + +
Methods in org.rundeck.api.parser that return RundeckProject
+ RundeckProjectProjectParser.parseNode(org.dom4j.Node node) + +
+           
+  +

+ + + + + + + + + +
Methods in org.rundeck.api.parser that return types with arguments of type RundeckProject
+ List<RundeckProject>ProjectsParser.parseNode(org.dom4j.Node node) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/domain/package-frame.html b/apidocs/org/rundeck/api/domain/package-frame.html new file mode 100644 index 0000000..f4cd4b0 --- /dev/null +++ b/apidocs/org/rundeck/api/domain/package-frame.html @@ -0,0 +1,48 @@ + + + + + + + +org.rundeck.api.domain (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + +org.rundeck.api.domain + + + + +
+Classes  + +
+RundeckExecution +
+RundeckJob +
+RundeckProject
+ + + + + + +
+Enums  + +
+RundeckExecution.ExecutionStatus
+ + + + diff --git a/apidocs/org/rundeck/api/domain/package-summary.html b/apidocs/org/rundeck/api/domain/package-summary.html new file mode 100644 index 0000000..56887c6 --- /dev/null +++ b/apidocs/org/rundeck/api/domain/package-summary.html @@ -0,0 +1,180 @@ + + + + + + + +org.rundeck.api.domain (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package org.rundeck.api.domain +

+ + + + + + + + + + + + + + + + + +
+Class Summary
RundeckExecutionRepresents a RunDeck execution, usually triggered by an API call.
RundeckJobRepresents a RunDeck job
RundeckProjectRepresents a RunDeck project
+  + +

+ + + + + + + + + +
+Enum Summary
RundeckExecution.ExecutionStatusThe status of an execution
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/domain/package-tree.html b/apidocs/org/rundeck/api/domain/package-tree.html new file mode 100644 index 0000000..4bdc371 --- /dev/null +++ b/apidocs/org/rundeck/api/domain/package-tree.html @@ -0,0 +1,167 @@ + + + + + + + +org.rundeck.api.domain Class Hierarchy (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package org.rundeck.api.domain +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Enum Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/domain/package-use.html b/apidocs/org/rundeck/api/domain/package-use.html new file mode 100644 index 0000000..8b7584d --- /dev/null +++ b/apidocs/org/rundeck/api/domain/package-use.html @@ -0,0 +1,239 @@ + + + + + + + +Uses of Package org.rundeck.api.domain (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
org.rundeck.api.domain

+
+ + + + + + + + + + + + + + + + + +
+Packages that use org.rundeck.api.domain
org.rundeck.api  
org.rundeck.api.domain  
org.rundeck.api.parser  
+  +

+ + + + + + + + + + + + + + +
+Classes in org.rundeck.api.domain used by org.rundeck.api
RundeckExecution + +
+          Represents a RunDeck execution, usually triggered by an API call.
RundeckJob + +
+          Represents a RunDeck job
RundeckProject + +
+          Represents a RunDeck project
+  +

+ + + + + + + + + + + +
+Classes in org.rundeck.api.domain used by org.rundeck.api.domain
RundeckExecution.ExecutionStatus + +
+          The status of an execution
RundeckJob + +
+          Represents a RunDeck job
+  +

+ + + + + + + + + + + + + + +
+Classes in org.rundeck.api.domain used by org.rundeck.api.parser
RundeckExecution + +
+          Represents a RunDeck execution, usually triggered by an API call.
RundeckJob + +
+          Represents a RunDeck job
RundeckProject + +
+          Represents a RunDeck project
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/package-frame.html b/apidocs/org/rundeck/api/package-frame.html new file mode 100644 index 0000000..a36cbc1 --- /dev/null +++ b/apidocs/org/rundeck/api/package-frame.html @@ -0,0 +1,46 @@ + + + + + + + +org.rundeck.api (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + +org.rundeck.api + + + + +
+Classes  + +
+RundeckClient
+ + + + + + +
+Exceptions  + +
+RundeckApiException +
+RundeckApiException.RundeckApiLoginException
+ + + + diff --git a/apidocs/org/rundeck/api/package-summary.html b/apidocs/org/rundeck/api/package-summary.html new file mode 100644 index 0000000..5f6799b --- /dev/null +++ b/apidocs/org/rundeck/api/package-summary.html @@ -0,0 +1,176 @@ + + + + + + + +org.rundeck.api (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package org.rundeck.api +

+ + + + + + + + + +
+Class Summary
RundeckClientMain entry point to talk to a RunDeck instance
+  + +

+ + + + + + + + + + + + + +
+Exception Summary
RundeckApiExceptionA generic (unchecked) exception when using the RunDeck API
RundeckApiException.RundeckApiLoginExceptionSpecific login-related error
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/package-tree.html b/apidocs/org/rundeck/api/package-tree.html new file mode 100644 index 0000000..78ce074 --- /dev/null +++ b/apidocs/org/rundeck/api/package-tree.html @@ -0,0 +1,164 @@ + + + + + + + +org.rundeck.api Class Hierarchy (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package org.rundeck.api +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/package-use.html b/apidocs/org/rundeck/api/package-use.html new file mode 100644 index 0000000..1652603 --- /dev/null +++ b/apidocs/org/rundeck/api/package-use.html @@ -0,0 +1,196 @@ + + + + + + + +Uses of Package org.rundeck.api (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
org.rundeck.api

+
+ + + + + + + + + + + + + +
+Packages that use org.rundeck.api
org.rundeck.api  
org.rundeck.api.parser  
+  +

+ + + + + + + + + + + +
+Classes in org.rundeck.api used by org.rundeck.api
RundeckApiException + +
+          A generic (unchecked) exception when using the RunDeck API
RundeckApiException.RundeckApiLoginException + +
+          Specific login-related error
+  +

+ + + + + + + + +
+Classes in org.rundeck.api used by org.rundeck.api.parser
RundeckApiException + +
+          A generic (unchecked) exception when using the RunDeck API
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/parser/ExecutionParser.html b/apidocs/org/rundeck/api/parser/ExecutionParser.html new file mode 100644 index 0000000..c5fd754 --- /dev/null +++ b/apidocs/org/rundeck/api/parser/ExecutionParser.html @@ -0,0 +1,287 @@ + + + + + + + +ExecutionParser (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.rundeck.api.parser +
+Class ExecutionParser

+
+java.lang.Object
+  extended by org.rundeck.api.parser.ExecutionParser
+
+
+
All Implemented Interfaces:
NodeParser<RundeckExecution>
+
+
+
+
public class ExecutionParser
extends Object
implements NodeParser<RundeckExecution>
+ + +

+Parser for a single RundeckExecution +

+ +

+

+
Author:
+
Vincent Behar
+
+
+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
ExecutionParser() + +
+           
ExecutionParser(String xpath) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ RundeckExecutionparseNode(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
+ +

+ExecutionParser

+
+public ExecutionParser()
+
+
+
+ +

+ExecutionParser

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

+parseNode

+
+public RundeckExecution parseNode(org.dom4j.Node node)
+
+
Description copied from interface: NodeParser
+
Parse the given XML Node +

+

+
Specified by:
parseNode in interface NodeParser<RundeckExecution>
+
+
+ +
Returns:
any object holding the converted value
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/parser/ExecutionsParser.html b/apidocs/org/rundeck/api/parser/ExecutionsParser.html new file mode 100644 index 0000000..58aa23d --- /dev/null +++ b/apidocs/org/rundeck/api/parser/ExecutionsParser.html @@ -0,0 +1,273 @@ + + + + + + + +ExecutionsParser (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.rundeck.api.parser +
+Class ExecutionsParser

+
+java.lang.Object
+  extended by org.rundeck.api.parser.ExecutionsParser
+
+
+
All Implemented Interfaces:
NodeParser<List<RundeckExecution>>
+
+
+
+
public class ExecutionsParser
extends Object
implements NodeParser<List<RundeckExecution>>
+ + +

+Parser for a List of RundeckExecution +

+ +

+

+
Author:
+
Vincent Behar
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
ExecutionsParser(String xpath) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ List<RundeckExecution>parseNode(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
+ +

+ExecutionsParser

+
+public ExecutionsParser(String xpath)
+
+
+
Parameters:
xpath - of the executions elements
+
+ + + + + + + + +
+Method Detail
+ +

+parseNode

+
+public List<RundeckExecution> parseNode(org.dom4j.Node node)
+
+
Description copied from interface: NodeParser
+
Parse the given XML Node +

+

+
Specified by:
parseNode in interface NodeParser<List<RundeckExecution>>
+
+
+ +
Returns:
any object holding the converted value
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/parser/JobParser.html b/apidocs/org/rundeck/api/parser/JobParser.html new file mode 100644 index 0000000..8726259 --- /dev/null +++ b/apidocs/org/rundeck/api/parser/JobParser.html @@ -0,0 +1,287 @@ + + + + + + + +JobParser (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.rundeck.api.parser +
+Class JobParser

+
+java.lang.Object
+  extended by org.rundeck.api.parser.JobParser
+
+
+
All Implemented Interfaces:
NodeParser<RundeckJob>
+
+
+
+
public class JobParser
extends Object
implements NodeParser<RundeckJob>
+ + +

+Parser for a single RundeckJob +

+ +

+

+
Author:
+
Vincent Behar
+
+
+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
JobParser() + +
+           
JobParser(String xpath) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ RundeckJobparseNode(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
+ +

+JobParser

+
+public JobParser()
+
+
+
+ +

+JobParser

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

+parseNode

+
+public RundeckJob parseNode(org.dom4j.Node node)
+
+
Description copied from interface: NodeParser
+
Parse the given XML Node +

+

+
Specified by:
parseNode in interface NodeParser<RundeckJob>
+
+
+ +
Returns:
any object holding the converted value
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/parser/JobsParser.html b/apidocs/org/rundeck/api/parser/JobsParser.html new file mode 100644 index 0000000..e4414d2 --- /dev/null +++ b/apidocs/org/rundeck/api/parser/JobsParser.html @@ -0,0 +1,273 @@ + + + + + + + +JobsParser (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.rundeck.api.parser +
+Class JobsParser

+
+java.lang.Object
+  extended by org.rundeck.api.parser.JobsParser
+
+
+
All Implemented Interfaces:
NodeParser<List<RundeckJob>>
+
+
+
+
public class JobsParser
extends Object
implements NodeParser<List<RundeckJob>>
+ + +

+Parser for a List of RundeckJob +

+ +

+

+
Author:
+
Vincent Behar
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
JobsParser(String xpath) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ List<RundeckJob>parseNode(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
+ +

+JobsParser

+
+public JobsParser(String xpath)
+
+
+
Parameters:
xpath - of the jobs elements
+
+ + + + + + + + +
+Method Detail
+ +

+parseNode

+
+public List<RundeckJob> parseNode(org.dom4j.Node node)
+
+
Description copied from interface: NodeParser
+
Parse the given XML Node +

+

+
Specified by:
parseNode in interface NodeParser<List<RundeckJob>>
+
+
+ +
Returns:
any object holding the converted value
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/parser/NodeParser.html b/apidocs/org/rundeck/api/parser/NodeParser.html new file mode 100644 index 0000000..2a69045 --- /dev/null +++ b/apidocs/org/rundeck/api/parser/NodeParser.html @@ -0,0 +1,221 @@ + + + + + + + +NodeParser (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.rundeck.api.parser +
+Interface NodeParser<T>

+
+
All Known Implementing Classes:
ExecutionParser, ExecutionsParser, JobParser, JobsParser, ProjectParser, ProjectsParser
+
+
+
+
public interface NodeParser<T>
+ + +

+Interface to be implemented for parsers that handle XML Nodes +

+ +

+

+
Author:
+
Vincent Behar
+
+
+ +

+ + + + + + + + + + + + +
+Method Summary
+ TparseNode(org.dom4j.Node node) + +
+          Parse the given XML Node
+  +

+ + + + + + + + +
+Method Detail
+ +

+parseNode

+
+T parseNode(org.dom4j.Node node)
+
+
Parse the given XML Node +

+

+
Parameters:
node - +
Returns:
any object holding the converted value
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/parser/ParserHelper.html b/apidocs/org/rundeck/api/parser/ParserHelper.html new file mode 100644 index 0000000..b93b119 --- /dev/null +++ b/apidocs/org/rundeck/api/parser/ParserHelper.html @@ -0,0 +1,292 @@ + + + + + + + +ParserHelper (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.rundeck.api.parser +
+Class ParserHelper

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

+Helper for parsing RunDeck responses +

+ +

+

+
Author:
+
Vincent Behar
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
ParserHelper() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static org.dom4j.DocumentloadDocument(org.apache.http.HttpResponse httpResponse) + +
+          Load an XML Document from the given RunDeck HttpResponse.
+static org.dom4j.DocumentloadDocument(InputStream inputStream) + +
+          Load an XML Document from the given InputStream
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+ParserHelper

+
+public ParserHelper()
+
+
+ + + + + + + + +
+Method Detail
+ +

+loadDocument

+
+public static org.dom4j.Document loadDocument(org.apache.http.HttpResponse httpResponse)
+                                       throws RundeckApiException
+
+
Load an XML Document from the given RunDeck HttpResponse. +

+

+
Parameters:
httpResponse - from an API call to RunDeck +
Returns:
an XML Document +
Throws: +
RundeckApiException - if we failed to read the response, or if the response is an error
See Also:
loadDocument(InputStream)
+
+
+
+ +

+loadDocument

+
+public static org.dom4j.Document loadDocument(InputStream inputStream)
+                                       throws RundeckApiException
+
+
Load an XML Document from the given InputStream +

+

+
Parameters:
inputStream - from an API call to RunDeck +
Returns:
an XML Document +
Throws: +
RundeckApiException - if we failed to read the response, or if the response is an error
See Also:
loadDocument(HttpResponse)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/parser/ProjectParser.html b/apidocs/org/rundeck/api/parser/ProjectParser.html new file mode 100644 index 0000000..026d002 --- /dev/null +++ b/apidocs/org/rundeck/api/parser/ProjectParser.html @@ -0,0 +1,287 @@ + + + + + + + +ProjectParser (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.rundeck.api.parser +
+Class ProjectParser

+
+java.lang.Object
+  extended by org.rundeck.api.parser.ProjectParser
+
+
+
All Implemented Interfaces:
NodeParser<RundeckProject>
+
+
+
+
public class ProjectParser
extends Object
implements NodeParser<RundeckProject>
+ + +

+Parser for a single RundeckProject +

+ +

+

+
Author:
+
Vincent Behar
+
+
+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
ProjectParser() + +
+           
ProjectParser(String xpath) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ RundeckProjectparseNode(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
+ +

+ProjectParser

+
+public ProjectParser()
+
+
+
+ +

+ProjectParser

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

+parseNode

+
+public RundeckProject parseNode(org.dom4j.Node node)
+
+
Description copied from interface: NodeParser
+
Parse the given XML Node +

+

+
Specified by:
parseNode in interface NodeParser<RundeckProject>
+
+
+ +
Returns:
any object holding the converted value
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/parser/ProjectsParser.html b/apidocs/org/rundeck/api/parser/ProjectsParser.html new file mode 100644 index 0000000..6218ebc --- /dev/null +++ b/apidocs/org/rundeck/api/parser/ProjectsParser.html @@ -0,0 +1,273 @@ + + + + + + + +ProjectsParser (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.rundeck.api.parser +
+Class ProjectsParser

+
+java.lang.Object
+  extended by org.rundeck.api.parser.ProjectsParser
+
+
+
All Implemented Interfaces:
NodeParser<List<RundeckProject>>
+
+
+
+
public class ProjectsParser
extends Object
implements NodeParser<List<RundeckProject>>
+ + +

+Parser for a List of RundeckProject +

+ +

+

+
Author:
+
Vincent Behar
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
ProjectsParser(String xpath) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ List<RundeckProject>parseNode(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
+ +

+ProjectsParser

+
+public ProjectsParser(String xpath)
+
+
+
Parameters:
xpath - of the projects elements
+
+ + + + + + + + +
+Method Detail
+ +

+parseNode

+
+public List<RundeckProject> parseNode(org.dom4j.Node node)
+
+
Description copied from interface: NodeParser
+
Parse the given XML Node +

+

+
Specified by:
parseNode in interface NodeParser<List<RundeckProject>>
+
+
+ +
Returns:
any object holding the converted value
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+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 new file mode 100644 index 0000000..10e1fa1 --- /dev/null +++ b/apidocs/org/rundeck/api/parser/class-use/ExecutionParser.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.rundeck.api.parser.ExecutionParser (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

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

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

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/parser/class-use/ExecutionsParser.html b/apidocs/org/rundeck/api/parser/class-use/ExecutionsParser.html new file mode 100644 index 0000000..e8c2ebb --- /dev/null +++ b/apidocs/org/rundeck/api/parser/class-use/ExecutionsParser.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.rundeck.api.parser.ExecutionsParser (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

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

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

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+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 new file mode 100644 index 0000000..06ba467 --- /dev/null +++ b/apidocs/org/rundeck/api/parser/class-use/JobParser.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.rundeck.api.parser.JobParser (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

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

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

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/parser/class-use/JobsParser.html b/apidocs/org/rundeck/api/parser/class-use/JobsParser.html new file mode 100644 index 0000000..1761179 --- /dev/null +++ b/apidocs/org/rundeck/api/parser/class-use/JobsParser.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.rundeck.api.parser.JobsParser (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

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

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

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/parser/class-use/NodeParser.html b/apidocs/org/rundeck/api/parser/class-use/NodeParser.html new file mode 100644 index 0000000..0e97fe6 --- /dev/null +++ b/apidocs/org/rundeck/api/parser/class-use/NodeParser.html @@ -0,0 +1,221 @@ + + + + + + + +Uses of Interface org.rundeck.api.parser.NodeParser (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
org.rundeck.api.parser.NodeParser

+
+ + + + + + + + + +
+Packages that use NodeParser
org.rundeck.api.parser  
+  +

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Classes in org.rundeck.api.parser that implement NodeParser
+ classExecutionParser + +
+          Parser for a single RundeckExecution
+ classExecutionsParser + +
+          Parser for a List of RundeckExecution
+ classJobParser + +
+          Parser for a single RundeckJob
+ classJobsParser + +
+          Parser for a List of RundeckJob
+ classProjectParser + +
+          Parser for a single RundeckProject
+ classProjectsParser + +
+          Parser for a List of RundeckProject
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/parser/class-use/ParserHelper.html b/apidocs/org/rundeck/api/parser/class-use/ParserHelper.html new file mode 100644 index 0000000..aac1c09 --- /dev/null +++ b/apidocs/org/rundeck/api/parser/class-use/ParserHelper.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.rundeck.api.parser.ParserHelper (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

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

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

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/parser/class-use/ProjectParser.html b/apidocs/org/rundeck/api/parser/class-use/ProjectParser.html new file mode 100644 index 0000000..38df5f5 --- /dev/null +++ b/apidocs/org/rundeck/api/parser/class-use/ProjectParser.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.rundeck.api.parser.ProjectParser (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

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

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

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/parser/class-use/ProjectsParser.html b/apidocs/org/rundeck/api/parser/class-use/ProjectsParser.html new file mode 100644 index 0000000..86453db --- /dev/null +++ b/apidocs/org/rundeck/api/parser/class-use/ProjectsParser.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.rundeck.api.parser.ProjectsParser (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

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

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

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/parser/package-frame.html b/apidocs/org/rundeck/api/parser/package-frame.html new file mode 100644 index 0000000..7122a3d --- /dev/null +++ b/apidocs/org/rundeck/api/parser/package-frame.html @@ -0,0 +1,56 @@ + + + + + + + +org.rundeck.api.parser (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + +org.rundeck.api.parser + + + + +
+Interfaces  + +
+NodeParser
+ + + + + + +
+Classes  + +
+ExecutionParser +
+ExecutionsParser +
+JobParser +
+JobsParser +
+ParserHelper +
+ProjectParser +
+ProjectsParser
+ + + + diff --git a/apidocs/org/rundeck/api/parser/package-summary.html b/apidocs/org/rundeck/api/parser/package-summary.html new file mode 100644 index 0000000..7f5f67c --- /dev/null +++ b/apidocs/org/rundeck/api/parser/package-summary.html @@ -0,0 +1,196 @@ + + + + + + + +org.rundeck.api.parser (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package org.rundeck.api.parser +

+ + + + + + + + + +
+Interface Summary
NodeParser<T>Interface to be implemented for parsers that handle XML Nodes
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
ExecutionParserParser for a single RundeckExecution
ExecutionsParserParser for a List of RundeckExecution
JobParserParser for a single RundeckJob
JobsParserParser for a List of RundeckJob
ParserHelperHelper for parsing RunDeck responses
ProjectParserParser for a single RundeckProject
ProjectsParserParser for a List of RundeckProject
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/parser/package-tree.html b/apidocs/org/rundeck/api/parser/package-tree.html new file mode 100644 index 0000000..560d8a9 --- /dev/null +++ b/apidocs/org/rundeck/api/parser/package-tree.html @@ -0,0 +1,165 @@ + + + + + + + +org.rundeck.api.parser Class Hierarchy (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package org.rundeck.api.parser +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/parser/package-use.html b/apidocs/org/rundeck/api/parser/package-use.html new file mode 100644 index 0000000..3036980 --- /dev/null +++ b/apidocs/org/rundeck/api/parser/package-use.html @@ -0,0 +1,171 @@ + + + + + + + +Uses of Package org.rundeck.api.parser (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
org.rundeck.api.parser

+
+ + + + + + + + + +
+Packages that use org.rundeck.api.parser
org.rundeck.api.parser  
+  +

+ + + + + + + + +
+Classes in org.rundeck.api.parser used by org.rundeck.api.parser
NodeParser + +
+          Interface to be implemented for parsers that handle XML Nodes
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/util/ArgsUtil.html b/apidocs/org/rundeck/api/util/ArgsUtil.html new file mode 100644 index 0000000..8026928 --- /dev/null +++ b/apidocs/org/rundeck/api/util/ArgsUtil.html @@ -0,0 +1,288 @@ + + + + + + + +ArgsUtil (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.rundeck.api.util +
+Class ArgsUtil

+
+java.lang.Object
+  extended by org.rundeck.api.util.ArgsUtil
+
+
+
+
public class ArgsUtil
extends Object
+ + +

+Utility class for RunDeck arguments +

+ +

+

+
Author:
+
Vincent Behar
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
ArgsUtil() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static StringgenerateArgString(Properties options) + +
+          Generates a RunDeck "argString" representing the given options.
+static StringgenerateUrlEncodedArgString(Properties options) + +
+          Generates and url-encode a RunDeck "argString" representing the given options.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+ArgsUtil

+
+public ArgsUtil()
+
+
+ + + + + + + + +
+Method Detail
+ +

+generateUrlEncodedArgString

+
+public static String generateUrlEncodedArgString(Properties options)
+
+
Generates and url-encode a RunDeck "argString" representing the given options. Format of the argString is + "-key1 value1 -key2 'value 2 with spaces'" +

+

+
Parameters:
options - to be converted +
Returns:
an url-encoded string. null if options is null, empty if there are no valid options.
See Also:
generateArgString(Properties)
+
+
+
+ +

+generateArgString

+
+public static String generateArgString(Properties options)
+
+
Generates a RunDeck "argString" representing the given options. Format of the argString is + "-key1 value1 -key2 'value 2 with spaces'" +

+

+
Parameters:
options - to be converted +
Returns:
a string. null if options is null, empty if there are no valid options.
See Also:
generateUrlEncodedArgString(Properties)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/util/AssertUtil.html b/apidocs/org/rundeck/api/util/AssertUtil.html new file mode 100644 index 0000000..091787a --- /dev/null +++ b/apidocs/org/rundeck/api/util/AssertUtil.html @@ -0,0 +1,294 @@ + + + + + + + +AssertUtil (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.rundeck.api.util +
+Class AssertUtil

+
+java.lang.Object
+  extended by org.rundeck.api.util.AssertUtil
+
+
+
+
public class AssertUtil
extends Object
+ + +

+Utility class for assertions +

+ +

+

+
Author:
+
Vincent Behar
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
AssertUtil() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static voidnotBlank(String input, + String errorMessage) + +
+          Test if the given String is blank (null, empty or only whitespace)
+static voidnotNull(Object object, + String errorMessage) + +
+          Test if the given Object is null
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+AssertUtil

+
+public AssertUtil()
+
+
+ + + + + + + + +
+Method Detail
+ +

+notNull

+
+public static void notNull(Object object,
+                           String errorMessage)
+                    throws IllegalArgumentException
+
+
Test if the given Object is null +

+

+
Parameters:
object -
errorMessage - to be used if the object is null +
Throws: +
IllegalArgumentException - if the given object is null
+
+
+
+ +

+notBlank

+
+public static void notBlank(String input,
+                            String errorMessage)
+                     throws IllegalArgumentException
+
+
Test if the given String is blank (null, empty or only whitespace) +

+

+
Parameters:
input - string
errorMessage - to be used if the string is blank +
Throws: +
IllegalArgumentException - if the given string is blank
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/util/class-use/ArgsUtil.html b/apidocs/org/rundeck/api/util/class-use/ArgsUtil.html new file mode 100644 index 0000000..1fa8846 --- /dev/null +++ b/apidocs/org/rundeck/api/util/class-use/ArgsUtil.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.rundeck.api.util.ArgsUtil (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.rundeck.api.util.ArgsUtil

+
+No usage of org.rundeck.api.util.ArgsUtil +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/util/class-use/AssertUtil.html b/apidocs/org/rundeck/api/util/class-use/AssertUtil.html new file mode 100644 index 0000000..0471938 --- /dev/null +++ b/apidocs/org/rundeck/api/util/class-use/AssertUtil.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.rundeck.api.util.AssertUtil (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
org.rundeck.api.util.AssertUtil

+
+No usage of org.rundeck.api.util.AssertUtil +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/util/package-frame.html b/apidocs/org/rundeck/api/util/package-frame.html new file mode 100644 index 0000000..6e99df4 --- /dev/null +++ b/apidocs/org/rundeck/api/util/package-frame.html @@ -0,0 +1,35 @@ + + + + + + + +org.rundeck.api.util (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + +org.rundeck.api.util + + + + +
+Classes  + +
+ArgsUtil +
+AssertUtil
+ + + + diff --git a/apidocs/org/rundeck/api/util/package-summary.html b/apidocs/org/rundeck/api/util/package-summary.html new file mode 100644 index 0000000..d457dc3 --- /dev/null +++ b/apidocs/org/rundeck/api/util/package-summary.html @@ -0,0 +1,162 @@ + + + + + + + +org.rundeck.api.util (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package org.rundeck.api.util +

+ + + + + + + + + + + + + +
+Class Summary
ArgsUtilUtility class for RunDeck arguments
AssertUtilUtility class for assertions
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/util/package-tree.html b/apidocs/org/rundeck/api/util/package-tree.html new file mode 100644 index 0000000..3172991 --- /dev/null +++ b/apidocs/org/rundeck/api/util/package-tree.html @@ -0,0 +1,154 @@ + + + + + + + +org.rundeck.api.util Class Hierarchy (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package org.rundeck.api.util +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/org/rundeck/api/util/package-use.html b/apidocs/org/rundeck/api/util/package-use.html new file mode 100644 index 0000000..a1c9062 --- /dev/null +++ b/apidocs/org/rundeck/api/util/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package org.rundeck.api.util (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
org.rundeck.api.util

+
+No usage of org.rundeck.api.util +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/overview-frame.html b/apidocs/overview-frame.html new file mode 100644 index 0000000..ca665a2 --- /dev/null +++ b/apidocs/overview-frame.html @@ -0,0 +1,49 @@ + + + + + + + +Overview List (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + + + + +
+
+ + + + + +
All Classes +

+ +Packages +
+org.rundeck.api +
+org.rundeck.api.domain +
+org.rundeck.api.parser +
+org.rundeck.api.util +
+

+ +

+  + + diff --git a/apidocs/overview-summary.html b/apidocs/overview-summary.html new file mode 100644 index 0000000..74ed73e --- /dev/null +++ b/apidocs/overview-summary.html @@ -0,0 +1,169 @@ + + + + + + + +Overview (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +


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

+RunDeck API - Java Client 1.0-SNAPSHOT API +

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages
org.rundeck.api 
org.rundeck.api.domain 
org.rundeck.api.parser 
org.rundeck.api.util 
+ +


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/overview-tree.html b/apidocs/overview-tree.html new file mode 100644 index 0000000..94b279c --- /dev/null +++ b/apidocs/overview-tree.html @@ -0,0 +1,187 @@ + + + + + + + +Class Hierarchy (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For All Packages

+
+
+
Package Hierarchies:
org.rundeck.api, org.rundeck.api.domain, org.rundeck.api.parser, org.rundeck.api.util
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +

+Enum Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/package-list b/apidocs/package-list new file mode 100644 index 0000000..069e62e --- /dev/null +++ b/apidocs/package-list @@ -0,0 +1,4 @@ +org.rundeck.api +org.rundeck.api.domain +org.rundeck.api.parser +org.rundeck.api.util diff --git a/apidocs/packages b/apidocs/packages new file mode 100644 index 0000000..ee07304 --- /dev/null +++ b/apidocs/packages @@ -0,0 +1,4 @@ +org.rundeck.api.domain +org.rundeck.api +org.rundeck.api.parser +org.rundeck.api.util \ No newline at end of file diff --git a/apidocs/resources/inherit.gif b/apidocs/resources/inherit.gif new file mode 100644 index 0000000..c814867 Binary files /dev/null and b/apidocs/resources/inherit.gif differ diff --git a/apidocs/serialized-form.html b/apidocs/serialized-form.html new file mode 100644 index 0000000..255a929 --- /dev/null +++ b/apidocs/serialized-form.html @@ -0,0 +1,450 @@ + + + + + + + +Serialized Form (RunDeck API - Java Client 1.0-SNAPSHOT API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Serialized Form

+
+
+ + + + + +
+Package org.rundeck.api
+ +

+ + + + + +
+Class org.rundeck.api.RundeckApiException extends RuntimeException implements Serializable
+ +

+serialVersionUID: 1L + +

+ +

+ + + + + +
+Class org.rundeck.api.RundeckApiException.RundeckApiLoginException extends RundeckApiException implements Serializable
+ +

+serialVersionUID: 1L + +

+ +

+ + + + + +
+Class org.rundeck.api.RundeckClient extends Object implements Serializable
+ +

+serialVersionUID: 1L + +

+ + + + + +
+Serialized Fields
+ +

+url

+
+String url
+
+
+
+
+
+

+login

+
+String login
+
+
+
+
+
+

+password

+
+String password
+
+
+
+
+
+ + + + + +
+Package org.rundeck.api.domain
+ +

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

+serialVersionUID: 1L + +

+ + + + + +
+Serialized Fields
+ +

+id

+
+Long id
+
+
+
+
+
+

+url

+
+String url
+
+
+
+
+
+

+status

+
+RundeckExecution.ExecutionStatus status
+
+
+
+
+
+

+job

+
+RundeckJob job
+
+
Optional - only if it is a job execution +

+

+
+
+
+

+startedBy

+
+String startedBy
+
+
+
+
+
+

+startedAt

+
+Date startedAt
+
+
+
+
+
+

+endedAt

+
+Date endedAt
+
+
only if the execution has ended +

+

+
+
+
+

+abortedBy

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

+

+
+
+
+

+description

+
+String description
+
+
+
+
+ +

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

+serialVersionUID: 1L + +

+ + + + + +
+Serialized Fields
+ +

+id

+
+String id
+
+
+
+
+
+

+name

+
+String name
+
+
+
+
+
+

+group

+
+String group
+
+
+
+
+
+

+project

+
+String project
+
+
+
+
+
+

+description

+
+String description
+
+
+
+
+ +

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

+serialVersionUID: 1L + +

+ + + + + +
+Serialized Fields
+ +

+name

+
+String name
+
+
+
+
+
+

+description

+
+String description
+
+
+
+
+ +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+Copyright © 2011. All Rights Reserved. + + diff --git a/apidocs/stylesheet.css b/apidocs/stylesheet.css new file mode 100644 index 0000000..6ea9e51 --- /dev/null +++ b/apidocs/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} + diff --git a/changes-report.html b/changes-report.html new file mode 100644 index 0000000..e8b72b5 --- /dev/null +++ b/changes-report.html @@ -0,0 +1,119 @@ + + + + + + Changelog + + + + + + + + + + +
+ +
+
+
+

Changelog

Release History

VersionDateDescription
1.0Not yet releasedUse RunDeck REST API version 1 (RunDeck 1.2+)

Release 1.0 - Not yet released

TypeChangesBy

add

Initial releasevbehar
+
+
+
+
+
+ + + diff --git a/cpd.html b/cpd.html new file mode 100644 index 0000000..06e2f5d --- /dev/null +++ b/cpd.html @@ -0,0 +1,118 @@ + + + + + + CPD Results + + + + + + + + + +
+ +
+
+
+

CPD Results

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

Duplications

CPD found no problems in your source code.

+
+
+
+
+
+ + + diff --git a/cpd.xml b/cpd.xml new file mode 100644 index 0000000..4a4568b --- /dev/null +++ b/cpd.xml @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/css/maven-base.css b/css/maven-base.css index 37103d2..584ba23 100644 --- a/css/maven-base.css +++ b/css/maven-base.css @@ -141,3 +141,11 @@ div.clear hr{ margin: 0px; padding: 0px; } +#navcolumn img.imageLink, .imageLink { + padding-left: 0px; + padding-bottom: 0px; + padding-top: 0px; + padding-right: 2px; + border: 0px; + margin: 0px; +} diff --git a/css/site.css b/css/site.css index e69de29..055e7e2 100644 --- a/css/site.css +++ b/css/site.css @@ -0,0 +1 @@ +/* You can override this file with your own styles */ \ No newline at end of file diff --git a/dependencies.html b/dependencies.html index d6c4a78..235889e 100644 --- a/dependencies.html +++ b/dependencies.html @@ -1,274 +1,95 @@ - - - - - - - - - - - - + + - RunDeck API - Java Client - Project Dependencies + + Project Dependencies - - + + + +
+ + Built by Maven + + + +
-

Project Dependencies

-

compile

-

The following is a list of compile dependencies for this project. These dependencies are required to compile and run the application:

- - - - - - - - - - - - - - - - - - - - - - - - - -
GroupIdArtifactIdVersionType
commons-langcommons-lang2.6jar
dom4jdom4j1.6.1jar
jaxenjaxen1.1.1jar
org.apache.httpcomponentshttpclient4.1.1jar
-
-

test

-

The following is a list of test dependencies for this project. These dependencies are only required to compile and run unit tests for the application:

- - - - - - - - - - -
GroupIdArtifactIdVersionType
junitjunit4.8.1jar
-
-
-

Project Transitive Dependencies

-

The following is a list of transitive dependencies for this project. Transitive dependencies are the dependencies of the project dependencies.

-

compile

-

The following is a list of compile dependencies for this project. These dependencies are required to compile and run the application:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
GroupIdArtifactIdVersionType
com.ibm.icuicu4j2.6.1jar
commons-codeccommons-codec1.4jar
commons-loggingcommons-logging1.1.1jar
jdomjdom1.0jar
org.apache.httpcomponentshttpcore4.1jar
xalanxalan2.6.0jar
xercesxercesImpl2.6.2jar
xercesxmlParserAPIs2.6.2jar
xml-apisxml-apis1.0.b2jar
xomxom1.0jar
-
-
-

Project Dependency Graph

- -

Dependency Tree

-
  • org.rundeck:rundeck-api-java-client:jar:1.0-SNAPSHOT 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

    Common Public License Version 1.0: JUnit

    The Apache Software License, Version 2.0: Commons Codec, 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-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-
    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
    158.41 MB5,3234,8022511.5111
    compile: 14compile: 8.19 MBcompile: 5,056compile: 4,572compile: 221-compile: 10compile: 1
    test: 1test: 231.78 kBtest: 267test: 230test: 30-test: 1-

    -

    About RunDeck API - Java Client

    -

    Java client for the RunDeck REST API

    -
    - +

    About RunDeck API - Java Client

    Java client for the RunDeck REST API


    -

    Issue Tracking

    -

    No issue management system is defined. Please check back at a later date.

    -
    - +

    Overview

    This project uses GitHub to manage its issues.

    Issue Tracking

    Issues, bugs, and feature requests should be submitted to the following issue tracking system for this project.


    -

    Overview

    -

    Typically the licenses listed for the project are that of the project itself, and not of dependencies.

    -
    -

    Project License

    -

    The Apache Software License, Version 2.0

    -
    +        

    Overview

    Typically the licenses listed for the project are that of the project itself, and not of dependencies.

    Project License

    The Apache Software License, Version 2.0

                                      Apache License
                                Version 2.0, January 2004
                             http://www.apache.org/licenses/
    @@ -367,29 +291,18 @@
        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
        See the License for the specific language governing permissions and
        limitations under the License.
    -
    -
    -
    -
    - +

    -

    Project Mailing Lists

    -

    There are no mailing lists currently associated with this project.

    -
    - +

    Project Mailing Lists

    These are the mailing lists that have been established for this project. For each list, there is a subscribe, unsubscribe, and an archive link.

    NameSubscribeUnsubscribePostArchive
    rundeck-discussSubscribeUnsubscribePostgroups.google.com

    -

    Project Information

    -

    This document provides an overview of the various documents and links that are part of this project's general information. All of this content is automatically generated by Maven on behalf of the project.

    -

    Overview

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    DocumentDescription
    AboutJava client for the RunDeck REST API
    Continuous IntegrationThis is a link to the definitions of all continuous integration processes that builds and tests code on a frequent, regular basis.
    DependenciesThis document lists the project's dependencies and provides information on each dependency.
    Issue TrackingThis is a link to the issue management system for this project. Issues (bugs, features, change requests) can be created and queried using this link.
    Mailing ListsThis document provides subscription and archive information for this project's mailing lists.
    Plugin ManagementThis document lists the plugins that are defined through pluginManagement.
    Project LicenseThis is a link to the definitions of project licenses.
    Project PluginsThis document lists the build plugins and the report plugins used by this project.
    Project SummaryThis document lists other related information of this project
    Project TeamThis document provides information on the members of this project. These are the individuals who have contributed to the project in one form or another.
    Source RepositoryThis is a link to the online source repository that can be viewed via a web browser.
    -
    -
    - +

    Project Information

    This document provides an overview of the various documents and links that are part of this project's general information. All of this content is automatically generated by Maven on behalf of the project.

    Overview

    DocumentDescription
    AboutJava client for the RunDeck REST API
    Distribution ManagementThis document provides informations on the distribution management of this project.
    Mailing ListsThis document provides subscription and archive information for this project's mailing lists.
    Issue TrackingThis is a link to the issue management system for this project. Issues (bugs, features, change requests) can be created and queried using this link.
    Source RepositoryThis is a link to the online source repository that can be viewed via a web browser.
    Project SummaryThis document lists other related information of this project
    DependenciesThis document lists the project's dependencies and provides information on each dependency.
    Project TeamThis document provides information on the members of this project. These are the individuals who have contributed to the project in one form or another.
    Project LicenseThis is a link to the definitions of project licenses.

    -

    Project Summary

    -

    Project Information

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

    Project Organization

    -

    This project does not belong to an organization.

    -
    -

    Build Information

    - - - - - - - - - - - - - - - -
    FieldValue
    GroupIdorg.rundeck
    ArtifactIdrundeck-api-java-client
    Version1.0-SNAPSHOT
    Typejar
    -
    -
    - +

    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.0-SNAPSHOT
    Typejar
    JDK Rev1.5

    -

    Overview

    -

    This project uses a Source Content Management System to manage its source code.

    -
    -

    Web Access

    -

    The following is a link to the online source repository.

    - -
    -

    Anonymous access

    -

    Refer to the documentation of the SCM used for more information about anonymously check out. The connection url is:

    -
    git:git://github.com/vbehar/rundeck-api-java-client.git
    -
    -
    -

    Developer access

    -

    Refer to the documentation of the SCM used for more information about developer check out. The connection url is:

    -
    git:git@github.com:vbehar/rundeck-api-java-client.git
    -
    -
    -

    Access from behind a firewall

    -

    Refer to the documentation of the SCM used for more information about access behind a firewall.

    -
    - +

    Overview

    This project uses a Source Content Management System to manage its source code.

    Web Access

    The following is a link to the online source repository.

    Anonymous access

    Refer to the documentation of the SCM used for more information about anonymously check out. The connection url is:

    git:git://github.com/vbehar/rundeck-api-java-client.git

    Developer access

    Refer to the documentation of the SCM used for more information about developer check out. The connection url is:

    git:git@github.com:vbehar/rundeck-api-java-client.git

    Access from behind a firewall

    Refer to the documentation of the SCM used for more information about access behind a firewall.


    -

    The Team

    -

    A successful project requires many people to play many roles. Some members write code or documentation, while others are valuable as testers, submitting patches and suggestions.

    -

    The team is comprised of Members and Contributors. Members have direct access to the source of a project and actively evolve the code-base. Contributors improve the project through submission of patches and suggestions to the Members. The number of Contributors to the project is unbounded. Get involved today. All contributions to the project are greatly appreciated.

    -

    Members

    -

    The following is a list of developers with commit privileges that have directly contributed to the project in one way or another.

    - - - - - - -
    IdName
    vbeharVincent Behar
    -
    -

    Contributors

    -

    There are no contributors listed for this project. Please check back again later.

    -
    -
    - +