- * Deprecation Warning: These methods which take multiple arguments are deprecated in - * favor of single argument versions, and associated Builder classes to generate them. - * These methods will be removed in version 10 of this library: - *
- * You have 2 methods for authentication : login-based or token-based. If you want to use the first, you need to provide - * both a "login" and a "password". Otherwise, just provide a "token" (also called "auth-token"). See the RunDeck + * There are three methods for authentication : login-based or token-based or session-based. + * Login authentication requires + * both a "login" and a "password". Token-based requires a "token" (also called "auth-token"). See the RunDeck * documentation for generating such a token.
+ *+ * Session-based authentication allows re-use of a previous login session. See {@link #testAuth()}. + *
+ *+ * Deprecation notice: All public constructors for this class are deprecated. Use the {@link RundeckClientBuilder} or {@link #builder()} convenience method to create a RundeckClient. The public constructors will be made non-public in version 12 of this library. + *
*
*
* // using login-based authentication :
- * RundeckClient rundeck = new RundeckClient("http://localhost:4440", "admin", "admin");
+ * RundeckClient rundeck = RundeckClient.builder()
+ * .url("http://localhost:4440")
+ * .login("admin", "admin").build();
* // or for a token-based authentication :
- * RundeckClient rundeck = new RundeckClient("http://localhost:4440", "PDDNKo5VE29kpk4prOUDr2rsKdRkEvsD");
+ * RundeckClient rundeck = RundeckClient.builder()
+ * .url("http://localhost:4440")
+ * .token("PDDNKo5VE29kpk4prOUDr2rsKdRkEvsD").build();
*
* List<RundeckProject> projects = rundeck.getProjects();
*
@@ -91,6 +82,8 @@ public class RundeckClient implements Serializable {
private static final long serialVersionUID = 1L;
public static final String JOBS_IMPORT = "/jobs/import";
+ public static final String STORAGE_ROOT_PATH = "/storage/";
+ public static final String STORAGE_KEYS_PATH = "keys/";
/**
* Supported version numbers
@@ -101,6 +94,9 @@ public class RundeckClient implements Serializable {
V7(7),
V8(8),
V9(9),
+ V10(10),
+ V11(11),
+ V12(12),
;
private int versionNumber;
@@ -114,7 +110,7 @@ public class RundeckClient implements Serializable {
}
}
/** Version of the API supported */
- public static final transient int API_VERSION = Version.V9.getVersionNumber();
+ public static final transient int API_VERSION = Version.V12.getVersionNumber();
private static final String API = "/api/";
@@ -122,10 +118,10 @@ public class RundeckClient implements Serializable {
public static final transient String API_ENDPOINT = API + API_VERSION;
/** Default value for the "pooling interval" used when running jobs/commands/scripts */
- private static final transient long DEFAULT_POOLING_INTERVAL = 5;
+ public static final transient long DEFAULT_POOLING_INTERVAL = 5;
/** Default unit of the "pooling interval" used when running jobs/commands/scripts */
- private static final transient TimeUnit DEFAULT_POOLING_UNIT = TimeUnit.SECONDS;
+ public static final TimeUnit DEFAULT_POOLING_UNIT = TimeUnit.SECONDS;
/** URL of the RunDeck instance ("http://localhost:4440", "http://rundeck.your-compagny.com/", etc) */
private final String url;
@@ -180,6 +176,9 @@ public class RundeckClient implements Serializable {
* @param login to use for authentication on the RunDeck instance
* @param password to use for authentication on the RunDeck instance
* @throws IllegalArgumentException if the url, login or password is blank (null, empty or whitespace)
+ *
+ * @deprecated Use the builder {@link RundeckClientBuilder} or {@link #builder()}, this method will not be public in version 12 of this
+ * library.
*/
public RundeckClient(String url, String login, String password) throws IllegalArgumentException {
this(url);
@@ -199,9 +198,9 @@ public class RundeckClient implements Serializable {
* @param sessionID to use for session authentication on the RunDeck instance
* @param useToken should be true if using token, false if using sessionID
* @throws IllegalArgumentException if the url or token is blank (null, empty or whitespace)
- * @deprecated Use the builder {@link RundeckClientBuilder}, this method will not be public in version 10 of this library.
+ * @deprecated Use the builder {@link RundeckClientBuilder} or {@link #builder()}, this method will not be public in version 10 of this library.
*/
- public RundeckClient(String url, String token, String sessionID, boolean useToken) throws IllegalArgumentException {
+ private RundeckClient(String url, String token, String sessionID, boolean useToken) throws IllegalArgumentException {
this(url);
if(useToken){
@@ -219,6 +218,16 @@ public class RundeckClient implements Serializable {
}
+ /**
+ * Instantiate a new {@link RundeckClient} for the RunDeck instance at the given url,
+ * using token-based authentication. Either token must be valid
+ * @param url of the RunDeck instance ("http://localhost:4440", "http://rundeck.your-compagny.com/", etc)
+ * @param token to use for authentication on the RunDeck instance
+ * @throws IllegalArgumentException if the url or token is blank (null, empty or whitespace)
+ * @deprecated Use the builder {@link RundeckClientBuilder} or {@link #builder()},
+ * this method will not be public in version 12 of this
+ * library.
+ */
public RundeckClient(String url, String token) throws IllegalArgumentException {
this(url, token, null, true);
}
@@ -259,7 +268,7 @@ public class RundeckClient implements Serializable {
}
/**
- * @deprecated Use {@link #testAuth()}
+ * @deprecated Use {@link #testAuth()}, will be removed in version 12 of this library.
* @see #testAuth()
*/
@Deprecated
@@ -267,10 +276,26 @@ public class RundeckClient implements Serializable {
testAuth();
}
+ /**
+ * Return root xpath for xml api results. for v11 and later it is empty, for earlier it is "result"
+ *
+ * @return
+ */
+ private String rootXpath() {
+ return getApiVersion() < Version.V11.getVersionNumber() ? "result" : "";
+ }
/*
* Projects
*/
+ private ProjectParser createProjectParser() {
+ return createProjectParser(null);
+ }
+
+ private ProjectParser createProjectParser(final String xpath) {
+ return new ProjectParserV11(xpath);
+ }
+
/**
* List all projects
*
@@ -282,7 +307,8 @@ public class RundeckClient implements Serializable {
public List getProjects() throws RundeckApiException, RundeckApiLoginException,
RundeckApiTokenException {
return new ApiCall(this).get(new ApiPathBuilder("/projects"),
- new ListParser(new ProjectParser(), "result/projects/project"));
+ new ListParser(createProjectParser(), rootXpath() +
+ "/projects/project"));
}
/**
@@ -299,7 +325,274 @@ public class RundeckClient implements Serializable {
RundeckApiTokenException, IllegalArgumentException {
AssertUtil.notBlank(projectName, "projectName is mandatory to get the details of a project !");
return new ApiCall(this).get(new ApiPathBuilder("/project/", projectName),
- new ProjectParser("result/projects/project"));
+ createProjectParser(rootXpath() +
+ (getApiVersion() < Version.V11.getVersionNumber()
+ ? "/projects/project"
+ : "/project"
+ )));
+ }
+
+ /**
+ * Create a new project, and return the new definition
+ *
+ * @param projectName name of the project - mandatory
+ * @param configuration project configuration properties
+ *
+ * @return a {@link RundeckProject} instance - won't be null
+ *
+ * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
+ * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
+ * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
+ * @throws IllegalArgumentException if the projectName is blank (null, empty or whitespace)
+ */
+ public RundeckProject createProject(String projectName, Map configuration) throws
+ RundeckApiException, RundeckApiLoginException,
+ RundeckApiTokenException, IllegalArgumentException {
+
+ AssertUtil.notBlank(projectName, "projectName is mandatory to create a project !");
+ return new ApiCall(this)
+ .post(new ApiPathBuilder("/projects").xml(
+ projectDocument(projectName, configuration)
+ ), createProjectParser(rootXpath() +
+ (getApiVersion() < Version.V11.getVersionNumber()
+ ? "/projects/project"
+ : "/project"
+ )));
+ }
+ /**
+ * Delete a project
+ *
+ * @param projectName name of the project - mandatory
+ *
+ * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
+ * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
+ * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
+ * @throws IllegalArgumentException if the projectName is blank (null, empty or whitespace)
+ */
+ public void deleteProject(String projectName) throws
+ RundeckApiException, RundeckApiLoginException,
+ RundeckApiTokenException, IllegalArgumentException {
+
+ AssertUtil.notBlank(projectName, "projectName is mandatory to create a project !");
+ new ApiCall(this).delete(new ApiPathBuilder("/project/", projectName));
+ }
+ /**
+ * Convenience method to export the archive of a project to the specified file.
+ *
+ * @param projectName name of the project - mandatory
+ * @param out file to write to
+ * @return number of bytes written to the stream
+ *
+ * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
+ * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
+ * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
+ * @throws IllegalArgumentException if the projectName is blank (null, empty or whitespace)
+ */
+ public int exportProject(final String projectName, final File out) throws
+ RundeckApiException, RundeckApiLoginException,
+ RundeckApiTokenException, IllegalArgumentException, IOException {
+ final FileOutputStream fileOutputStream = new FileOutputStream(out);
+ try {
+ return exportProject(projectName, fileOutputStream);
+ }finally {
+ fileOutputStream.close();
+ }
+ }
+ /**
+ * Export the archive of a project to the specified outputstream
+ *
+ * @param projectName name of the project - mandatory
+ * @return number of bytes written to the stream
+ *
+ * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
+ * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
+ * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
+ * @throws IllegalArgumentException if the projectName is blank (null, empty or whitespace)
+ */
+ public int exportProject(String projectName, OutputStream out) throws
+ RundeckApiException, RundeckApiLoginException,
+ RundeckApiTokenException, IllegalArgumentException, IOException {
+
+ AssertUtil.notBlank(projectName, "projectName is mandatory to export a project archive!");
+ return new ApiCall(this).get(
+ new ApiPathBuilder("/project/", projectName, "/export")
+ .accept("application/zip"),
+ out);
+ }
+
+ /**
+ * Import a archive file to the specified project.
+ *
+ * @param projectName name of the project - mandatory
+ * @param archiveFile zip archive file
+ * @param includeExecutions if true, import executions defined in the archive, otherwise skip them
+ * @param preserveJobUuids if true, do not remove UUIDs from imported jobs, otherwise remove them
+ *
+ * @return Result of the import request, may contain a list of import error messages
+ *
+ * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
+ * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
+ * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
+ * @throws IllegalArgumentException if the projectName is blank (null, empty or whitespace)
+ */
+ public ArchiveImport importArchive(final String projectName, final File archiveFile,
+ final boolean includeExecutions, final boolean preserveJobUuids) throws
+ RundeckApiException, RundeckApiLoginException,
+ RundeckApiTokenException, IllegalArgumentException, IOException {
+
+ AssertUtil.notBlank(projectName, "projectName is mandatory to import a project archive!");
+ AssertUtil.notNull(archiveFile, "archiveFile is mandatory to import a project archive!"); ;
+ return callImportProject(projectName, includeExecutions, preserveJobUuids,
+ new ApiPathBuilder().content("application/zip", archiveFile));
+ }
+
+ private ArchiveImport callImportProject(final String projectName, final boolean includeExecutions, final boolean preserveJobUuids,
+ final ApiPathBuilder param) {
+ param.paths("/project/", projectName, "/import")
+ .param("importExecutions", includeExecutions)
+ .param("jobUuidOption", preserveJobUuids ? "preserve" : "remove");
+ return new ApiCall(this).put(
+ param,
+ new ArchiveImportParser()
+ );
+ }
+
+ /**
+ * Return the configuration of a project
+ *
+ * @param projectName name of the project - mandatory
+ *
+ * @return a {@link ProjectConfig} instance - won't be null
+ *
+ * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
+ * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
+ * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
+ * @throws IllegalArgumentException if the projectName is blank (null, empty or whitespace)
+ */
+ public ProjectConfig getProjectConfig(String projectName) throws
+ RundeckApiException, RundeckApiLoginException,
+ RundeckApiTokenException, IllegalArgumentException {
+
+ AssertUtil.notBlank(projectName, "projectName is mandatory to get the config of a project !");
+ return new ApiCall(this)
+ .get(new ApiPathBuilder("/project/", projectName, "/config"), new ProjectConfigParser("/config"));
+ }
+ /**
+ * Get a single project configuration key
+ *
+ * @param projectName name of the project - mandatory
+ * @param key name of the configuration key
+ *
+ * @return value, or null if the value is not set
+ *
+ * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
+ * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
+ * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
+ * @throws IllegalArgumentException if the projectName is blank (null, empty or whitespace)
+ */
+ public String getProjectConfig(final String projectName, final String key) throws
+ RundeckApiException, RundeckApiLoginException,
+ RundeckApiTokenException, IllegalArgumentException {
+
+ AssertUtil.notBlank(projectName, "projectName is mandatory to get the config of a project !");
+ AssertUtil.notBlank(key, "key is mandatory to get the config key value!");
+
+ ConfigProperty configProperty = null;
+ try {
+ configProperty = new ApiCall(this)
+ .get(new ApiPathBuilder("/project/", projectName, "/config/", key),
+ new ProjectConfigPropertyParser("/property"));
+ } catch (RundeckApiException.RundeckApiHttpStatusException e) {
+ if(404==e.getStatusCode()){
+ return null;
+ }
+ throw e;
+ }
+ return configProperty.getValue();
+ }
+ /**
+ * Set a single project configuration property value
+ *
+ * @param projectName name of the project - mandatory
+ * @param key name of the configuration property
+ * @param value value of the property
+ *
+ * @return new value
+ *
+ * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
+ * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
+ * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
+ * @throws IllegalArgumentException if the projectName is blank (null, empty or whitespace)
+ */
+ public String setProjectConfig(final String projectName, final String key, final String value) throws
+ RundeckApiException, RundeckApiLoginException,
+ RundeckApiTokenException, IllegalArgumentException {
+
+ AssertUtil.notBlank(projectName, "projectName is mandatory to set the config of a project !");
+ AssertUtil.notBlank(key, "key is mandatory to set the config key value!");
+ AssertUtil.notBlank(value, "value is mandatory to set the config key value!");
+
+ final ConfigProperty configProperty = new ApiCall(this)
+ .put(new ApiPathBuilder("/project/", projectName, "/config/", key)
+ .xml(new ProjectConfigPropertyGenerator(new ConfigProperty(key, value))),
+ new ProjectConfigPropertyParser("/property"));
+
+ return configProperty.getValue();
+ }
+ /**
+ * Set a single project configuration property value
+ *
+ * @param projectName name of the project - mandatory
+ * @param key name of the configuration property
+ * @param value value of the property
+ *
+ * @return new value
+ *
+ * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
+ * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
+ * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
+ * @throws IllegalArgumentException if the projectName is blank (null, empty or whitespace)
+ */
+ public void deleteProjectConfig(final String projectName, final String key) throws
+ RundeckApiException, RundeckApiLoginException,
+ RundeckApiTokenException, IllegalArgumentException {
+
+ AssertUtil.notBlank(projectName, "projectName is mandatory to set the config of a project !");
+ AssertUtil.notBlank(key, "key is mandatory to set the config key value!");
+
+ new ApiCall(this).delete(new ApiPathBuilder("/project/", projectName, "/config/",
+ key).accept("application/xml"));
+ }
+ /**
+ * Return the configuration of a project
+ *
+ * @param projectName name of the project - mandatory
+ *
+ * @return a {@link ProjectConfig} instance - won't be null
+ *
+ * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
+ * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
+ * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
+ * @throws IllegalArgumentException if the projectName is blank (null, empty or whitespace)
+ */
+ public ProjectConfig setProjectConfig(String projectName, Map configuration) throws
+ RundeckApiException, RundeckApiLoginException,
+ RundeckApiTokenException, IllegalArgumentException {
+
+ AssertUtil.notBlank(projectName, "projectName is mandatory to get the config of a project !");
+ return new ApiCall(this)
+ .put(new ApiPathBuilder("/project/", projectName, "/config")
+ .xml(new ProjectConfigGenerator(new ProjectConfig(configuration)))
+ , new ProjectConfigParser("/config"));
+ }
+
+ private Document projectDocument(String projectName, Map configuration) {
+ RundeckProject project = new RundeckProject();
+ project.setName(projectName);
+ if (null != configuration) {
+ project.setProjectConfig(new ProjectConfig(configuration));
+ }
+ return new ProjectGenerator(project).generateXmlDocument();
}
/*
@@ -359,7 +652,7 @@ public class RundeckClient implements Serializable {
.param("jobFilter", jobFilter)
.param("groupPath", groupPath)
.param("idlist", StringUtils.join(jobIds, ",")),
- new ListParser(new JobParser(), "result/jobs/job"));
+ new ListParser(new JobParser(), rootXpath()+"/jobs/job"));
}
/**
@@ -541,11 +834,13 @@ public class RundeckClient implements Serializable {
throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
AssertUtil.notNull(format, "format is mandatory to export jobs !");
AssertUtil.notBlank(project, "project is mandatory to export jobs !");
- return new ApiCall(this).get(new ApiPathBuilder("/jobs/export").param("format", format)
- .param("project", project)
- .param("jobFilter", jobFilter)
- .param("groupPath", groupPath)
- .param("idlist", StringUtils.join(jobIds, ",")));
+ return new ApiCall(this).get(new ApiPathBuilder("/jobs/export")
+ .accept(format == FileType.XML ? "text/xml" : "text/yaml")
+ .param("format", format)
+ .param("project", project)
+ .param("jobFilter", jobFilter)
+ .param("groupPath", groupPath)
+ .param("idlist", StringUtils.join(jobIds, ",")));
}
/**
@@ -632,193 +927,6 @@ public class RundeckClient implements Serializable {
return new ApiCall(this).get(new ApiPathBuilder("/job/", jobId).param("format", format));
}
- /**
- * Import the definitions of jobs, from the given file
- *
- * @param filename of the file containing the jobs definitions - mandatory
- * @param fileType type of the file. See {@link FileType} - mandatory
- * @return a {@link RundeckJobsImportResult} instance - won't be null
- * @throws RundeckApiException in case of error when calling the API
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the filename or fileType is blank (null, empty or whitespace), or the
- * fileType is invalid
- * @throws IOException if we failed to read the file
- * @see #importJobs(InputStream, String)
- * @see #importJobs(String, FileType, RundeckJobsImportMethod)
- * @deprecated use {@link #importJobs(RundeckJobsImport)}, this method will be removed in version 10 of this library.
- */
- public RundeckJobsImportResult importJobs(String filename, String fileType) throws RundeckApiException,
- RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException, IOException {
- AssertUtil.notBlank(fileType, "fileType is mandatory to import jobs !");
- return importJobs(filename, FileType.valueOf(StringUtils.upperCase(fileType)));
- }
-
- /**
- * Import the definitions of jobs, from the given file
- *
- * @param filename of the file containing the jobs definitions - mandatory
- * @param fileType type of the file. See {@link FileType} - mandatory
- * @return a {@link RundeckJobsImportResult} instance - won't be null
- * @throws RundeckApiException in case of error when calling the API
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the filename is blank (null, empty or whitespace), or the fileType is null
- * @throws IOException if we failed to read the file
- * @see #importJobs(InputStream, FileType)
- * @see #importJobs(String, FileType, RundeckJobsImportMethod)
- * @deprecated use {@link #importJobs(RundeckJobsImport)}, this method will be removed in version 10 of this
- * library.
- */
- public RundeckJobsImportResult importJobs(String filename, FileType fileType) throws RundeckApiException,
- RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException, IOException {
- return importJobs(filename, fileType, (RundeckJobsImportMethod) null);
- }
-
- /**
- * Import the definitions of jobs, from the given file, using the given behavior
- *
- * @param filename of the file containing the jobs definitions - mandatory
- * @param fileType type of the file. See {@link FileType} - mandatory
- * @param importBehavior see {@link RundeckJobsImportMethod}
- * @return a {@link RundeckJobsImportResult} instance - won't be null
- * @throws RundeckApiException in case of error when calling the API
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the filename or fileType is blank (null, empty or whitespace), or the
- * fileType or behavior is not valid
- * @throws IOException if we failed to read the file
- * @see #importJobs(InputStream, String, String)
- * @see #importJobs(String, FileType, RundeckJobsImportMethod)
- * @deprecated use {@link #importJobs(RundeckJobsImport)}, this method will be removed in version 10 of this
- * library.
- */
- public RundeckJobsImportResult importJobs(String filename, String fileType, String importBehavior)
- throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException,
- IOException {
- AssertUtil.notBlank(fileType, "fileType is mandatory to import jobs !");
- return importJobs(filename,
- FileType.valueOf(StringUtils.upperCase(fileType)),
- RundeckJobsImportMethod.valueOf(StringUtils.upperCase(importBehavior)));
- }
-
- /**
- * Import the definitions of jobs, from the given file, using the given behavior
- *
- * @param filename of the file containing the jobs definitions - mandatory
- * @param fileType type of the file. See {@link FileType} - mandatory
- * @param importBehavior see {@link RundeckJobsImportMethod}
- * @return a {@link RundeckJobsImportResult} instance - won't be null
- * @throws RundeckApiException in case of error when calling the API
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the filename is blank (null, empty or whitespace), or the fileType is null
- * @throws IOException if we failed to read the file
- * @see #importJobs(InputStream, FileType, RundeckJobsImportMethod)
- * @deprecated use {@link #importJobs(String, RundeckJobsImport)}, this method will be removed in version 10 of
- * this library.
- */
- public RundeckJobsImportResult importJobs(String filename, FileType fileType, RundeckJobsImportMethod importBehavior)
- throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException,
- IOException {
- AssertUtil.notBlank(filename, "filename (of jobs file) is mandatory to import jobs !");
- FileInputStream stream = null;
- try {
- stream = FileUtils.openInputStream(new File(filename));
- return importJobs(stream, fileType, importBehavior);
- } finally {
- IOUtils.closeQuietly(stream);
- }
- }
-
- /**
- * Import the definitions of jobs, from the given input stream
- *
- * @param stream inputStream for reading the definitions - mandatory
- * @param fileType type of the file. See {@link FileType} - mandatory
- * @return a {@link RundeckJobsImportResult} instance - won't be null
- * @throws RundeckApiException in case of error when calling the API
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the stream is null, or the fileType is blank (null, empty or whitespace) or
- * invalid
- * @see #importJobs(String, String)
- * @see #importJobs(InputStream, FileType, RundeckJobsImportMethod)
- * @deprecated use {@link #importJobs(RundeckJobsImport)}, this method will be removed in version 10 of this
- * library.
- */
- public RundeckJobsImportResult importJobs(InputStream stream, String fileType) throws RundeckApiException,
- RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
- AssertUtil.notBlank(fileType, "fileType is mandatory to import jobs !");
- return importJobs(stream, FileType.valueOf(StringUtils.upperCase(fileType)));
- }
-
- /**
- * Import the definitions of jobs, from the given input stream
- *
- * @param stream inputStream for reading the definitions - mandatory
- * @param fileType type of the file. See {@link FileType} - mandatory
- * @return a {@link RundeckJobsImportResult} instance - won't be null
- * @throws RundeckApiException in case of error when calling the API
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the stream or fileType is null
- * @see #importJobs(String, FileType)
- * @see #importJobs(InputStream, FileType, RundeckJobsImportMethod)
- * @deprecated use {@link #importJobs(RundeckJobsImport)}, this method will be removed in version 10 of this
- * library.
- */
- public RundeckJobsImportResult importJobs(InputStream stream, FileType fileType) throws RundeckApiException,
- RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
- return importJobs(stream, fileType, (RundeckJobsImportMethod) null);
- }
-
- /**
- * Import the definitions of jobs, from the given input stream, using the given behavior
- *
- * @param stream inputStream for reading the definitions - mandatory
- * @param fileType type of the file. See {@link FileType} - mandatory
- * @param importBehavior see {@link RundeckJobsImportMethod}
- * @return a {@link RundeckJobsImportResult} instance - won't be null
- * @throws RundeckApiException in case of error when calling the API
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the stream is null, or the fileType is blank (null, empty or whitespace), or
- * the fileType or behavior is not valid
- * @see #importJobs(String, String, String)
- * @see #importJobs(InputStream, FileType, RundeckJobsImportMethod)
- * @deprecated use {@link #importJobs(RundeckJobsImport)}, this method will be removed in version 10 of this
- * library.
- */
- public RundeckJobsImportResult importJobs(InputStream stream, String fileType, String importBehavior)
- throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
- AssertUtil.notBlank(fileType, "fileType is mandatory to import jobs !");
- return importJobs(stream,
- FileType.valueOf(StringUtils.upperCase(fileType)),
- RundeckJobsImportMethod.valueOf(StringUtils.upperCase(importBehavior)));
- }
-
- /**
- * Import the definitions of jobs, from the given input stream, using the given behavior
- *
- * @param stream inputStream for reading the definitions - mandatory
- * @param fileType type of the file. See {@link FileType} - mandatory
- * @param importBehavior see {@link RundeckJobsImportMethod}
- * @return a {@link RundeckJobsImportResult} instance - won't be null
- * @throws RundeckApiException in case of error when calling the API
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the stream or fileType is null
- * @see #importJobs(String, FileType, RundeckJobsImportMethod)
- * @deprecated use {@link #importJobs(RundeckJobsImport)}, this method will be removed in version 10 of this
- * library.
- */
- public RundeckJobsImportResult importJobs(InputStream stream, FileType fileType,
- RundeckJobsImportMethod importBehavior) throws RundeckApiException, RundeckApiLoginException,
- RundeckApiTokenException, IllegalArgumentException {
- return importJobs(RundeckJobsImportBuilder.builder().setStream(stream).setFileType(fileType)
- .setJobsImportMethod(importBehavior).build());
- }
/**
* Import the definitions of jobs, from the given input stream, using the given behavior
@@ -877,7 +985,7 @@ public class RundeckClient implements Serializable {
//API v8
request.param("project", rundeckJobsImport.getProject());
}
- return new ApiCall(this).post(request, new JobsImportResultParser("result"));
+ return new ApiCall(this).post(request, new JobsImportResultParser(rootXpath()));
}
/**
@@ -933,7 +1041,8 @@ public class RundeckClient implements Serializable {
public String deleteJob(String jobId) throws RundeckApiException, RundeckApiLoginException,
RundeckApiTokenException, IllegalArgumentException {
AssertUtil.notBlank(jobId, "jobId is mandatory to delete a job !");
- return new ApiCall(this).delete(new ApiPathBuilder("/job/", jobId), new StringParser("result/success/message"));
+ new ApiCall(this).delete(new ApiPathBuilder("/job/", jobId));
+ return "Job " + jobId + " was deleted successfully";
}
/**
* Delete multiple jobs, identified by the given IDs
@@ -951,96 +1060,9 @@ public class RundeckClient implements Serializable {
throw new IllegalArgumentException("jobIds are mandatory to delete a job");
}
return new ApiCall(this).post(new ApiPathBuilder("/jobs/delete").field("ids",jobIds),
- new BulkDeleteParser("result/deleteJobs"));
+ new BulkDeleteParser(rootXpath()+"/deleteJobs"));
}
- /**
- * Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the
- * end of the job execution)
- *
- * @param jobId identifier of the job - mandatory
- * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace)
- * @see #triggerJob(String, Properties, Properties)
- * @see #runJob(String)
- * @deprecated use {@link #triggerJob(RunJob)}, this method will be removed in version 10 of this library
- */
- public RundeckExecution triggerJob(String jobId) throws RundeckApiException, RundeckApiLoginException,
- RundeckApiTokenException, IllegalArgumentException {
- return triggerJob(jobId, null);
- }
-
- /**
- * Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the
- * end of the job execution)
- *
- * @param jobId identifier of the job - mandatory
- * @param options of the job - optional. See {@link OptionsBuilder}.
- * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace)
- * @see #triggerJob(String, Properties, Properties)
- * @see #runJob(String, Properties)
- * @deprecated use {@link #triggerJob(RunJob)}, this method will be removed in version 10 of this library
- */
- public RundeckExecution triggerJob(String jobId, Properties options) throws RundeckApiException,
- RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
- return triggerJob(jobId, options, null);
- }
-
- /**
- * Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the
- * end of the job execution)
- *
- * @param jobId identifier of the job - mandatory
- * @param options of the job - optional. See {@link OptionsBuilder}.
- * @param nodeFilters for overriding the nodes on which the job will be executed - optional. See
- * {@link NodeFiltersBuilder}
- * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace)
- * @see #triggerJob(String)
- * @see #runJob(String, Properties, Properties)
- * @deprecated use {@link #triggerJob(RunJob)}, this method will be removed in version 10 of this library
- */
- public RundeckExecution triggerJob(String jobId, Properties options, Properties nodeFilters)
- throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
- return triggerJob(jobId, options, nodeFilters, null);
- }
- /**
- * Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the
- * end of the job execution)
- *
- * @param jobId identifier of the job - mandatory
- * @param options of the job - optional. See {@link OptionsBuilder}.
- * @param nodeFilters for overriding the nodes on which the job will be executed - optional. See
- * {@link NodeFiltersBuilder}
- * @param asUser specify a user name to run the job as, must have 'runAs' permission
- * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace)
- * @see #triggerJob(String)
- * @see #runJob(String, Properties, Properties)
- * @deprecated use {@link #triggerJob(RunJob)}, this method will be removed in version 10 of this library
- */
- public RundeckExecution triggerJob(String jobId, Properties options, Properties nodeFilters, String asUser)
- throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
- return triggerJob(RunJobBuilder.builder()
- .setJobId(jobId)
- .setOptions(options)
- .setNodeFilters(nodeFilters)
- .setAsUser(asUser)
- .build());
- }
/**
* Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the
* end of the job execution)
@@ -1063,75 +1085,18 @@ public class RundeckClient implements Serializable {
if(null!=jobRun.getAsUser()) {
apiPath.param("asUser", jobRun.getAsUser());
}
- return new ApiCall(this).get(apiPath, new ExecutionParser("result/executions/execution"));
+ return new ApiCall(this).get(apiPath,
+ APIV11Helper.unwrapIfNeeded(
+ new ExecutionParser(
+ rootXpath() +
+ "/executions/execution"
+ ), rootXpath() +
+ "/executions/execution"
+ )
+
+ );
}
- /**
- * Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.
- * We will poll the RunDeck server at regular interval (every 5 seconds) to know if the execution is finished (or
- * aborted) or is still running.
- *
- * @param jobId identifier of the job - mandatory
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace)
- * @see #triggerJob(String)
- * @see #runJob(String, Properties, Properties, long, TimeUnit)
- * @deprecated use {@link #runJob(RunJob, long, java.util.concurrent.TimeUnit)},
- * this method will be removed in version 10 of this library
- */
- public RundeckExecution runJob(String jobId) throws RundeckApiException, RundeckApiLoginException,
- RundeckApiTokenException, IllegalArgumentException {
- return runJob(jobId, null);
- }
-
- /**
- * Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.
- * We will poll the RunDeck server at regular interval (every 5 seconds) to know if the execution is finished (or
- * aborted) or is still running.
- *
- * @param jobId identifier of the job - mandatory
- * @param options of the job - optional. See {@link OptionsBuilder}.
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace)
- * @see #triggerJob(String, Properties)
- * @see #runJob(String, Properties, Properties, long, TimeUnit)
- * @deprecated use {@link #runJob(RunJob, long, java.util.concurrent.TimeUnit)},
- * this method will be removed in version 10 of this library
- */
- public RundeckExecution runJob(String jobId, Properties options) throws RundeckApiException,
- RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
- return runJob(jobId, options, null);
- }
-
- /**
- * Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.
- * We will poll the RunDeck server at regular interval (every 5 seconds) to know if the execution is finished (or
- * aborted) or is still running.
- *
- * @param jobId identifier of the job - mandatory
- * @param options of the job - optional. See {@link OptionsBuilder}.
- * @param nodeFilters for overriding the nodes on which the job will be executed - optional. See
- * {@link NodeFiltersBuilder}
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace)
- * @see #triggerJob(String, Properties, Properties)
- * @see #runJob(String, Properties, Properties, long, TimeUnit)
- * @deprecated use {@link #runJob(RunJob, long, java.util.concurrent.TimeUnit)},
- * this method will be removed in version 10 of this library
- */
- public RundeckExecution runJob(String jobId, Properties options, Properties nodeFilters)
- throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
- return runJob(jobId, options, nodeFilters, DEFAULT_POOLING_INTERVAL, DEFAULT_POOLING_UNIT);
- }
/**
* Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.
@@ -1153,87 +1118,6 @@ public class RundeckClient implements Serializable {
RundeckApiTokenException, IllegalArgumentException {
return runJob(runJob, DEFAULT_POOLING_INTERVAL, DEFAULT_POOLING_UNIT);
}
- /**
- * Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.
- * We will poll the RunDeck server at regular interval (configured by the poolingInterval/poolingUnit couple) to
- * know if the execution is finished (or aborted) or is still running.
- *
- * @param jobId identifier of the job - mandatory
- * @param options of the job - optional. See {@link OptionsBuilder}.
- * @param poolingInterval for checking the status of the execution. Must be > 0.
- * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds.
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace)
- * @see #triggerJob(String, Properties)
- * @see #runJob(String, Properties, Properties, long, TimeUnit)
- * @deprecated use {@link #runJob(RunJob, long, java.util.concurrent.TimeUnit)},
- * this method will be removed in version 10 of this library
- */
- public RundeckExecution runJob(String jobId, Properties options, long poolingInterval, TimeUnit poolingUnit)
- throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
- return runJob(jobId, options, null, poolingInterval, poolingUnit);
- }
-
- /**
- * Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.
- * We will poll the RunDeck server at regular interval (configured by the poolingInterval/poolingUnit couple) to
- * know if the execution is finished (or aborted) or is still running.
- *
- * @param jobId identifier of the job - mandatory
- * @param options of the job - optional. See {@link OptionsBuilder}.
- * @param nodeFilters for overriding the nodes on which the job will be executed - optional. See
- * {@link NodeFiltersBuilder}
- * @param poolingInterval for checking the status of the execution. Must be > 0.
- * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds.
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace)
- * @see #triggerJob(String, Properties)
- * @see #runJob(String, Properties, Properties, long, TimeUnit)
- * @deprecated use {@link #runJob(RunJob, long, java.util.concurrent.TimeUnit)},
- * this method will be removed in version 10 of this library
- */
- public RundeckExecution runJob(String jobId, Properties options, Properties nodeFilters, long poolingInterval,
- TimeUnit poolingUnit) throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException,
- IllegalArgumentException {
- return runJob(jobId, options, nodeFilters, null, poolingInterval, poolingUnit);
- }
- /**
- * Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.
- * We will poll the RunDeck server at regular interval (configured by the poolingInterval/poolingUnit couple) to
- * know if the execution is finished (or aborted) or is still running.
- *
- * @param jobId identifier of the job - mandatory
- * @param options of the job - optional. See {@link OptionsBuilder}.
- * @param nodeFilters for overriding the nodes on which the job will be executed - optional. See
- * {@link NodeFiltersBuilder}
- * @param asUser specify a user name to run the job as, must have 'runAs' permission
- * @param poolingInterval for checking the status of the execution. Must be > 0.
- * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds.
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace)
- * @see #triggerJob(String, Properties)
- * @see #runJob(String, Properties, Properties, long, TimeUnit)
- * @deprecated use {@link #runJob(RunJob, long, java.util.concurrent.TimeUnit)}, this method will be removed in version 10 of this library
- */
- public RundeckExecution runJob(String jobId, Properties options, Properties nodeFilters, String asUser, long poolingInterval,
- TimeUnit poolingUnit) throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException,
- IllegalArgumentException {
- return runJob(RunJobBuilder.builder()
- .setJobId(jobId)
- .setOptions(options)
- .setNodeFilters(nodeFilters)
- .setAsUser(asUser)
- .build(), poolingInterval, poolingUnit);
- }
/**
* Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.
@@ -1280,101 +1164,7 @@ public class RundeckClient implements Serializable {
* Ad-hoc commands
*/
- /**
- * Trigger the execution of an ad-hoc command, and return immediately (without waiting the end of the execution).
- * The command will not be dispatched to nodes, but be executed on the RunDeck server.
- *
- * @param project name of the project - mandatory
- * @param command to be executed - mandatory
- * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace)
- * @see #triggerAdhocCommand(String, String, Properties, Integer, Boolean)
- * @see #runAdhocCommand(String, String)
- * @deprecated use {@link #triggerAdhocCommand(RunAdhocCommand)}, will be removed in version 10 of this library
- */
- public RundeckExecution triggerAdhocCommand(String project, String command) throws RundeckApiException,
- RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
- return triggerAdhocCommand(project, command, null);
- }
- /**
- * Trigger the execution of an ad-hoc command, and return immediately (without waiting the end of the execution).
- * The command will be dispatched to nodes, accordingly to the nodeFilters parameter.
- *
- * @param project name of the project - mandatory
- * @param command to be executed - mandatory
- * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder}
- * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace)
- * @see #triggerAdhocCommand(String, String, Properties, Integer, Boolean)
- * @see #runAdhocCommand(String, String, Properties)
- * @deprecated use {@link #triggerAdhocCommand(RunAdhocCommand)}, will be removed in version 10 of this library
- */
- public RundeckExecution triggerAdhocCommand(String project, String command, Properties nodeFilters)
- throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
- return triggerAdhocCommand(project, command, nodeFilters, null, null);
- }
-
- /**
- * Trigger the execution of an ad-hoc command, and return immediately (without waiting the end of the execution).
- * The command will be dispatched to nodes, accordingly to the nodeFilters parameter.
- *
- * @param project name of the project - mandatory
- * @param command to be executed - mandatory
- * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder}
- * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional
- * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional
- * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace)
- * @see #triggerAdhocCommand(String, String)
- * @see #runAdhocCommand(String, String, Properties)
- * @deprecated use {@link #triggerAdhocCommand(RunAdhocCommand)}, will be removed in version 10 of this library
- */
- public RundeckExecution triggerAdhocCommand(String project, String command, Properties nodeFilters,
- Integer nodeThreadcount, Boolean nodeKeepgoing) throws RundeckApiException, RundeckApiLoginException,
- RundeckApiTokenException, IllegalArgumentException {
- return triggerAdhocCommand(project, command, nodeFilters, nodeThreadcount, nodeKeepgoing, null);
- }
- /**
- * Trigger the execution of an ad-hoc command, and return immediately (without waiting the end of the execution).
- * The command will be dispatched to nodes, accordingly to the nodeFilters parameter.
- *
- * @param project name of the project - mandatory
- * @param command to be executed - mandatory
- * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder}
- * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional
- * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional
- * @param asUser specify a user name to run the job as, must have 'runAs' permission
- * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace)
- * @see #triggerAdhocCommand(String, String)
- * @see #runAdhocCommand(String, String, Properties)
- * @deprecated use {@link #triggerAdhocCommand(RunAdhocCommand)}, will be removed in version 10 of this library
- */
- public RundeckExecution triggerAdhocCommand(String project, String command, Properties nodeFilters,
- Integer nodeThreadcount, Boolean nodeKeepgoing, String asUser) throws RundeckApiException, RundeckApiLoginException,
- RundeckApiTokenException, IllegalArgumentException {
- return triggerAdhocCommand(RunAdhocCommandBuilder.builder()
- .setProject(project)
- .setCommand(command)
- .setNodeFilters(nodeFilters)
- .setNodeThreadcount(nodeThreadcount)
- .setNodeKeepgoing(nodeKeepgoing)
- .setAsUser(asUser)
- .build());
- }
/**
* Trigger the execution of an ad-hoc command, and return immediately (without waiting the end of the execution).
* The command will be dispatched to nodes, accordingly to the nodeFilters parameter.
@@ -1402,139 +1192,11 @@ public class RundeckClient implements Serializable {
if(null!= command.getAsUser()) {
apiPath.param("asUser", command.getAsUser());
}
- RundeckExecution execution = new ApiCall(this).get(apiPath, new ExecutionParser("result/execution"));
+ RundeckExecution execution = new ApiCall(this).get(apiPath, new ExecutionParser(rootXpath()+"/execution"));
// the first call just returns the ID of the execution, so we need another call to get a "real" execution
return getExecution(execution.getId());
}
- /**
- * Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
- * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still
- * running. The command will not be dispatched to nodes, but be executed on the RunDeck server.
- *
- * @param project name of the project - mandatory
- * @param command to be executed - mandatory
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace)
- * @see #runAdhocCommand(String, String, Properties, Integer, Boolean, long, TimeUnit)
- * @see #triggerAdhocCommand(String, String)
- * @deprecated use {@link #runAdhocCommand(RunAdhocCommand)}, this method will
- * be removed in version 10 of this library
- */
- public RundeckExecution runAdhocCommand(String project, String command) throws RundeckApiException,
- RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
- return runAdhocCommand(project, command, null);
- }
-
- /**
- * Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
- * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
- * finished (or aborted) or is still running. The command will not be dispatched to nodes, but be executed on the
- * RunDeck server.
- *
- * @param project name of the project - mandatory
- * @param command to be executed - mandatory
- * @param poolingInterval for checking the status of the execution. Must be > 0.
- * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds.
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace)
- * @see #runAdhocCommand(String, String, Properties, Integer, Boolean, long, TimeUnit)
- * @see #triggerAdhocCommand(String, String)
- * @deprecated use {@link #runAdhocCommand(RunAdhocCommand, long, java.util.concurrent.TimeUnit)}, this method will
- * be removed in version 10 of this library
- */
- public RundeckExecution runAdhocCommand(String project, String command, long poolingInterval, TimeUnit poolingUnit)
- throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
- return runAdhocCommand(project, command, null, poolingInterval, poolingUnit);
- }
-
- /**
- * Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
- * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still
- * running. The command will be dispatched to nodes, accordingly to the nodeFilters parameter.
- *
- * @param project name of the project - mandatory
- * @param command to be executed - mandatory
- * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder}
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace)
- * @see #runAdhocCommand(String, String, Properties, Integer, Boolean, long, TimeUnit)
- * @see #triggerAdhocCommand(String, String, Properties)
- * @deprecated use {@link #runAdhocCommand(RunAdhocCommand)}, this method will
- * be removed in version 10 of this library
- */
- public RundeckExecution runAdhocCommand(String project, String command, Properties nodeFilters)
- throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
- return runAdhocCommand(project, command, nodeFilters, null, null);
- }
-
- /**
- * Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
- * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
- * finished (or aborted) or is still running. The command will be dispatched to nodes, accordingly to the
- * nodeFilters parameter.
- *
- * @param project name of the project - mandatory
- * @param command to be executed - mandatory
- * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder}
- * @param poolingInterval for checking the status of the execution. Must be > 0.
- * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds.
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace)
- * @see #runAdhocCommand(String, String, Properties, Integer, Boolean, long, TimeUnit)
- * @see #triggerAdhocCommand(String, String, Properties)
- * @deprecated use {@link #runAdhocCommand(RunAdhocCommand, long, java.util.concurrent.TimeUnit)}, this method will
- * be removed in version 10 of this library
- */
- public RundeckExecution runAdhocCommand(String project, String command, Properties nodeFilters,
- long poolingInterval, TimeUnit poolingUnit) throws RundeckApiException, RundeckApiLoginException,
- RundeckApiTokenException, IllegalArgumentException {
- return runAdhocCommand(project, command, nodeFilters, null, null, poolingInterval, poolingUnit);
- }
-
- /**
- * Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
- * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still
- * running. The command will be dispatched to nodes, accordingly to the nodeFilters parameter.
- *
- * @param project name of the project - mandatory
- * @param command to be executed - mandatory
- * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder}
- * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional
- * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace)
- * @see #runAdhocCommand(String, String, Properties, Integer, Boolean, long, TimeUnit)
- * @see #triggerAdhocCommand(String, String, Properties, Integer, Boolean)
- * @deprecated use {@link #runAdhocCommand(RunAdhocCommand)}, this method will
- * be removed in version 10 of this library
- */
- public RundeckExecution runAdhocCommand(String project, String command, Properties nodeFilters,
- Integer nodeThreadcount, Boolean nodeKeepgoing) throws RundeckApiException, RundeckApiLoginException,
- RundeckApiTokenException, IllegalArgumentException {
- return runAdhocCommand(project,
- command,
- nodeFilters,
- nodeThreadcount,
- nodeKeepgoing,
- DEFAULT_POOLING_INTERVAL,
- DEFAULT_POOLING_UNIT);
- }
/**
* Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
@@ -1557,70 +1219,6 @@ public class RundeckClient implements Serializable {
DEFAULT_POOLING_UNIT);
}
- /**
- * Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
- * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
- * finished (or aborted) or is still running. The command will be dispatched to nodes, accordingly to the
- * nodeFilters parameter.
- *
- * @param project name of the project - mandatory
- * @param command to be executed - mandatory
- * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder}
- * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional
- * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional
- * @param poolingInterval for checking the status of the execution. Must be > 0.
- * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds.
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace)
- * @see #triggerAdhocCommand(String, String, Properties, Integer, Boolean)
- * @deprecated use {@link #runAdhocCommand(RunAdhocCommand, long, java.util.concurrent.TimeUnit)}, this method will
- * be removed in version 10 of this library
- */
- public RundeckExecution runAdhocCommand(String project, String command, Properties nodeFilters,
- Integer nodeThreadcount, Boolean nodeKeepgoing, long poolingInterval, TimeUnit poolingUnit)
- throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
- return runAdhocCommand(project, command, nodeFilters, nodeThreadcount, nodeKeepgoing, null, poolingInterval, poolingUnit);
- }
-
- /**
- * Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
- * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
- * finished (or aborted) or is still running. The command will be dispatched to nodes, accordingly to the
- * nodeFilters parameter.
- *
- * @param project name of the project - mandatory
- * @param command to be executed - mandatory
- * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder}
- * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional
- * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional
- * @param poolingInterval for checking the status of the execution. Must be > 0.
- * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds.
- *
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- *
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or command is blank (null, empty or whitespace)
- * @see #triggerAdhocCommand(String, String, Properties, Integer, Boolean)
- * @deprecated use {@link #runAdhocCommand(RunAdhocCommand, long, java.util.concurrent.TimeUnit)}, this method will
- * be removed in version 10 of this library
- */
- public RundeckExecution runAdhocCommand(String project, String command, Properties nodeFilters,
- Integer nodeThreadcount, Boolean nodeKeepgoing, String asUser, long poolingInterval, TimeUnit poolingUnit)
- throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
- return runAdhocCommand(RunAdhocCommandBuilder.builder()
- .setProject(project)
- .setCommand(command)
- .setNodeFilters(nodeFilters)
- .setNodeThreadcount(nodeThreadcount)
- .setNodeKeepgoing(nodeKeepgoing)
- .setAsUser(asUser)
- .build(), poolingInterval, poolingUnit);
- }
/**
* Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
* server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
@@ -1663,323 +1261,6 @@ public class RundeckClient implements Serializable {
* Ad-hoc scripts
*/
- /**
- * Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The
- * script will not be dispatched to nodes, but be executed on the RunDeck server.
- *
- * @param project name of the project - mandatory
- * @param scriptFilename filename of the script to be executed - mandatory
- * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace)
- * @throws IOException if we failed to read the file
- * @see #triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean)
- * @see #runAdhocScript(String, String)
- * @deprecated use {@link #triggerAdhocScript(RunAdhocScript)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution triggerAdhocScript(String project, String scriptFilename) throws RundeckApiException,
- RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException, IOException {
- return triggerAdhocScript(project, scriptFilename, null);
- }
-
- /**
- * Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The
- * script will not be dispatched to nodes, but be executed on the RunDeck server.
- *
- * @param project name of the project - mandatory
- * @param scriptFilename filename of the script to be executed - mandatory
- * @param options of the script - optional. See {@link OptionsBuilder}.
- * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace)
- * @throws IOException if we failed to read the file
- * @see #triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean)
- * @see #runAdhocScript(String, String, Properties)
- * @deprecated use {@link #triggerAdhocScript(RunAdhocScript)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution triggerAdhocScript(String project, String scriptFilename, Properties options)
- throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException,
- IOException {
- return triggerAdhocScript(project, scriptFilename, options, null);
- }
-
- /**
- * Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The
- * script will be dispatched to nodes, accordingly to the nodeFilters parameter.
- *
- * @param project name of the project - mandatory
- * @param scriptFilename filename of the script to be executed - mandatory
- * @param options of the script - optional. See {@link OptionsBuilder}.
- * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder}
- * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace)
- * @throws IOException if we failed to read the file
- * @see #triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean)
- * @see #runAdhocScript(String, String, Properties, Properties)
- * @deprecated use {@link #triggerAdhocScript(RunAdhocScript)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution triggerAdhocScript(String project, String scriptFilename, Properties options,
- Properties nodeFilters) throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException,
- IllegalArgumentException, IOException {
- return triggerAdhocScript(project, scriptFilename, options, nodeFilters, null, null);
- }
-
- /**
- * Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The
- * script will be dispatched to nodes, accordingly to the nodeFilters parameter.
- *
- * @param project name of the project - mandatory
- * @param scriptFilename filename of the script to be executed - mandatory
- * @param options of the script - optional. See {@link OptionsBuilder}.
- * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder}
- * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional
- * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional
- * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace)
- * @throws IOException if we failed to read the file
- * @see #triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean)
- * @see #runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit)
- * @deprecated use {@link #triggerAdhocScript(RunAdhocScript)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution triggerAdhocScript(String project, String scriptFilename, Properties options,
- Properties nodeFilters, Integer nodeThreadcount, Boolean nodeKeepgoing) throws RundeckApiException,
- RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException, IOException {
- return triggerAdhocScript(project, scriptFilename, options, nodeFilters, nodeThreadcount, nodeKeepgoing, null);
- }
- /**
- * Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The
- * script will be dispatched to nodes, accordingly to the nodeFilters parameter.
- *
- * @param project name of the project - mandatory
- * @param scriptFilename filename of the script to be executed - mandatory
- * @param options of the script - optional. See {@link OptionsBuilder}.
- * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder}
- * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional
- * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional
- * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace)
- * @throws IOException if we failed to read the file
- * @see #triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean)
- * @see #runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit)
- * @deprecated use {@link #triggerAdhocScript(RunAdhocScript)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution triggerAdhocScript(String project, String scriptFilename, Properties options,
- Properties nodeFilters, Integer nodeThreadcount, Boolean nodeKeepgoing,String asUser) throws RundeckApiException,
- RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException, IOException {
- return triggerAdhocScript(project, scriptFilename, ParametersUtil.generateArgString(options), nodeFilters,
- nodeThreadcount, nodeKeepgoing, asUser);
- }
- /**
- * Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The
- * script will be dispatched to nodes, accordingly to the nodeFilters parameter.
- *
- * @param project name of the project - mandatory
- * @param scriptFilename filename of the script to be executed - mandatory
- * @param argString arguments of the script - optional.
- * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder}
- * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional
- * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional
- * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace)
- * @throws IOException if we failed to read the file
- * @see #triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean)
- * @see #runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit)
- * @deprecated use {@link #triggerAdhocScript(RunAdhocScript)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution triggerAdhocScript(String project, String scriptFilename, String argString,
- Properties nodeFilters, Integer nodeThreadcount, Boolean nodeKeepgoing,String asUser) throws RundeckApiException,
- RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException, IOException {
- AssertUtil.notBlank(scriptFilename, "scriptFilename is mandatory to trigger an ad-hoc script !");
- FileInputStream stream = null;
- try {
- stream = FileUtils.openInputStream(new File(scriptFilename));
- return triggerAdhocScript(RunAdhocScriptBuilder.builder()
- .setProject(project)
- .setScript(stream)
- .setNodeFilters(nodeFilters)
- .setArgString(argString)
- .setNodeThreadcount(nodeThreadcount)
- .setNodeKeepgoing(nodeKeepgoing)
- .setAsUser(asUser)
- .build());
- } finally {
- IOUtils.closeQuietly(stream);
- }
- }
-
- /**
- * Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The
- * script will not be dispatched to nodes, but be executed on the RunDeck server.
- *
- * @param project name of the project - mandatory
- * @param script inputStream for reading the script to be executed - mandatory
- * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null
- * @see #triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean)
- * @see #runAdhocScript(String, InputStream)
- * @deprecated use {@link #triggerAdhocScript(RunAdhocScript)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution triggerAdhocScript(String project, InputStream script) throws RundeckApiException,
- RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
- return triggerAdhocScript(project, script, null);
- }
-
- /**
- * Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The
- * script will not be dispatched to nodes, but be executed on the RunDeck server.
- *
- * @param project name of the project - mandatory
- * @param script inputStream for reading the script to be executed - mandatory
- * @param options of the script - optional. See {@link OptionsBuilder}.
- * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null
- * @see #triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean)
- * @see #runAdhocScript(String, InputStream, Properties)
- * @deprecated use {@link #triggerAdhocScript(RunAdhocScript)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution triggerAdhocScript(String project, InputStream script, Properties options)
- throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
- return triggerAdhocScript(project, script, options, null);
- }
-
- /**
- * Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The
- * script will be dispatched to nodes, accordingly to the nodeFilters parameter.
- *
- * @param project name of the project - mandatory
- * @param script inputStream for reading the script to be executed - mandatory
- * @param options of the script - optional. See {@link OptionsBuilder}.
- * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder}
- * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null
- * @see #triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean)
- * @see #runAdhocScript(String, InputStream, Properties, Properties)
- * @deprecated use {@link #triggerAdhocScript(RunAdhocScript)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution triggerAdhocScript(String project, InputStream script, Properties options,
- Properties nodeFilters) throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException,
- IllegalArgumentException {
- return triggerAdhocScript(project, script, options, nodeFilters, null, null);
- }
-
- /**
- * Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The
- * script will be dispatched to nodes, accordingly to the nodeFilters parameter.
- *
- * @param project name of the project - mandatory
- * @param script inputStream for reading the script to be executed - mandatory
- * @param options of the script - optional. See {@link OptionsBuilder}.
- * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder}
- * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional
- * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional
- * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null
- * @see #triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean)
- * @see #runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit)
- * @deprecated use {@link #triggerAdhocScript(RunAdhocScript)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution triggerAdhocScript(String project, InputStream script, Properties options,
- Properties nodeFilters, Integer nodeThreadcount, Boolean nodeKeepgoing) throws RundeckApiException,
- RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
- return triggerAdhocScript(project, script, options, nodeFilters, nodeThreadcount, nodeKeepgoing, null);
- }
- /**
- * Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The
- * script will be dispatched to nodes, accordingly to the nodeFilters parameter.
- *
- * @param project name of the project - mandatory
- * @param script inputStream for reading the script to be executed - mandatory
- * @param options of the script - optional. See {@link OptionsBuilder}.
- * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder}
- * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional
- * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional
- * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null
- * @see #triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean)
- * @see #runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit)
- * @deprecated use {@link #triggerAdhocScript(RunAdhocScript)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution triggerAdhocScript(String project, InputStream script, Properties options,
- Properties nodeFilters, Integer nodeThreadcount, Boolean nodeKeepgoing, String asUser) throws RundeckApiException,
- RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
- return triggerAdhocScript(project, script, ParametersUtil.generateArgString(options), nodeFilters,
- nodeThreadcount, nodeKeepgoing, asUser);
- }
- /**
- * Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The
- * script will be dispatched to nodes, accordingly to the nodeFilters parameter.
- *
- * @param project name of the project - mandatory
- * @param script inputStream for reading the script to be executed - mandatory
- * @param argString arguments of the script - optional.
- * @param nodeFilters for selecting nodes on which the command will be executed. See {@link NodeFiltersBuilder}
- * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional
- * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional
- * @return a {@link RundeckExecution} instance for the newly created (and running) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null
- * @see #triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean)
- * @see #runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit)
- * @deprecated use {@link #triggerAdhocScript(RunAdhocScript)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution triggerAdhocScript(String project, InputStream script, String argString,
- Properties nodeFilters, Integer nodeThreadcount, Boolean nodeKeepgoing, String asUser) throws RundeckApiException,
- RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
- return triggerAdhocScript(RunAdhocScriptBuilder.builder()
- .setProject(project)
- .setScript(script)
- .setNodeFilters(nodeFilters)
- .setArgString(argString)
- .setNodeThreadcount(nodeThreadcount)
- .setNodeKeepgoing(nodeKeepgoing)
- .setAsUser(asUser)
- .build());
- }
/**
* Trigger the execution of an ad-hoc script read from a file, and return immediately (without waiting the end of
@@ -2045,445 +1326,11 @@ public class RundeckClient implements Serializable {
if(null!=script.getAsUser()) {
apiPath.param("asUser", script.getAsUser());
}
- RundeckExecution execution = new ApiCall(this).post(apiPath, new ExecutionParser("result/execution"));
+ RundeckExecution execution = new ApiCall(this).post(apiPath, new ExecutionParser(rootXpath()+"/execution"));
// the first call just returns the ID of the execution, so we need another call to get a "real" execution
return getExecution(execution.getId());
}
- /**
- * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
- * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still
- * running. The script will not be dispatched to nodes, but be executed on the RunDeck server.
- *
- * @param project name of the project - mandatory
- * @param scriptFilename filename of the script to be executed - mandatory
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace)
- * @throws IOException if we failed to read the file
- * @see #runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit)
- * @see #triggerAdhocScript(String, String)
- * @deprecated use {@link #runAdhocScript(RunAdhocScript)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution runAdhocScript(String project, String scriptFilename) throws RundeckApiException,
- RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException, IOException {
- return runAdhocScript(project, scriptFilename, null);
- }
-
- /**
- * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
- * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
- * finished (or aborted) or is still running. The script will not be dispatched to nodes, but be executed on the
- * RunDeck server.
- *
- * @param project name of the project - mandatory
- * @param scriptFilename filename of the script to be executed - mandatory
- * @param poolingInterval for checking the status of the execution. Must be > 0.
- * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds.
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace)
- * @throws IOException if we failed to read the file
- * @see #runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit)
- * @see #triggerAdhocScript(String, String)
- * @deprecated use {@link #runAdhocScript(RunAdhocScript, long, java.util.concurrent.TimeUnit)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution runAdhocScript(String project, String scriptFilename, long poolingInterval,
- TimeUnit poolingUnit) throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException,
- IllegalArgumentException, IOException {
- return runAdhocScript(project, scriptFilename, null, poolingInterval, poolingUnit);
- }
-
- /**
- * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
- * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still
- * running. The script will not be dispatched to nodes, but be executed on the RunDeck server.
- *
- * @param project name of the project - mandatory
- * @param scriptFilename filename of the script to be executed - mandatory
- * @param options of the script - optional. See {@link OptionsBuilder}.
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace)
- * @throws IOException if we failed to read the file
- * @see #runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit)
- * @see #triggerAdhocScript(String, String, Properties)
- * @deprecated use {@link #runAdhocScript(RunAdhocScript)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution runAdhocScript(String project, String scriptFilename, Properties options)
- throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException,
- IOException {
- return runAdhocScript(project, scriptFilename, options, null);
- }
-
- /**
- * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
- * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
- * finished (or aborted) or is still running. The script will not be dispatched to nodes, but be executed on the
- * RunDeck server.
- *
- * @param project name of the project - mandatory
- * @param scriptFilename filename of the script to be executed - mandatory
- * @param options of the script - optional. See {@link OptionsBuilder}.
- * @param poolingInterval for checking the status of the execution. Must be > 0.
- * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds.
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace)
- * @throws IOException if we failed to read the file
- * @see #runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit)
- * @see #triggerAdhocScript(String, String, Properties)
- * @deprecated use {@link #runAdhocScript(RunAdhocScript, long, java.util.concurrent.TimeUnit)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution runAdhocScript(String project, String scriptFilename, Properties options,
- long poolingInterval, TimeUnit poolingUnit) throws RundeckApiException, RundeckApiLoginException,
- RundeckApiTokenException, IllegalArgumentException, IOException {
- return runAdhocScript(project, scriptFilename, options, null, poolingInterval, poolingUnit);
- }
-
- /**
- * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
- * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still
- * running. The script will be dispatched to nodes, accordingly to the nodeFilters parameter.
- *
- * @param project name of the project - mandatory
- * @param scriptFilename filename of the script to be executed - mandatory
- * @param options of the script - optional. See {@link OptionsBuilder}.
- * @param nodeFilters for selecting nodes on which the script will be executed. See {@link NodeFiltersBuilder}
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace)
- * @throws IOException if we failed to read the file
- * @see #runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit)
- * @see #triggerAdhocScript(String, String, Properties, Properties)
- * @deprecated use {@link #runAdhocScript(RunAdhocScript)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution runAdhocScript(String project, String scriptFilename, Properties options,
- Properties nodeFilters) throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException,
- IllegalArgumentException, IOException {
- return runAdhocScript(project, scriptFilename, options, nodeFilters, null, null);
- }
-
- /**
- * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
- * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
- * finished (or aborted) or is still running. The script will be dispatched to nodes, accordingly to the nodeFilters
- * parameter.
- *
- * @param project name of the project - mandatory
- * @param scriptFilename filename of the script to be executed - mandatory
- * @param options of the script - optional. See {@link OptionsBuilder}.
- * @param nodeFilters for selecting nodes on which the script will be executed. See {@link NodeFiltersBuilder}
- * @param poolingInterval for checking the status of the execution. Must be > 0.
- * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds.
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace)
- * @throws IOException if we failed to read the file
- * @see #runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit)
- * @see #triggerAdhocScript(String, String, Properties, Properties)
- * @deprecated use {@link #runAdhocScript(RunAdhocScript, long, java.util.concurrent.TimeUnit)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution runAdhocScript(String project, String scriptFilename, Properties options,
- Properties nodeFilters, long poolingInterval, TimeUnit poolingUnit) throws RundeckApiException,
- RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException, IOException {
- return runAdhocScript(project, scriptFilename, options, nodeFilters, null, null, poolingInterval, poolingUnit);
- }
-
- /**
- * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
- * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still
- * running. The script will be dispatched to nodes, accordingly to the nodeFilters parameter.
- *
- * @param project name of the project - mandatory
- * @param scriptFilename filename of the script to be executed - mandatory
- * @param options of the script - optional. See {@link OptionsBuilder}.
- * @param nodeFilters for selecting nodes on which the script will be executed. See {@link NodeFiltersBuilder}
- * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional
- * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace)
- * @throws IOException if we failed to read the file
- * @see #runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit)
- * @see #triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean)
- * @deprecated use {@link #runAdhocScript(RunAdhocScript)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution runAdhocScript(String project, String scriptFilename, Properties options,
- Properties nodeFilters, Integer nodeThreadcount, Boolean nodeKeepgoing) throws RundeckApiException,
- RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException, IOException {
- return runAdhocScript(project,
- scriptFilename,
- options,
- nodeFilters,
- nodeThreadcount,
- nodeKeepgoing,
- DEFAULT_POOLING_INTERVAL,
- DEFAULT_POOLING_UNIT);
- }
-
- /**
- * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
- * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
- * finished (or aborted) or is still running. The script will be dispatched to nodes, accordingly to the nodeFilters
- * parameter.
- *
- * @param project name of the project - mandatory
- * @param scriptFilename filename of the script to be executed - mandatory
- * @param options of the script - optional. See {@link OptionsBuilder}.
- * @param nodeFilters for selecting nodes on which the script will be executed. See {@link NodeFiltersBuilder}
- * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional
- * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional
- * @param poolingInterval for checking the status of the execution. Must be > 0.
- * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds.
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project or scriptFilename is blank (null, empty or whitespace)
- * @throws IOException if we failed to read the file
- * @see #runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit)
- * @see #triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean)
- *
- * @deprecated use {@link #runAdhocScript(RunAdhocScript, long, java.util.concurrent.TimeUnit)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution runAdhocScript(String project, String scriptFilename, Properties options,
- Properties nodeFilters, Integer nodeThreadcount, Boolean nodeKeepgoing, long poolingInterval,
- TimeUnit poolingUnit) throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException,
- IllegalArgumentException, IOException {
- AssertUtil.notBlank(scriptFilename, "scriptFilename is mandatory to run an ad-hoc script !");
- FileInputStream stream = null;
- try {
- stream = FileUtils.openInputStream(new File(scriptFilename));
- return runAdhocScript(RunAdhocScriptBuilder.builder()
- .setProject(project)
- .setScript(stream)
- .setNodeFilters(nodeFilters)
- .setArgString(ParametersUtil.generateArgString(options))
- .setNodeThreadcount(nodeThreadcount)
- .setNodeKeepgoing(nodeKeepgoing)
- .build(),
- poolingInterval,
- poolingUnit);
- } finally {
- IOUtils.closeQuietly(stream);
- }
- }
-
- /**
- * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
- * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still
- * running. The script will not be dispatched to nodes, but be executed on the RunDeck server.
- *
- * @param project name of the project - mandatory
- * @param script inputStream for reading the script to be executed - mandatory
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null
- * @throws IOException if we failed to read the file
- * @see #runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit)
- * @see #triggerAdhocScript(String, InputStream)
- * @deprecated use {@link #runAdhocScript(RunAdhocScript)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution runAdhocScript(String project, InputStream script) throws RundeckApiException,
- RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException, IOException {
- return runAdhocScript(project, script, null);
- }
-
- /**
- * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
- * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
- * finished (or aborted) or is still running. The script will not be dispatched to nodes, but be executed on the
- * RunDeck server.
- *
- * @param project name of the project - mandatory
- * @param script inputStream for reading the script to be executed - mandatory
- * @param poolingInterval for checking the status of the execution. Must be > 0.
- * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds.
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null
- * @throws IOException if we failed to read the file
- * @see #runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit)
- * @see #triggerAdhocScript(String, InputStream)
- * @deprecated use {@link #runAdhocScript(RunAdhocScript, long, java.util.concurrent.TimeUnit)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution runAdhocScript(String project, InputStream script, long poolingInterval,
- TimeUnit poolingUnit) throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException,
- IllegalArgumentException, IOException {
- return runAdhocScript(project, script, null, poolingInterval, poolingUnit);
- }
-
- /**
- * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
- * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still
- * running. The script will not be dispatched to nodes, but be executed on the RunDeck server.
- *
- * @param project name of the project - mandatory
- * @param script inputStream for reading the script to be executed - mandatory
- * @param options of the script - optional. See {@link OptionsBuilder}.
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null
- * @throws IOException if we failed to read the file
- * @see #runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit)
- * @see #triggerAdhocScript(String, InputStream, Properties)
- * @deprecated use {@link #runAdhocScript(RunAdhocScript)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution runAdhocScript(String project, InputStream script, Properties options)
- throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException,
- IOException {
- return runAdhocScript(project, script, options, null);
- }
-
- /**
- * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
- * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
- * finished (or aborted) or is still running. The script will not be dispatched to nodes, but be executed on the
- * RunDeck server.
- *
- * @param project name of the project - mandatory
- * @param script inputStream for reading the script to be executed - mandatory
- * @param options of the script - optional. See {@link OptionsBuilder}.
- * @param poolingInterval for checking the status of the execution. Must be > 0.
- * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds.
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null
- * @throws IOException if we failed to read the file
- * @see #runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit)
- * @see #triggerAdhocScript(String, InputStream, Properties)
- * @deprecated use {@link #runAdhocScript(RunAdhocScript, long, java.util.concurrent.TimeUnit)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution runAdhocScript(String project, InputStream script, Properties options,
- long poolingInterval, TimeUnit poolingUnit) throws RundeckApiException, RundeckApiLoginException,
- RundeckApiTokenException, IllegalArgumentException, IOException {
- return runAdhocScript(project, script, options, null, poolingInterval, poolingUnit);
- }
-
- /**
- * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
- * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still
- * running. The script will be dispatched to nodes, accordingly to the nodeFilters parameter.
- *
- * @param project name of the project - mandatory
- * @param script inputStream for reading the script to be executed - mandatory
- * @param options of the script - optional. See {@link OptionsBuilder}.
- * @param nodeFilters for selecting nodes on which the script will be executed. See {@link NodeFiltersBuilder}
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null
- * @throws IOException if we failed to read the file
- * @see #runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit)
- * @see #triggerAdhocScript(String, InputStream, Properties, Properties)
- * @deprecated use {@link #runAdhocScript(RunAdhocScript)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution runAdhocScript(String project, InputStream script, Properties options,
- Properties nodeFilters) throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException,
- IllegalArgumentException, IOException {
- return runAdhocScript(project, script, options, nodeFilters, null, null);
- }
-
- /**
- * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
- * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
- * finished (or aborted) or is still running. The script will be dispatched to nodes, accordingly to the nodeFilters
- * parameter.
- *
- * @param project name of the project - mandatory
- * @param script inputStream for reading the script to be executed - mandatory
- * @param options of the script - optional. See {@link OptionsBuilder}.
- * @param nodeFilters for selecting nodes on which the script will be executed. See {@link NodeFiltersBuilder}
- * @param poolingInterval for checking the status of the execution. Must be > 0.
- * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds.
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null
- * @throws IOException if we failed to read the file
- * @see #runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit)
- * @see #triggerAdhocScript(String, InputStream, Properties, Properties)
- * @deprecated use {@link #runAdhocScript(RunAdhocScript, long, java.util.concurrent.TimeUnit)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution runAdhocScript(String project, InputStream script, Properties options,
- Properties nodeFilters, long poolingInterval, TimeUnit poolingUnit) throws RundeckApiException,
- RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException, IOException {
- return runAdhocScript(project, script, options, nodeFilters, null, null, poolingInterval, poolingUnit);
- }
-
- /**
- * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
- * server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still
- * running. The script will be dispatched to nodes, accordingly to the nodeFilters parameter.
- *
- * @param project name of the project - mandatory
- * @param script inputStream for reading the script to be executed - mandatory
- * @param options of the script - optional. See {@link OptionsBuilder}.
- * @param nodeFilters for selecting nodes on which the script will be executed. See {@link NodeFiltersBuilder}
- * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional
- * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null
- * @throws IOException if we failed to read the file
- * @see #runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit)
- * @see #triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean)
- * @deprecated use {@link #runAdhocScript(RunAdhocScript)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution runAdhocScript(String project, InputStream script, Properties options,
- Properties nodeFilters, Integer nodeThreadcount, Boolean nodeKeepgoing) throws RundeckApiException,
- RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException, IOException {
- return runAdhocScript(project,
- script,
- options,
- nodeFilters,
- nodeThreadcount,
- nodeKeepgoing,
- DEFAULT_POOLING_INTERVAL,
- DEFAULT_POOLING_UNIT);
- }
/**
* Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
@@ -2507,80 +1354,6 @@ public class RundeckClient implements Serializable {
DEFAULT_POOLING_UNIT);
}
- /**
- * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
- * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
- * finished (or aborted) or is still running. The script will be dispatched to nodes, accordingly to the nodeFilters
- * parameter.
- *
- * @param project name of the project - mandatory
- * @param script inputStream for reading the script to be executed - mandatory
- * @param options of the script - optional. See {@link OptionsBuilder}.
- * @param nodeFilters for selecting nodes on which the script will be executed. See {@link NodeFiltersBuilder}
- * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional
- * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional
- * @param poolingInterval for checking the status of the execution. Must be > 0.
- * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds.
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null
- * @throws IOException if we failed to read the file
- * @see #runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit)
- * @see #triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean)
- * @deprecated use {@link #runAdhocScript(RunAdhocScript, long, java.util.concurrent.TimeUnit)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution runAdhocScript(String project, InputStream script, Properties options,
- Properties nodeFilters, Integer nodeThreadcount, Boolean nodeKeepgoing, long poolingInterval,
- TimeUnit poolingUnit) throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException,
- IllegalArgumentException {
- return runAdhocScript(project, script, options, nodeFilters, nodeThreadcount, nodeKeepgoing, null, poolingInterval, poolingUnit);
- }
-
- /**
- * Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
- * server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
- * finished (or aborted) or is still running. The script will be dispatched to nodes, accordingly to the nodeFilters
- * parameter.
- *
- * @param project name of the project - mandatory
- * @param script inputStream for reading the script to be executed - mandatory
- * @param options of the script - optional. See {@link OptionsBuilder}.
- * @param nodeFilters for selecting nodes on which the script will be executed. See {@link NodeFiltersBuilder}
- * @param nodeThreadcount thread count to use (for parallelizing when running on multiple nodes) - optional
- * @param nodeKeepgoing if true, continue executing on other nodes even if some fail - optional
- * @param poolingInterval for checking the status of the execution. Must be > 0.
- * @param poolingUnit unit (seconds, milli-seconds, ...) of the interval. Default to seconds.
- *
- * @return a {@link RundeckExecution} instance for the (finished/aborted) execution - won't be null
- *
- * @throws RundeckApiException in case of error when calling the API (non-existent project with this name)
- * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
- * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
- * @throws IllegalArgumentException if the project is blank (null, empty or whitespace) or the script is null
- * @throws IOException if we failed to read the file
- * @see #runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit)
- * @see #triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean)
- * @deprecated use {@link #runAdhocScript(RunAdhocScript, long, java.util.concurrent.TimeUnit)}, this method will be
- * removed in version 10 of this library
- */
- public RundeckExecution runAdhocScript(String project, InputStream script, Properties options,
- Properties nodeFilters, Integer nodeThreadcount, Boolean nodeKeepgoing, String asUser, long poolingInterval,
- TimeUnit poolingUnit) throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException,
- IllegalArgumentException {
- return runAdhocScript(RunAdhocScriptBuilder.builder()
- .setProject(project)
- .setScript(script)
- .setNodeFilters(nodeFilters)
- .setArgString(ParametersUtil.generateArgString(options))
- .setNodeThreadcount(nodeThreadcount)
- .setNodeKeepgoing(nodeKeepgoing)
- .setAsUser(asUser)
- .build(), poolingInterval, poolingUnit);
- }
-
/**
* Run an ad-hoc script read from a file, and wait until its execution is finished (or aborted) to return. We will
* poll the RunDeck server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the
@@ -2700,7 +1473,7 @@ public class RundeckClient implements Serializable {
AssertUtil.notBlank(project, "project is mandatory get all running executions !");
return new ApiCall(this).get(new ApiPathBuilder("/executions/running").param("project", project),
new ListParser(new ExecutionParser(),
- "result/executions/execution"));
+ rootXpath()+"/executions/execution"));
}
/**
@@ -2798,7 +1571,7 @@ public class RundeckClient implements Serializable {
.param("max", max)
.param("offset", offset),
new ListParser(new ExecutionParser(),
- "result/executions/execution"));
+ rootXpath()+"/executions/execution"));
}
/**
@@ -2823,9 +1596,15 @@ public class RundeckClient implements Serializable {
.param(new ExecutionQueryParameters(query))
.param("max", max)
.param("offset", offset),
- new PagedResultParser(
- new ListParser(new ExecutionParser(), "execution"),
- "result/executions"
+ APIV11Helper.unwrapIfNeeded(
+ new PagedResultParser(
+ new ListParser(
+ new ExecutionParser(),
+ "execution"
+ ),
+ rootXpath() + "/executions"
+ ),
+ rootXpath() + "/executions"
)
);
}
@@ -2843,8 +1622,15 @@ public class RundeckClient implements Serializable {
public RundeckExecution getExecution(Long executionId) throws RundeckApiException, RundeckApiLoginException,
RundeckApiTokenException, IllegalArgumentException {
AssertUtil.notNull(executionId, "executionId is mandatory to get the details of an execution !");
- return new ApiCall(this).get(new ApiPathBuilder("/execution/", executionId.toString()),
- new ExecutionParser("result/executions/execution"));
+ return new ApiCall(this).get(
+ new ApiPathBuilder("/execution/", executionId.toString()),
+ APIV11Helper.unwrapIfNeeded(
+ new ExecutionParser(
+ rootXpath() + "/executions/execution"
+ ),
+ rootXpath() + "/executions/execution"
+ )
+ );
}
/**
@@ -2879,7 +1665,76 @@ public class RundeckClient implements Serializable {
if(null!=asUser) {
apiPath.param("asUser", asUser);
}
- return new ApiCall(this).get(apiPath, new AbortParser("result/abort"));
+ return new ApiCall(this).get(apiPath, new AbortParser(rootXpath() + "/abort"));
+ }
+
+ /**
+ * Delete all executions for a job specified by a job ID
+ *
+ * @param jobId Identifier for the job
+ *
+ * @return a {@link DeleteExecutionsResponse} instance - won't be null
+ *
+ * @throws RundeckApiException in case of error when calling the API (non-existent
+ * execution with this ID)
+ * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
+ * @throws RundeckApiTokenException if the token is invalid (in case of token-based
+ * authentication)
+ * @throws IllegalArgumentException if the executionIds is null
+ */
+ public DeleteExecutionsResponse deleteAllJobExecutions(final String jobId)
+ throws RundeckApiException, RundeckApiLoginException,
+ RundeckApiTokenException, IllegalArgumentException
+ {
+ AssertUtil.notNull(jobId, "jobId is mandatory to delete executions!");
+ return new ApiCall(this).delete(
+ new ApiPathBuilder("/job/",jobId,"/executions"),
+ new DeleteExecutionsResponseParser(rootXpath() + "/deleteExecutions")
+ );
+ }
+
+ /**
+ * Delete a set of executions, identified by the given IDs
+ *
+ * @param executionIds set of identifiers for the executions - mandatory
+ * @return a {@link DeleteExecutionsResponse} instance - won't be null
+ * @throws RundeckApiException in case of error when calling the API (non-existent execution with this ID)
+ * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
+ * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
+ * @throws IllegalArgumentException if the executionIds is null
+ */
+ public DeleteExecutionsResponse deleteExecutions(final Set executionIds)
+ throws RundeckApiException, RundeckApiLoginException,
+ RundeckApiTokenException, IllegalArgumentException
+ {
+ AssertUtil.notNull(executionIds, "executionIds is mandatory to delete executions!");
+ if (executionIds.size() < 1) {
+ throw new IllegalArgumentException("executionIds cannot be empty");
+ }
+ final ApiPathBuilder apiPath = new ApiPathBuilder("/executions/delete").xml(
+ new DeleteExecutionsGenerator(executionIds)
+ );
+ return new ApiCall(this).post(
+ apiPath,
+ new DeleteExecutionsResponseParser( rootXpath() + "/deleteExecutions")
+ );
+ }
+
+ /**
+ * Delete a single execution, identified by the given ID
+ *
+ * @param executionId identifier for the execution - mandatory
+ * @throws RundeckApiException in case of error when calling the API (non-existent execution with this ID)
+ * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
+ * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
+ * @throws IllegalArgumentException if the executionId is null
+ */
+ public void deleteExecution(final Long executionId)
+ throws RundeckApiException, RundeckApiLoginException,
+ RundeckApiTokenException, IllegalArgumentException
+ {
+ AssertUtil.notNull(executionId, "executionId is mandatory to delete an execution!");
+ new ApiCall(this).delete(new ApiPathBuilder("/execution/", executionId.toString()));
}
/*
@@ -3071,7 +1926,7 @@ public class RundeckClient implements Serializable {
.param("end", end)
.param("max", max)
.param("offset", offset),
- new HistoryParser("result/events"));
+ new HistoryParser(rootXpath()+"/events"));
}
/**
@@ -3118,7 +1973,7 @@ public class RundeckClient implements Serializable {
.param("max", max)
.param("offset", offset);
- return new ApiCall(this).postOrGet(builder, new HistoryParser("result/events"));
+ return new ApiCall(this).postOrGet(builder, new HistoryParser(rootXpath()+"/events"));
}
/*
@@ -3258,15 +2113,191 @@ public class RundeckClient implements Serializable {
* @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
* @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
* @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace)
+ * @deprecated renamed for clarity use {@link #getExecutionOutput(Long, int, int, long, int)}, will be removed in
+ * version 12 of this library
*/
public RundeckOutput getJobExecutionOutput(Long executionId, int offset, int lastlines, long lastmod, int maxlines)
throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
+ return getExecutionOutput(executionId, offset, lastlines, lastmod, maxlines);
+ }
+ /**
+ * Get the execution output of the given job
+ *
+ * @param executionId identifier of the execution - mandatory
+ * @param offset byte offset to read from in the file. 0 indicates the beginning.
+ * @param lastlines nnumber of lines to retrieve from the end of the available output. If specified it will override the offset value and return only the specified number of lines at the end of the log.
+ * @param lastmod epoch datestamp in milliseconds, return results only if modification changed since the specified date OR if more data is available at the given offset
+ * @param maxlines maximum number of lines to retrieve forward from the specified offset.
+ * @return {@link RundeckOutput}
+ * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID)
+ * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
+ * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
+ * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace)
+ */
+ public RundeckOutput getExecutionOutput(Long executionId, int offset, int lastlines, long lastmod, int maxlines)
+ throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
AssertUtil.notNull(executionId, "executionId is mandatory to get the output of a job execution!");
- return new ApiCall(this).get(new ApiPathBuilder("/execution/", executionId.toString(), "/output.xml").param("offset", offset)
- .param("lastlines", lastlines)
- .param("lastmod", lastmod)
- .param("maxlines", maxlines),
- new OutputParser("result/output", createOutputEntryParser()));
+ ApiPathBuilder param = new ApiPathBuilder(
+ "/execution/", executionId.toString(),
+ "/output")
+ .param("offset", offset);
+ if (lastlines > 0) {
+ param.param("lastlines", lastlines);
+ }
+ if (lastmod >= 0) {
+ param.param("lastmod", lastmod);
+ }
+ if (maxlines > 0) {
+ param.param("maxlines", maxlines);
+ }
+ return new ApiCall(this).get(param,
+ new OutputParser(rootXpath()+"/output", createOutputEntryParser()));
+ }
+ /**
+ * Get the execution state of the given execution
+ *
+ * @param executionId identifier of the execution - mandatory
+ * @return {@link RundeckExecutionState} the execution state
+ * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID)
+ * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
+ * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
+ * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace)
+ */
+ public RundeckExecutionState getExecutionState(Long executionId)
+ throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
+ AssertUtil.notNull(executionId, "executionId is mandatory to get the state of an execution!");
+ ApiPathBuilder param = new ApiPathBuilder(
+ "/execution/", executionId.toString(),
+ "/state");
+
+ return new ApiCall(this).get(param, new ExecutionStateParser(rootXpath()+"/executionState"));
+ }
+
+ /**
+ * Get the execution output of the given execution on the specified node
+ *
+ * @param executionId identifier of the execution - mandatory
+ * @param nodeName name of the node
+ * @param offset byte offset to read from in the file. 0 indicates the beginning.
+ * @param lastlines nnumber of lines to retrieve from the end of the available output. If specified it will
+ * override the offset value and return only the specified number of lines at the end of the
+ * log.
+ * @param lastmod epoch datestamp in milliseconds, return results only if modification changed since the
+ * specified date OR if more data is available at the given offset
+ * @param maxlines maximum number of lines to retrieve forward from the specified offset.
+ *
+ * @return {@link RundeckOutput}
+ *
+ * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID)
+ * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
+ * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
+ * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace)
+ */
+ public RundeckOutput getExecutionOutputForNode(Long executionId, String nodeName, int offset, int lastlines,
+ long lastmod, int maxlines)
+ throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
+ AssertUtil.notNull(executionId, "executionId is mandatory to get the output of a job execution!");
+ AssertUtil.notNull(nodeName, "nodeName is mandatory to get the output of a job execution!");
+ ApiPathBuilder param = new ApiPathBuilder(
+ "/execution/", executionId.toString(),
+ "/output/node/", nodeName)
+ .param("offset", offset);
+ if(lastlines>0) {
+ param.param("lastlines", lastlines);
+ }
+ if(lastmod>=0) {
+ param.param("lastmod", lastmod);
+ }
+ if(maxlines>0) {
+ param.param("maxlines", maxlines);
+ }
+ return new ApiCall(this).get(param,
+ new OutputParser(rootXpath()+"/output", createOutputEntryParser()));
+ }
+ /**
+ * Get the execution output of the given execution for the specified step
+ *
+ * @param executionId identifier of the execution - mandatory
+ * @param stepCtx identifier for the step
+ * @param offset byte offset to read from in the file. 0 indicates the beginning.
+ * @param lastlines nnumber of lines to retrieve from the end of the available output. If specified it will
+ * override the offset value and return only the specified number of lines at the end of the
+ * log.
+ * @param lastmod epoch datestamp in milliseconds, return results only if modification changed since the
+ * specified date OR if more data is available at the given offset
+ * @param maxlines maximum number of lines to retrieve forward from the specified offset.
+ *
+ * @return {@link RundeckOutput}
+ *
+ * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID)
+ * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
+ * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
+ * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace)
+ */
+ public RundeckOutput getExecutionOutputForStep(Long executionId, String stepCtx, int offset, int lastlines,
+ long lastmod, int maxlines)
+ throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
+ AssertUtil.notNull(executionId, "executionId is mandatory to get the output of a job execution!");
+ AssertUtil.notNull(stepCtx, "stepCtx is mandatory to get the output of a job execution!");
+ ApiPathBuilder param = new ApiPathBuilder(
+ "/execution/", executionId.toString(),
+ "/output/step/", stepCtx)
+ .param("offset", offset);
+ if (lastlines > 0) {
+ param.param("lastlines", lastlines);
+ }
+ if (lastmod >= 0) {
+ param.param("lastmod", lastmod);
+ }
+ if (maxlines > 0) {
+ param.param("maxlines", maxlines);
+ }
+ return new ApiCall(this).get(param,
+ new OutputParser(rootXpath()+"/output", createOutputEntryParser()));
+ }
+ /**
+ * Get the execution output of the given execution for the specified step
+ *
+ * @param executionId identifier of the execution - mandatory
+ * @param stepCtx identifier for the step
+ * @param offset byte offset to read from in the file. 0 indicates the beginning.
+ * @param lastlines nnumber of lines to retrieve from the end of the available output. If specified it will
+ * override the offset value and return only the specified number of lines at the end of the
+ * log.
+ * @param lastmod epoch datestamp in milliseconds, return results only if modification changed since the
+ * specified date OR if more data is available at the given offset
+ * @param maxlines maximum number of lines to retrieve forward from the specified offset.
+ *
+ * @return {@link RundeckOutput}
+ *
+ * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID)
+ * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
+ * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
+ * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace)
+ */
+ public RundeckOutput getExecutionOutputForNodeAndStep(Long executionId, String nodeName, String stepCtx,
+ int offset, int lastlines,
+ long lastmod, int maxlines)
+ throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
+ AssertUtil.notNull(executionId, "executionId is mandatory to get the output of a job execution!");
+ AssertUtil.notNull(nodeName, "nodeName is mandatory to get the output of a job execution!");
+ AssertUtil.notNull(stepCtx, "stepCtx is mandatory to get the output of a job execution!");
+ ApiPathBuilder param = new ApiPathBuilder(
+ "/execution/", executionId.toString(),
+ "/output/node/", nodeName,
+ "/step/", stepCtx)
+ .param("offset", offset);
+ if (lastlines > 0) {
+ param.param("lastlines", lastlines);
+ }
+ if (lastmod >= 0) {
+ param.param("lastmod", lastmod);
+ }
+ if (maxlines > 0) {
+ param.param("maxlines", maxlines);
+ }
+ return new ApiCall(this).get(param,
+ new OutputParser(rootXpath()+"/output", createOutputEntryParser()));
}
@@ -3282,14 +2313,69 @@ public class RundeckClient implements Serializable {
* @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
* @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
* @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace)
+ * @deprecated renamed for clarity use {@link #getExecutionOutput(Long, int, long, int)}, will be removed in
+ * version 12 of this library
*/
public RundeckOutput getJobExecutionOutput(Long executionId, int offset, long lastmod, int maxlines)
throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
+ return getExecutionOutput(executionId, offset, lastmod, maxlines);
+ }
+ /**
+ * Get the execution output of the given job
+ *
+ * @param executionId identifier of the execution - mandatory
+ * @param offset byte offset to read from in the file. 0 indicates the beginning.
+ * @param lastmod epoch datestamp in milliseconds, return results only if modification changed since the specified date OR if more data is available at the given offset
+ * @param maxlines maximum number of lines to retrieve forward from the specified offset.
+ * @return {@link RundeckOutput}
+ * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID)
+ * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
+ * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
+ * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace)
+ */
+ public RundeckOutput getExecutionOutput(Long executionId, int offset, long lastmod, int maxlines)
+ throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
AssertUtil.notNull(executionId, "executionId is mandatory to get the output of a job execution!");
- return new ApiCall(this).get(new ApiPathBuilder("/execution/", executionId.toString(), "/output.xml").param("offset", offset)
- .param("lastmod", lastmod)
- .param("maxlines", maxlines),
- new OutputParser("result/output", createOutputEntryParser()));
+ ApiPathBuilder param = new ApiPathBuilder("/execution/", executionId.toString(), "/output")
+ .param("offset", offset);
+ if (lastmod >= 0) {
+ param.param("lastmod", lastmod);
+ }
+ if (maxlines > 0) {
+ param.param("maxlines", maxlines);
+ }
+ return new ApiCall(this).get(param, new OutputParser(rootXpath()+"/output", createOutputEntryParser()));
+ }
+ /**
+ * Get the execution state output sequence of the given job
+ *
+ * @param executionId identifier of the execution - mandatory
+ * @param stateOnly if true, include only state change output entries, otherwise include state and log entries
+ * @param offset byte offset to read from in the file. 0 indicates the beginning.
+ * @param lastmod epoch datestamp in milliseconds, return results only if modification changed since the specified date OR if more data is available at the given offset
+ * @param maxlines maximum number of lines to retrieve forward from the specified offset.
+ * @return {@link RundeckOutput}
+ * @throws RundeckApiException in case of error when calling the API (non-existent job with this ID)
+ * @throws RundeckApiLoginException if the login fails (in case of login-based authentication)
+ * @throws RundeckApiTokenException if the token is invalid (in case of token-based authentication)
+ * @throws IllegalArgumentException if the jobId is blank (null, empty or whitespace)
+ */
+ public RundeckOutput getExecutionOutputState(Long executionId, boolean stateOnly, int offset, long lastmod,
+ int maxlines)
+ throws RundeckApiException, RundeckApiLoginException, RundeckApiTokenException, IllegalArgumentException {
+ AssertUtil.notNull(executionId, "executionId is mandatory to get the output of a job execution!");
+ ApiPathBuilder param = new ApiPathBuilder("/execution/", executionId.toString(), "/output/state")
+ .param("offset", offset);
+ if (lastmod >= 0) {
+ param.param("lastmod", lastmod);
+ }
+ if (maxlines > 0) {
+ param.param("maxlines", maxlines);
+ }
+ if(stateOnly) {
+ param.param("stateOnly", true);
+ }
+ return new ApiCall(this).get(param, new OutputParser(rootXpath()+"/output", createOutputEntryParser()));
}
private OutputEntryParser createOutputEntryParser() {
@@ -3315,7 +2401,204 @@ public class RundeckClient implements Serializable {
*/
public RundeckSystemInfo getSystemInfo() throws RundeckApiException, RundeckApiLoginException,
RundeckApiTokenException {
- return new ApiCall(this).get(new ApiPathBuilder("/system/info"), new SystemInfoParser("result/system"));
+ return new ApiCall(this).get(new ApiPathBuilder("/system/info"), new SystemInfoParser(rootXpath()+"/system"));
+ }
+
+
+ /*
+ * API token
+ */
+
+ /**
+ * List API tokens for a user.
+ * @param user username
+ * @return list of tokens
+ * @throws RundeckApiException
+ */
+ public List listApiTokens(final String user) throws RundeckApiException {
+ AssertUtil.notNull(user, "user is mandatory to list API tokens for a user.");
+ return new ApiCall(this).
+ get(new ApiPathBuilder("/tokens/", user),
+ new ListParser(new RundeckTokenParser(), "/tokens/token"));
+ }
+
+ /**
+ * List all API tokens
+ * @return list of tokens
+ * @throws RundeckApiException
+ */
+ public List listApiTokens() throws RundeckApiException {
+ return new ApiCall(this).
+ get(new ApiPathBuilder("/tokens"),
+ new ListParser(new RundeckTokenParser(), "/tokens/token"));
+ }
+
+ /**
+ * Generate an API token for a user.
+ * @param user
+ * @return
+ * @throws RundeckApiException
+ */
+ public String generateApiToken(final String user) throws RundeckApiException{
+ AssertUtil.notNull(user, "user is mandatory to generate an API token for a user.");
+ RundeckToken result = new ApiCall(this).
+ post(new ApiPathBuilder("/tokens/", user).emptyContent(),
+ new RundeckTokenParser("/token"));
+ return result.getToken();
+ }
+ /**
+ * Delete an existing token
+ * @param token
+ * @return
+ * @throws RundeckApiException
+ */
+ public boolean deleteApiToken(final String token) throws RundeckApiException{
+ AssertUtil.notNull(token, "token is mandatory to delete an API token.");
+ new ApiCall(this).delete(new ApiPathBuilder("/token/", token));
+ return true;
+ }
+ /**
+ * Return user info for an existing token
+ * @param token
+ * @return token info
+ * @throws RundeckApiException
+ */
+ public RundeckToken getApiToken(final String token) throws RundeckApiException{
+ AssertUtil.notNull(token, "token is mandatory to get an API token.");
+ return new ApiCall(this).get(new ApiPathBuilder("/token/", token), new RundeckTokenParser("/token"));
+ }
+
+ /**
+ * Store an key file
+ * @param path ssh key storage path, must start with "keys/"
+ * @param keyfile key file
+ * @param privateKey true to store private key, false to store public key
+ * @return the key resource
+ * @throws RundeckApiException
+ */
+ public KeyResource storeKey(final String path, final File keyfile, boolean privateKey) throws RundeckApiException{
+ AssertUtil.notNull(path, "path is mandatory to store an key.");
+ AssertUtil.notNull(keyfile, "keyfile is mandatory to store an key.");
+ if (!path.startsWith(STORAGE_KEYS_PATH)) {
+ throw new IllegalArgumentException("key storage path must start with: " + STORAGE_KEYS_PATH);
+ }
+ return new ApiCall(this).post(
+ new ApiPathBuilder(STORAGE_ROOT_PATH, path).content(
+ privateKey ? "application/octet-stream" : "application/pgp-keys",
+ keyfile
+ ),
+ new SSHKeyResourceParser("/resource")
+ );
+ }
+
+ /**
+ * Get metadata for an key file
+ *
+ * @param path ssh key storage path, must start with "keys/"
+ *
+ * @return the ssh key resource
+ *
+ * @throws RundeckApiException if there is an error, or if the path is a directory not a file
+ */
+ public KeyResource getKey(final String path) throws RundeckApiException {
+ AssertUtil.notNull(path, "path is mandatory to get an key.");
+ if (!path.startsWith(STORAGE_KEYS_PATH)) {
+ throw new IllegalArgumentException("key storage path must start with: " + STORAGE_KEYS_PATH);
+ }
+ KeyResource storageResource = new ApiCall(this).get(
+ new ApiPathBuilder(STORAGE_ROOT_PATH, path),
+ new SSHKeyResourceParser("/resource")
+ );
+ if (storageResource.isDirectory()) {
+ throw new RundeckApiException("Key Path is a directory: " + path);
+ }
+ return storageResource;
+ }
+
+ /**
+ * Get content for a public key file
+ * @param path ssh key storage path, must start with "keys/"
+ * @param out outputstream to write data to
+ *
+ * @return length of written data
+ * @throws RundeckApiException
+ */
+ public int getPublicKeyContent(final String path, final OutputStream out) throws
+ RundeckApiException, IOException {
+ AssertUtil.notNull(path, "path is mandatory to get an key.");
+ if (!path.startsWith(STORAGE_KEYS_PATH)) {
+ throw new IllegalArgumentException("key storage path must start with: " + STORAGE_KEYS_PATH);
+ }
+ try {
+ return new ApiCall(this).get(
+ new ApiPathBuilder(STORAGE_ROOT_PATH, path)
+ .accept("application/pgp-keys")
+ .requireContentType("application/pgp-keys"),
+ out
+ );
+ } catch (RundeckApiException.RundeckApiHttpContentTypeException e) {
+ throw new RundeckApiException("Requested Key path was not a Public key: " + path, e);
+ }
+ }
+
+ /**
+ * Get content for a public key file
+ * @param path ssh key storage path, must start with "keys/"
+ * @param out file to write data to
+ * @return length of written data
+ * @throws RundeckApiException
+ */
+ public int getPublicKeyContent(final String path, final File out) throws
+ RundeckApiException, IOException {
+ final FileOutputStream fileOutputStream = new FileOutputStream(out);
+ try {
+ return getPublicKeyContent(path, fileOutputStream);
+ }finally {
+ fileOutputStream.close();
+ }
+ }
+
+ /**
+ * List contents of root key directory
+ *
+ * @return list of key resources
+ * @throws RundeckApiException
+ */
+ public List listKeyDirectoryRoot() throws RundeckApiException {
+ return listKeyDirectory(STORAGE_KEYS_PATH);
+ }
+ /**
+ * List contents of key directory
+ *
+ * @param path ssh key storage path, must start with "keys/"
+ *
+ * @throws RundeckApiException if there is an error, or if the path is a file not a directory
+ */
+ public List listKeyDirectory(final String path) throws RundeckApiException {
+ AssertUtil.notNull(path, "path is mandatory to get an key.");
+ if (!path.startsWith(STORAGE_KEYS_PATH)) {
+ throw new IllegalArgumentException("key storage path must start with: " + STORAGE_KEYS_PATH);
+ }
+ KeyResource storageResource = new ApiCall(this).get(
+ new ApiPathBuilder(STORAGE_ROOT_PATH, path),
+ new SSHKeyResourceParser("/resource")
+ );
+ if(!storageResource.isDirectory()) {
+ throw new RundeckApiException("key path is not a directory path: " + path);
+ }
+ return storageResource.getDirectoryContents();
+ }
+
+ /**
+ * Delete an key file
+ * @param path a path to a key file, must start with "keys/"
+ */
+ public void deleteKey(final String path){
+ AssertUtil.notNull(path, "path is mandatory to delete an key.");
+ if (!path.startsWith(STORAGE_KEYS_PATH)) {
+ throw new IllegalArgumentException("key storage path must start with: " + STORAGE_KEYS_PATH);
+ }
+ new ApiCall(this).delete(new ApiPathBuilder(STORAGE_ROOT_PATH, path));
}
/**
diff --git a/src/main/java/org/rundeck/api/domain/ArchiveImport.java b/src/main/java/org/rundeck/api/domain/ArchiveImport.java
new file mode 100644
index 0000000..7be8112
--- /dev/null
+++ b/src/main/java/org/rundeck/api/domain/ArchiveImport.java
@@ -0,0 +1,38 @@
+package org.rundeck.api.domain;
+
+import java.util.List;
+
+/**
+ * ArchiveImport describes the result of an {@link org.rundeck.api.RundeckClient#importArchive(String, java.io.File,
+ * boolean, boolean)} request.
+ *
+ * @author greg
+ * @since 2014-03-09
+ */
+public class ArchiveImport {
+ private boolean successful;
+ private List errorMessages;
+
+ public ArchiveImport(final boolean successful, final List errorMessages) {
+ this.successful = successful;
+ this.errorMessages = errorMessages;
+ }
+
+ /**
+ * Return true if successful
+ * @return
+ */
+ public boolean isSuccessful() {
+ return successful;
+ }
+
+
+ /**
+ * Return a list of error messages if unsuccessful
+ * @return
+ */
+ public List getErrorMessages() {
+ return errorMessages;
+ }
+
+}
diff --git a/src/main/java/org/rundeck/api/domain/BaseKeyResource.java b/src/main/java/org/rundeck/api/domain/BaseKeyResource.java
new file mode 100644
index 0000000..c1ed3b7
--- /dev/null
+++ b/src/main/java/org/rundeck/api/domain/BaseKeyResource.java
@@ -0,0 +1,58 @@
+package org.rundeck.api.domain;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * BaseKeyResource is ...
+ *
+ * @author Greg Schueler
+ * @since 2014-04-04
+ */
+public class BaseKeyResource extends BaseStorageResource implements KeyResource {
+ private boolean privateKey;
+
+ public BaseKeyResource() {
+ }
+
+
+ public boolean isPrivateKey() {
+ return privateKey;
+ }
+
+ public void setPrivateKey(boolean privateKey) {
+ this.privateKey = privateKey;
+ }
+
+ ArrayList keyResources = new ArrayList();
+
+ @Override
+ public void setDirectoryContents(List directoryContents) {
+ for (StorageResource directoryContent : directoryContents) {
+ keyResources.add(from(directoryContent));
+ }
+ }
+
+ @Override
+ public List getDirectoryContents() {
+ return keyResources;
+ }
+
+ public static BaseKeyResource from(final StorageResource source) {
+ final BaseKeyResource baseSshKeyResource = new BaseKeyResource();
+ baseSshKeyResource.setDirectory(source.isDirectory());
+ baseSshKeyResource.setPath(source.getPath());
+ baseSshKeyResource.setName(source.getName());
+ baseSshKeyResource.setMetadata(source.getMetadata());
+ baseSshKeyResource.setUrl(source.getUrl());
+ if (!baseSshKeyResource.isDirectory()) {
+ baseSshKeyResource.setPrivateKey(
+ null != baseSshKeyResource.getMetadata() && "private".equals(baseSshKeyResource.getMetadata().get
+ ("Rundeck-key-type"))
+ );
+ } else if (null != source.getDirectoryContents()) {
+ baseSshKeyResource.setDirectoryContents(source.getDirectoryContents());
+ }
+ return baseSshKeyResource;
+ }
+}
diff --git a/src/main/java/org/rundeck/api/domain/BaseState.java b/src/main/java/org/rundeck/api/domain/BaseState.java
new file mode 100644
index 0000000..f97fa23
--- /dev/null
+++ b/src/main/java/org/rundeck/api/domain/BaseState.java
@@ -0,0 +1,63 @@
+package org.rundeck.api.domain;
+
+import java.util.Date;
+import java.util.List;
+import java.util.Set;
+
+/**
+ * Base execution status for a step
+ */
+public class BaseState {
+ private Date startTime;
+ private Date endTime;
+ private Date updateTime;
+ private RundeckWFExecState executionState;
+
+ /**
+ * Time that the execution of this step started
+ * @return
+ */
+ public Date getStartTime() {
+ return startTime;
+ }
+
+ public void setStartTime(Date startTime) {
+ this.startTime = startTime;
+ }
+
+ /**
+ * Time that the execution of this step finished, or null if it has not completed
+ * @return
+ */
+ public Date getEndTime() {
+ return endTime;
+ }
+
+ public void setEndTime(Date endTime) {
+ this.endTime = endTime;
+ }
+
+ /**
+ * Current state of the execution
+ * @return
+ */
+ public RundeckWFExecState getExecutionState() {
+ return executionState;
+ }
+
+ public void setExecutionState(RundeckWFExecState executionState) {
+ this.executionState = executionState;
+ }
+
+ /**
+ * Time that this state was last updated
+ * @return
+ */
+ public Date getUpdateTime() {
+ return updateTime;
+ }
+
+ public void setUpdateTime(Date updateTime) {
+ this.updateTime = updateTime;
+ }
+}
diff --git a/src/main/java/org/rundeck/api/domain/BaseStorageResource.java b/src/main/java/org/rundeck/api/domain/BaseStorageResource.java
new file mode 100644
index 0000000..6639ab4
--- /dev/null
+++ b/src/main/java/org/rundeck/api/domain/BaseStorageResource.java
@@ -0,0 +1,86 @@
+package org.rundeck.api.domain;
+
+import java.util.List;
+import java.util.Map;
+
+/**
+ * BaseStorageResource is ...
+ *
+ * @author Greg Schueler
+ * @since 2014-04-04
+ */
+public class BaseStorageResource implements StorageResource {
+ private String path;
+ private String url;
+ private String name;
+ private Map metadata;
+ private boolean directory;
+ private List directoryContents;
+
+ public BaseStorageResource() {
+ }
+
+ @Override
+ public String getPath() {
+ return path;
+ }
+
+ public void setPath(String path) {
+ this.path = path;
+ }
+
+ @Override
+ public String getUrl() {
+ return url;
+ }
+
+ public void setUrl(String url) {
+ this.url = url;
+ }
+
+ @Override
+ public String getName() {
+ return name;
+ }
+
+ public void setName(String name) {
+ this.name = name;
+ }
+
+ @Override
+ public Map getMetadata() {
+ return metadata;
+ }
+
+ public void setMetadata(Map metadata) {
+ this.metadata = metadata;
+ }
+
+ @Override
+ public boolean isDirectory() {
+ return directory;
+ }
+
+ public void setDirectory(boolean directory) {
+ this.directory = directory;
+ }
+
+ @Override
+ public List getDirectoryContents() {
+ return directoryContents;
+ }
+
+ public void setDirectoryContents(List directoryContents) {
+ this.directoryContents = directoryContents;
+ }
+
+ @Override
+ public String toString() {
+ return "BaseStorageResource{" +
+ "path='" + path + '\'' +
+ ", url='" + url + '\'' +
+ ", name='" + name + '\'' +
+ ", directory=" + directory +
+ '}';
+ }
+}
diff --git a/src/main/java/org/rundeck/api/domain/ConfigProperty.java b/src/main/java/org/rundeck/api/domain/ConfigProperty.java
new file mode 100644
index 0000000..d15d773
--- /dev/null
+++ b/src/main/java/org/rundeck/api/domain/ConfigProperty.java
@@ -0,0 +1,68 @@
+package org.rundeck.api.domain;
+
+import java.io.Serializable;
+
+/**
+ * ConfigProperty is a single configuration property key and value.
+ *
+ * @author greg
+ * @since 2014-03-07
+ */
+public class ConfigProperty implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+ private String key;
+ private String value;
+
+ public ConfigProperty() {
+ }
+
+ public ConfigProperty(String key, String value) {
+ this.key = key;
+ this.value = value;
+ }
+
+ public String getKey() {
+ return key;
+ }
+
+ public void setKey(String key) {
+ this.key = key;
+ }
+
+ public String getValue() {
+ return value;
+ }
+
+ public void setValue(String value) {
+ this.value = value;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (!(o instanceof ConfigProperty)) return false;
+
+ ConfigProperty that = (ConfigProperty) o;
+
+ if (!key.equals(that.key)) return false;
+ if (!value.equals(that.value)) return false;
+
+ return true;
+ }
+
+ @Override
+ public int hashCode() {
+ int result = key.hashCode();
+ result = 31 * result + value.hashCode();
+ return result;
+ }
+
+ @Override
+ public String toString() {
+ return "ConfigProperty{" +
+ "key='" + key + '\'' +
+ ", value='" + value + '\'' +
+ '}';
+ }
+}
diff --git a/src/main/java/org/rundeck/api/domain/DeleteExecutionsResponse.java b/src/main/java/org/rundeck/api/domain/DeleteExecutionsResponse.java
new file mode 100644
index 0000000..6d1f53b
--- /dev/null
+++ b/src/main/java/org/rundeck/api/domain/DeleteExecutionsResponse.java
@@ -0,0 +1,84 @@
+package org.rundeck.api.domain;
+
+import java.io.Serializable;
+import java.util.List;
+
+/**
+ * DeleteExecutionsResponse is ...
+ *
+ * @author Greg Schueler
+ * @since 2014-11-06
+ */
+public class DeleteExecutionsResponse implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+
+ private int failedCount;
+ private int successCount;
+ private boolean allsuccessful;
+ private int requestCount;
+ private List failures;
+
+ public int getFailedCount() {
+ return failedCount;
+ }
+
+ public void setFailedCount(final int failedCount) {
+ this.failedCount = failedCount;
+ }
+
+ public int getSuccessCount() {
+ return successCount;
+ }
+
+ public void setSuccessCount(final int successCount) {
+ this.successCount = successCount;
+ }
+
+ public boolean isAllsuccessful() {
+ return allsuccessful;
+ }
+
+ public void setAllsuccessful(final boolean allsuccessful) {
+ this.allsuccessful = allsuccessful;
+ }
+
+ public int getRequestCount() {
+ return requestCount;
+ }
+
+ public void setRequestCount(final int requestCount) {
+ this.requestCount = requestCount;
+ }
+
+ public List getFailures() {
+ return failures;
+ }
+
+ public void setFailures(final List failures) {
+ this.failures = failures;
+ }
+
+ public static class DeleteFailure implements Serializable{
+
+ private static final long serialVersionUID = 1L;
+ private Long executionId;
+ private String message;
+
+ public Long getExecutionId() {
+ return executionId;
+ }
+
+ public void setExecutionId(final Long executionId) {
+ this.executionId = executionId;
+ }
+
+ public String getMessage() {
+ return message;
+ }
+
+ public void setMessage(final String message) {
+ this.message = message;
+ }
+ }
+}
diff --git a/src/main/java/org/rundeck/api/domain/KeyResource.java b/src/main/java/org/rundeck/api/domain/KeyResource.java
new file mode 100644
index 0000000..ff1f7e1
--- /dev/null
+++ b/src/main/java/org/rundeck/api/domain/KeyResource.java
@@ -0,0 +1,23 @@
+package org.rundeck.api.domain;
+
+import java.util.List;
+
+/**
+ * KeyResource represents a directory or an SSH key file
+ *
+ * @author Greg Schueler
+ * @since 2014-04-04
+ */
+public interface KeyResource extends StorageResource {
+ /**
+ * Return true if this is a file and is a private SSH key file.
+ * @return
+ */
+ public boolean isPrivateKey();
+
+ /**
+ * Return the list of SSH Key resources if this is a directory
+ * @return
+ */
+ public List getDirectoryContents();
+}
diff --git a/src/main/java/org/rundeck/api/domain/ProjectConfig.java b/src/main/java/org/rundeck/api/domain/ProjectConfig.java
new file mode 100644
index 0000000..ca3548f
--- /dev/null
+++ b/src/main/java/org/rundeck/api/domain/ProjectConfig.java
@@ -0,0 +1,64 @@
+package org.rundeck.api.domain;
+
+import java.io.Serializable;
+import java.util.LinkedHashMap;
+import java.util.Map;
+
+/**
+ * ProjectConfig is ...
+ *
+ * @author greg
+ * @since 2014-02-27
+ */
+public class ProjectConfig implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+ private LinkedHashMap properties = new LinkedHashMap();
+
+ public ProjectConfig() {
+ }
+
+ public ProjectConfig(Map properties) {
+ setProperties(properties);
+ }
+
+ public void setProperty(final String key, final String value) {
+ getProperties().put(key, value);
+ }
+
+ public void addProperties(final Map values) {
+ getProperties().putAll(values);
+ }
+
+ public Map getProperties() {
+ return properties;
+ }
+
+ public void setProperties(final Map properties) {
+ this.properties = new LinkedHashMap(properties);
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (!(o instanceof ProjectConfig)) return false;
+
+ ProjectConfig that = (ProjectConfig) o;
+
+ if (properties != null ? !properties.equals(that.properties) : that.properties != null) return false;
+
+ return true;
+ }
+
+ @Override
+ public int hashCode() {
+ return properties != null ? properties.hashCode() : 0;
+ }
+
+ @Override
+ public String toString() {
+ return "ProjectConfig{" +
+ "properties=" + properties +
+ '}';
+ }
+}
diff --git a/src/main/java/org/rundeck/api/domain/RundeckExecution.java b/src/main/java/org/rundeck/api/domain/RundeckExecution.java
index 0005554..20dc45c 100644
--- a/src/main/java/org/rundeck/api/domain/RundeckExecution.java
+++ b/src/main/java/org/rundeck/api/domain/RundeckExecution.java
@@ -17,6 +17,7 @@ package org.rundeck.api.domain;
import java.io.Serializable;
import java.util.Date;
+import java.util.Set;
import java.util.concurrent.TimeUnit;
import org.apache.commons.lang.time.DurationFormatUtils;
@@ -52,6 +53,8 @@ public class RundeckExecution implements Serializable {
private String description;
private String argstring;
private String project;
+ private Set successfulNodes;
+ private Set failedNodes;
/**
* @return the duration of the execution in milliseconds (or null if the duration is still running, or has been
@@ -174,7 +177,10 @@ public class RundeckExecution implements Serializable {
return "RundeckExecution [id=" + id + ", description=" + description + ", url=" + url + ", status=" + status
+ ", argstring=" + argstring
+ ", startedBy=" + startedBy + ", startedAt=" + startedAt + ", endedAt=" + endedAt
- + ", durationInSeconds=" + getDurationInSeconds() + ", abortedBy=" + abortedBy + ", job=" + job + "]";
+ + ", durationInSeconds=" + getDurationInSeconds() + ", abortedBy=" + abortedBy + ", job=" + job
+ + ", successfulNodes=" + getSuccessfulNodes()
+ + ", failedNodes=" + getFailedNodes()
+ + "]";
}
@Override
@@ -281,6 +287,22 @@ public class RundeckExecution implements Serializable {
this.project = project;
}
+ public Set getSuccessfulNodes() {
+ return successfulNodes;
+ }
+
+ public void setSuccessfulNodes(Set successfulNodes) {
+ this.successfulNodes = successfulNodes;
+ }
+
+ public Set getFailedNodes() {
+ return failedNodes;
+ }
+
+ public void setFailedNodes(Set failedNodes) {
+ this.failedNodes = failedNodes;
+ }
+
/**
* The status of an execution
*/
diff --git a/src/main/java/org/rundeck/api/domain/RundeckExecutionState.java b/src/main/java/org/rundeck/api/domain/RundeckExecutionState.java
new file mode 100644
index 0000000..c06a4bf
--- /dev/null
+++ b/src/main/java/org/rundeck/api/domain/RundeckExecutionState.java
@@ -0,0 +1,50 @@
+package org.rundeck.api.domain;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+/**
+ * The state of an Execution
+ */
+public class RundeckExecutionState extends WorkflowState{
+ private long executionId;
+ private Set allNodes;
+ private Map> nodeStates;
+
+ /**
+ * Return the set of all rundeck nodes targeted in this execution
+ * @return
+ */
+ public Set getAllNodes() {
+ return allNodes;
+ }
+
+ public void setAllNodes(Set allNodes) {
+ this.allNodes = allNodes;
+ }
+
+ /**
+ * Return the map of node name to step state list
+ * @return
+ */
+ public Map> getNodeStates() {
+ return nodeStates;
+ }
+
+ public void setNodeStates(Map> nodeStates) {
+ this.nodeStates = nodeStates;
+ }
+
+ /**
+ * Return this execution's ID
+ * @return
+ */
+ public long getExecutionId() {
+ return executionId;
+ }
+
+ public void setExecutionId(long executionId) {
+ this.executionId = executionId;
+ }
+}
diff --git a/src/main/java/org/rundeck/api/domain/RundeckNode.java b/src/main/java/org/rundeck/api/domain/RundeckNode.java
index 87a1a36..9d54b9f 100644
--- a/src/main/java/org/rundeck/api/domain/RundeckNode.java
+++ b/src/main/java/org/rundeck/api/domain/RundeckNode.java
@@ -23,7 +23,7 @@ import java.util.List;
*
* @author Vincent Behar
*/
-public class RundeckNode implements Serializable {
+public class RundeckNode implements Serializable, RundeckNodeIdentity {
private static final long serialVersionUID = 1L;
@@ -63,6 +63,7 @@ public class RundeckNode implements Serializable {
/** URL to an external resource model service. (optional) */
private String remoteUrl;
+ @Override
public String getName() {
return name;
}
diff --git a/src/main/java/org/rundeck/api/domain/RundeckNodeIdentity.java b/src/main/java/org/rundeck/api/domain/RundeckNodeIdentity.java
new file mode 100644
index 0000000..063bfd3
--- /dev/null
+++ b/src/main/java/org/rundeck/api/domain/RundeckNodeIdentity.java
@@ -0,0 +1,14 @@
+package org.rundeck.api.domain;
+
+
+/**
+ * Identifies a node by name
+ */
+public interface RundeckNodeIdentity {
+ /**
+ * Return the rundeck Node name
+ *
+ * @return
+ */
+ String getName();
+}
diff --git a/src/main/java/org/rundeck/api/domain/RundeckOutput.java b/src/main/java/org/rundeck/api/domain/RundeckOutput.java
index a4696ec..3663810 100644
--- a/src/main/java/org/rundeck/api/domain/RundeckOutput.java
+++ b/src/main/java/org/rundeck/api/domain/RundeckOutput.java
@@ -22,9 +22,9 @@ public class RundeckOutput implements Serializable {
//private String error = null;
- private Boolean unmodified;
+ private Boolean unmodified = false;
- private Boolean empty;
+ private Boolean empty = false;
private int offset;
@@ -46,6 +46,9 @@ public class RundeckOutput implements Serializable {
List logEntries = null;
+ private String filterNode;
+ private String filterStep;
+
public Long getExecutionId() {
return executionId;
}
@@ -181,6 +184,7 @@ public class RundeckOutput implements Serializable {
", execCompleted=" + execCompleted + ", hasFailedNodes=" + hasFailedNodes +
", status=" + status + ", lastModified=" + lastModified +
", execDuration=" + execDuration + ", percentLoaded=" + percentLoaded +
+ ", filterNode=" + filterNode + ", filterStep=" + filterStep +
", totalSize=" + totalSize + "]";
}
@@ -203,6 +207,8 @@ public class RundeckOutput implements Serializable {
result = prime * result + ((percentLoaded == null) ? 0 : percentLoaded.hashCode());
result = prime * result + totalSize;
result = prime * result + ((logEntries == null) ? 0 : logEntries.hashCode());
+ result = prime * result + ((filterNode == null) ? 0 : filterNode.hashCode());
+ result = prime * result + ((filterStep == null) ? 0 : filterStep.hashCode());
return result;
}
@@ -286,7 +292,40 @@ public class RundeckOutput implements Serializable {
return false;
} else if (!logEntries.equals(other.logEntries))
return false;
+ if (filterNode == null) {
+ if (other.filterNode != null)
+ return false;
+ } else if (!filterNode.equals(other.filterNode))
+ return false;
+ if (filterStep == null) {
+ if (other.filterStep != null)
+ return false;
+ } else if (!filterStep.equals(other.filterStep))
+ return false;
return true;
}
-
-}
\ No newline at end of file
+
+ public String getFilterNode() {
+ return filterNode;
+ }
+
+ /**
+ * return the node name used to filter this output
+ * @param filterNode
+ */
+ public void setFilterNode(String filterNode) {
+ this.filterNode = filterNode;
+ }
+
+ /**
+ * Return the step context used to filter this output
+ * @return
+ */
+ public String getFilterStep() {
+ return filterStep;
+ }
+
+ public void setFilterStep(String filterStep) {
+ this.filterStep = filterStep;
+ }
+}
diff --git a/src/main/java/org/rundeck/api/domain/RundeckOutputEntry.java b/src/main/java/org/rundeck/api/domain/RundeckOutputEntry.java
index 607c01a..4160634 100644
--- a/src/main/java/org/rundeck/api/domain/RundeckOutputEntry.java
+++ b/src/main/java/org/rundeck/api/domain/RundeckOutputEntry.java
@@ -1,6 +1,8 @@
package org.rundeck.api.domain;
import java.io.Serializable;
+import java.util.Date;
+import java.util.Map;
/**
* Represents a RunDeck output entry
@@ -11,7 +13,8 @@ public class RundeckOutputEntry implements Serializable {
private static final long serialVersionUID = 1L;
private String time = null;
-
+ private Date absoluteTime = null;
+
private RundeckLogLevel level = null;
private String message = null;
@@ -21,7 +24,9 @@ public class RundeckOutputEntry implements Serializable {
private String command = null;
private String node = null;
+ private String type = null;
+ private Map metadata;
public String getTime() {
@@ -77,8 +82,11 @@ public class RundeckOutputEntry implements Serializable {
@Override
public String toString() {
return "RundeckOutputEntry [time=" + time + ", level=" + level +
- ", message=" + message + ", user=" + user + ", command=" +
- command + ", node=" + node + "]";
+ ", message=" + message + ", user=" + user
+ + ", command=" + command
+ + ", type=" + type
+ + ", metadata=" + metadata
+ + ", node=" + node + "]";
}
@Override
@@ -91,6 +99,8 @@ public class RundeckOutputEntry implements Serializable {
result = prime * result + ((user == null) ? 0 : user.hashCode());
result = prime * result + ((command == null) ? 0 : command.hashCode());
result = prime * result + ((node == null) ? 0 : node.hashCode());
+ result = prime * result + ((type == null) ? 0 : type.hashCode());
+ result = prime * result + ((metadata == null) ? 0 : metadata.hashCode());
return result;
}
@@ -134,13 +144,49 @@ public class RundeckOutputEntry implements Serializable {
return false;
} else if (!node.equals(other.node))
return false;
+ if (type == null) {
+ if (other.type != null)
+ return false;
+ } else if (!type.equals(other.type))
+ return false;
+ if (metadata == null) {
+ if (other.metadata != null)
+ return false;
+ } else if (!metadata.equals(other.metadata))
+ return false;
return true;
}
+ /**
+ * type of entry
+ */
+ public String getType() {
+ return type;
+ }
+
+ public void setType(String type) {
+ this.type = type;
+ }
+
+ public Map getMetadata() {
+ return metadata;
+ }
+
+ public void setMetadata(Map metadata) {
+ this.metadata = metadata;
+ }
+
+ public Date getAbsoluteTime() {
+ return absoluteTime;
+ }
+
+ public void setAbsoluteTime(Date absoluteTime) {
+ this.absoluteTime = absoluteTime;
+ }
+
public static enum RundeckLogLevel {
- SEVERE, WARNING, INFO, CONFIG, FINEST;
+ SEVERE, ERROR, WARNING, INFO, NORMAL, DEBUG, CONFIG, VERBOSE, FINEST,;
}
-
-}
\ No newline at end of file
+}
diff --git a/src/main/java/org/rundeck/api/domain/RundeckProject.java b/src/main/java/org/rundeck/api/domain/RundeckProject.java
index c5e3fa4..32e38ea 100644
--- a/src/main/java/org/rundeck/api/domain/RundeckProject.java
+++ b/src/main/java/org/rundeck/api/domain/RundeckProject.java
@@ -32,6 +32,8 @@ public class RundeckProject implements Serializable {
private String resourceModelProviderUrl;
+ private ProjectConfig projectConfig;
+
public String getName() {
return name;
}
@@ -56,10 +58,20 @@ public class RundeckProject implements Serializable {
this.resourceModelProviderUrl = resourceModelProviderUrl;
}
+ public ProjectConfig getProjectConfig() {
+ return projectConfig;
+ }
+
+ public void setProjectConfig(ProjectConfig projectConfig) {
+ this.projectConfig = projectConfig;
+ }
+
@Override
public String toString() {
- return "RundeckProject [name=" + name + ", description=" + description + ", resourceModelProviderUrl="
- + resourceModelProviderUrl + "]";
+ return "RundeckProject [name=" + name + ", description=" + description
+ + (null!=resourceModelProviderUrl? ", resourceModelProviderUrl=" + resourceModelProviderUrl : "")
+ + ", config="
+ + projectConfig + "]";
}
@Override
@@ -69,6 +81,7 @@ public class RundeckProject implements Serializable {
result = prime * result + ((description == null) ? 0 : description.hashCode());
result = prime * result + ((name == null) ? 0 : name.hashCode());
result = prime * result + ((resourceModelProviderUrl == null) ? 0 : resourceModelProviderUrl.hashCode());
+ result = prime * result + ((projectConfig == null) ? 0 : projectConfig.hashCode());
return result;
}
@@ -96,7 +109,11 @@ public class RundeckProject implements Serializable {
return false;
} else if (!resourceModelProviderUrl.equals(other.resourceModelProviderUrl))
return false;
+ if (projectConfig == null) {
+ if (other.projectConfig != null)
+ return false;
+ } else if (!projectConfig.equals(other.projectConfig))
+ return false;
return true;
}
-
}
diff --git a/src/main/java/org/rundeck/api/domain/RundeckToken.java b/src/main/java/org/rundeck/api/domain/RundeckToken.java
new file mode 100644
index 0000000..613fc82
--- /dev/null
+++ b/src/main/java/org/rundeck/api/domain/RundeckToken.java
@@ -0,0 +1,36 @@
+package org.rundeck.api.domain;
+
+/**
+ * RundeckToken is ...
+ *
+ * @author Greg Schueler
+ * @since 2014-04-04
+ */
+public class RundeckToken {
+ private String user;
+ private String token;
+
+ public RundeckToken() {
+ }
+
+ public RundeckToken(String user, String token) {
+ this.setUser(user);
+ this.setToken(token);
+ }
+
+ public String getUser() {
+ return user;
+ }
+
+ public void setUser(String user) {
+ this.user = user;
+ }
+
+ public String getToken() {
+ return token;
+ }
+
+ public void setToken(String token) {
+ this.token = token;
+ }
+}
diff --git a/src/main/java/org/rundeck/api/domain/RundeckWFExecState.java b/src/main/java/org/rundeck/api/domain/RundeckWFExecState.java
new file mode 100644
index 0000000..86b0466
--- /dev/null
+++ b/src/main/java/org/rundeck/api/domain/RundeckWFExecState.java
@@ -0,0 +1,43 @@
+package org.rundeck.api.domain;
+
+/**
+ * An execution state for a workflow or node step
+ */
+public enum RundeckWFExecState {
+ /**
+ * Waiting to start running
+ */
+ WAITING,
+ /**
+ * Currently running
+ */
+ RUNNING,
+ /**
+ * Running error handler
+ */
+ RUNNING_HANDLER,
+ /**
+ * Finished running successfully
+ */
+ SUCCEEDED,
+ /**
+ * Finished with a failure
+ */
+ FAILED,
+ /**
+ * Execution was aborted
+ */
+ ABORTED,
+ /**
+ * Partial success for some nodes
+ */
+ NODE_PARTIAL_SUCCEEDED,
+ /**
+ * Mixed states among nodes
+ */
+ NODE_MIXED,
+ /**
+ * After waiting the execution did not start
+ */
+ NOT_STARTED,;
+}
diff --git a/src/main/java/org/rundeck/api/domain/StorageResource.java b/src/main/java/org/rundeck/api/domain/StorageResource.java
new file mode 100644
index 0000000..be02412
--- /dev/null
+++ b/src/main/java/org/rundeck/api/domain/StorageResource.java
@@ -0,0 +1,54 @@
+package org.rundeck.api.domain;
+
+import java.util.List;
+import java.util.Map;
+
+/**
+ * StorageResource represents a directory or a file
+ *
+ * @author Greg Schueler
+ * @since 2014-04-04
+ */
+public interface StorageResource {
+ /**
+ * Return the storage path for this resource
+ *
+ * @return
+ */
+ public String getPath();
+
+ /**
+ * Return the URL for this resource
+ *
+ * @return
+ */
+ public String getUrl();
+
+ /**
+ * Return the file name if this is a file
+ *
+ * @return
+ */
+ public String getName();
+
+ /**
+ * Return the metadata for this file if this is a file
+ *
+ * @return
+ */
+ public Map getMetadata();
+
+ /**
+ * Return true if this is a directory, false if this is a file
+ *
+ * @return
+ */
+ public boolean isDirectory();
+
+ /**
+ * Return the list of directory contents if this is a directory
+ *
+ * @return
+ */
+ public List getDirectoryContents();
+}
diff --git a/src/main/java/org/rundeck/api/domain/WorkflowState.java b/src/main/java/org/rundeck/api/domain/WorkflowState.java
new file mode 100644
index 0000000..3ce17a2
--- /dev/null
+++ b/src/main/java/org/rundeck/api/domain/WorkflowState.java
@@ -0,0 +1,52 @@
+package org.rundeck.api.domain;
+
+import java.util.Date;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+/**
+ * Represents the state of a workflow of steps
+ */
+public class WorkflowState extends BaseState {
+ private int stepCount;
+ private Set targetNodes;
+ private List steps;
+
+ /**
+ * Return the number of steps in this workflow
+ * @return
+ */
+ public int getStepCount() {
+ return stepCount;
+ }
+
+ public void setStepCount(int stepCount) {
+ this.stepCount = stepCount;
+ }
+
+ /**
+ * Identify the target nodes of this workflow
+ * @return
+ */
+ public Set getTargetNodes() {
+ return targetNodes;
+ }
+
+ public void setTargetNodes(Set targetNodes) {
+ this.targetNodes = targetNodes;
+ }
+
+ /**
+ * Return the list of steps for this workflow
+ * @return
+ */
+ public List getSteps() {
+ return steps;
+ }
+
+ public void setSteps(List steps) {
+ this.steps = steps;
+ }
+
+}
diff --git a/src/main/java/org/rundeck/api/domain/WorkflowStepContextState.java b/src/main/java/org/rundeck/api/domain/WorkflowStepContextState.java
new file mode 100644
index 0000000..ef6e80c
--- /dev/null
+++ b/src/main/java/org/rundeck/api/domain/WorkflowStepContextState.java
@@ -0,0 +1,33 @@
+package org.rundeck.api.domain;
+
+/**
+ * A state for a particular step
+ */
+public class WorkflowStepContextState extends BaseState {
+ private String stepContextId;
+ private int stepNum;
+
+ /**
+ * The context id for the step in the form "#[/#[/#[...]]]" where "#" is a number
+ * @return
+ */
+ public String getStepContextId() {
+ return stepContextId;
+ }
+
+ public void setStepContextId(String stepContextId) {
+ this.stepContextId = stepContextId;
+ }
+
+ /**
+ * The step number of this step in the current workflow, 1 indexed.
+ * @return
+ */
+ public int getStepNum() {
+ return stepNum;
+ }
+
+ public void setStepNum(int stepNum) {
+ this.stepNum = stepNum;
+ }
+}
diff --git a/src/main/java/org/rundeck/api/domain/WorkflowStepState.java b/src/main/java/org/rundeck/api/domain/WorkflowStepState.java
new file mode 100644
index 0000000..49a8d93
--- /dev/null
+++ b/src/main/java/org/rundeck/api/domain/WorkflowStepState.java
@@ -0,0 +1,49 @@
+package org.rundeck.api.domain;
+
+import java.util.List;
+import java.util.Map;
+
+/**
+ * Represents the state of a step in a workflow
+ */
+public class WorkflowStepState extends WorkflowStepContextState {
+ private boolean nodeStep;
+ private WorkflowState subWorkflow;
+ private Map nodeStates;
+
+ /**
+ * Return true if this step runs on each target node
+ * @return
+ */
+ public boolean isNodeStep() {
+ return nodeStep;
+ }
+
+ public void setNodeStep(boolean nodeStep) {
+ this.nodeStep = nodeStep;
+ }
+
+ /**
+ * Return sub workflow if this step has one
+ * @return
+ */
+ public WorkflowState getSubWorkflow() {
+ return subWorkflow;
+ }
+
+ public void setSubWorkflow(WorkflowState subWorkflow) {
+ this.subWorkflow = subWorkflow;
+ }
+
+ /**
+ * Return the state of each target node if this step runs on each target node
+ * @return
+ */
+ public Map getNodeStates() {
+ return nodeStates;
+ }
+
+ public void setNodeStates(Map nodeStates) {
+ this.nodeStates = nodeStates;
+ }
+}
diff --git a/src/main/java/org/rundeck/api/generator/BaseDocGenerator.java b/src/main/java/org/rundeck/api/generator/BaseDocGenerator.java
new file mode 100644
index 0000000..46bf574
--- /dev/null
+++ b/src/main/java/org/rundeck/api/generator/BaseDocGenerator.java
@@ -0,0 +1,18 @@
+package org.rundeck.api.generator;
+
+import org.dom4j.Document;
+import org.dom4j.DocumentFactory;
+
+/**
+ * BaseDocGenerator generates a document using the element as the root.
+ *
+ * @author greg
+ * @since 2014-02-27
+ */
+public abstract class BaseDocGenerator implements XmlDocumentGenerator {
+ @Override
+ public Document generateXmlDocument() {
+ return DocumentFactory.getInstance().createDocument(generateXmlElement());
+ }
+
+}
diff --git a/src/main/java/org/rundeck/api/generator/DeleteExecutionsGenerator.java b/src/main/java/org/rundeck/api/generator/DeleteExecutionsGenerator.java
new file mode 100644
index 0000000..8efd2bf
--- /dev/null
+++ b/src/main/java/org/rundeck/api/generator/DeleteExecutionsGenerator.java
@@ -0,0 +1,38 @@
+package org.rundeck.api.generator;
+
+import org.dom4j.DocumentFactory;
+import org.dom4j.Element;
+import org.rundeck.api.domain.ProjectConfig;
+
+import java.util.List;
+import java.util.Set;
+
+/**
+ * DeleteExecutionsGenerator is ...
+ *
+ * @author Greg Schueler
+ * @since 2014-11-06
+ */
+public class DeleteExecutionsGenerator extends BaseDocGenerator {
+ private Set executionIds;
+
+ public DeleteExecutionsGenerator(final Set executionIds) {
+ this.executionIds = executionIds;
+ }
+
+ @Override public Element generateXmlElement() {
+ Element rootElem = DocumentFactory.getInstance().createElement("executions");
+ for (Long executionId : executionIds) {
+ rootElem.addElement("execution").addAttribute("id", Long.toString(executionId));
+ }
+ return rootElem;
+ }
+
+ public Set getExecutionIds() {
+ return executionIds;
+ }
+
+ public void setExecutionIds(final Set executionIds) {
+ this.executionIds = executionIds;
+ }
+}
diff --git a/src/main/java/org/rundeck/api/generator/ProjectConfigGenerator.java b/src/main/java/org/rundeck/api/generator/ProjectConfigGenerator.java
new file mode 100644
index 0000000..547b154
--- /dev/null
+++ b/src/main/java/org/rundeck/api/generator/ProjectConfigGenerator.java
@@ -0,0 +1,34 @@
+package org.rundeck.api.generator;
+
+import org.dom4j.Document;
+import org.dom4j.DocumentFactory;
+import org.dom4j.Element;
+import org.rundeck.api.domain.ProjectConfig;
+
+/**
+ * ProjectConfigGenerator is ...
+ *
+ * @author greg
+ * @since 2014-02-27
+ */
+public class ProjectConfigGenerator extends BaseDocGenerator {
+ private ProjectConfig config;
+
+ public ProjectConfigGenerator(ProjectConfig config) {
+ this.config = config;
+ }
+
+ @Override
+ public Element generateXmlElement() {
+ Element configEl = DocumentFactory.getInstance().createElement("config");
+ if (null != config.getProperties()) {
+ for (String s : config.getProperties().keySet()) {
+ Element property = configEl.addElement("property");
+ property.addAttribute("key", s);
+ property.addAttribute("value", config.getProperties().get(s));
+ }
+ }
+ return configEl;
+ }
+
+}
diff --git a/src/main/java/org/rundeck/api/generator/ProjectConfigPropertyGenerator.java b/src/main/java/org/rundeck/api/generator/ProjectConfigPropertyGenerator.java
new file mode 100644
index 0000000..f41766b
--- /dev/null
+++ b/src/main/java/org/rundeck/api/generator/ProjectConfigPropertyGenerator.java
@@ -0,0 +1,28 @@
+package org.rundeck.api.generator;
+
+import org.dom4j.DocumentFactory;
+import org.dom4j.Element;
+import org.rundeck.api.domain.ConfigProperty;
+
+/**
+ * ProjectConfigPropertyGenerator generates a {@literal
+ * @since 2014-11-10
+ */
+public class APIV11Helper {
+
+ /**
+ * Detect and remove extra <result> wrapper around xml response.
+ * @param parser
+ * @param xpath
+ * @param
+ * @return
+ */
+ public static XmlNodeParser unwrapIfNeeded(
+ final XmlNodeParser parser,
+ final String xpath
+ ) {
+ return new NodeParser_unwrap(parser, xpath);
+ }
+
+ static class NodeParser_unwrap implements XmlNodeParser {
+ XmlNodeParser parser;
+ String xpath;
+
+ public NodeParser_unwrap(final XmlNodeParser parser, final String xpath) {
+ this.parser = parser;
+ this.xpath = xpath;
+ }
+
+ @Override public T parseXmlNode(final Node node) {
+
+ Node sourceNode = unwrapResultElement(node, xpath);
+ return parser.parseXmlNode(sourceNode);
+ }
+ }
+
+ /**
+ * Test the node for matching the xpath string, if it doesnt match, attempt to prefix it with
+ * "result" and match that. If that matches, return the first child of the 'result' element.
+ *
+ * @param node
+ * @param xpath
+ *
+ * @return
+ */
+ public static Node unwrapResultElement(final Node node, final String xpath) {
+ Node sourceNode = node;
+ final Node tested = sourceNode.selectSingleNode(xpath);
+ if (null == tested && !xpath.startsWith("result")) {
+ //prepend /result
+ if (null != sourceNode.selectSingleNode("result" + xpath)) {
+ Node resultNode = sourceNode.selectSingleNode("result");
+ if (resultNode instanceof Element) {
+ Element result = (Element) resultNode;
+ if (result.elements().size() == 1) {
+
+ Node node1 = (Node) result.elements().get(0);
+ if (node1 instanceof Element) {
+ sourceNode = node1;
+
+ sourceNode.getParent().remove(sourceNode);
+ DocumentHelper.createDocument((Element) sourceNode);
+ }
+ }
+ }
+ }
+ }
+ return sourceNode;
+ }
+}
diff --git a/src/main/java/org/rundeck/api/parser/ArchiveImportParser.java b/src/main/java/org/rundeck/api/parser/ArchiveImportParser.java
new file mode 100644
index 0000000..b4e7bda
--- /dev/null
+++ b/src/main/java/org/rundeck/api/parser/ArchiveImportParser.java
@@ -0,0 +1,36 @@
+package org.rundeck.api.parser;
+
+import org.dom4j.Node;
+import org.rundeck.api.domain.ArchiveImport;
+
+import java.util.ArrayList;
+
+/**
+ * ArchiveImportParser is ...
+ *
+ * @author greg
+ * @since 2014-03-09
+ */
+public class ArchiveImportParser implements XmlNodeParser {
+ String xpath;
+
+ public ArchiveImportParser() {
+ }
+
+ public ArchiveImportParser(final String xpath) {
+ this.xpath = xpath;
+ }
+
+ @Override
+ public ArchiveImport parseXmlNode(final Node node) {
+ final Node importNode = xpath != null ? node.selectSingleNode(xpath) : node;
+
+ boolean issuccess = "successful".equals(importNode.valueOf("/import/@status"));
+ final ArrayList messages = new ArrayList();
+ for (final Object o : importNode.selectNodes("/import/errors/error")) {
+ messages.add(((Node) o).getText());
+ }
+
+ return new ArchiveImport(issuccess, messages);
+ }
+}
diff --git a/src/main/java/org/rundeck/api/parser/BaseStateParser.java b/src/main/java/org/rundeck/api/parser/BaseStateParser.java
new file mode 100644
index 0000000..5cd31d1
--- /dev/null
+++ b/src/main/java/org/rundeck/api/parser/BaseStateParser.java
@@ -0,0 +1,42 @@
+package org.rundeck.api.parser;
+
+import org.apache.commons.lang.StringUtils;
+import org.dom4j.Node;
+import org.rundeck.api.domain.BaseState;
+import org.rundeck.api.domain.RundeckWFExecState;
+
+/**
+ * $INTERFACE is ... User: greg Date: 1/17/14 Time: 12:19 PM
+ */
+public class BaseStateParser implements XmlNodeParser {
+ public static void parseBaseState(Node targetNode, BaseState state) {
+ state.setEndTime(WorkflowStateParser.parseDate(StringUtils.trimToNull(targetNode.valueOf("endTime"))));
+ state.setStartTime(WorkflowStateParser.parseDate(StringUtils.trimToNull(targetNode.valueOf("startTime"))));
+ state.setUpdateTime(WorkflowStateParser.parseDate(StringUtils.trimToNull(targetNode.valueOf("updateTime"))));
+
+ try {
+ state.setExecutionState(RundeckWFExecState.valueOf(StringUtils.upperCase(targetNode.valueOf
+ ("executionState"))));
+ } catch (IllegalArgumentException e) {
+ state.setExecutionState(null);
+ }
+ }
+
+ private String xpath;
+
+ public BaseStateParser() {
+ }
+
+ public BaseStateParser(String xpath) {
+
+ this.xpath = xpath;
+ }
+
+ @Override
+ public BaseState parseXmlNode(Node node) {
+ Node targetNode = xpath != null ? node.selectSingleNode(xpath) : node;
+ BaseState baseState = new BaseState();
+ parseBaseState(targetNode, baseState);
+ return baseState;
+ }
+}
diff --git a/src/main/java/org/rundeck/api/parser/BaseXpathParser.java b/src/main/java/org/rundeck/api/parser/BaseXpathParser.java
new file mode 100644
index 0000000..26be541
--- /dev/null
+++ b/src/main/java/org/rundeck/api/parser/BaseXpathParser.java
@@ -0,0 +1,29 @@
+package org.rundeck.api.parser;
+
+import org.dom4j.Node;
+
+/**
+ * BaseXpathParser is ...
+ *
+ * @author Greg Schueler
+ * @since 2014-04-04
+ */
+public abstract class BaseXpathParser implements XmlNodeParser {
+ private String xpath;
+
+ public BaseXpathParser() {
+ }
+
+ public BaseXpathParser(String xpath) {
+
+ this.xpath = xpath;
+ }
+
+ public abstract T parse(Node node);
+
+ @Override
+ public T parseXmlNode(Node node) {
+ Node selectedNode = xpath != null ? node.selectSingleNode(xpath) : node;
+ return parse(selectedNode);
+ }
+}
diff --git a/src/main/java/org/rundeck/api/parser/DeleteExecutionsResponseParser.java b/src/main/java/org/rundeck/api/parser/DeleteExecutionsResponseParser.java
new file mode 100644
index 0000000..c3de8af
--- /dev/null
+++ b/src/main/java/org/rundeck/api/parser/DeleteExecutionsResponseParser.java
@@ -0,0 +1,52 @@
+package org.rundeck.api.parser;
+
+import org.dom4j.Node;
+import org.rundeck.api.domain.DeleteExecutionsResponse;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * DeleteExecutionsResponseParser is ...
+ *
+ * @author Greg Schueler
+ * @since 2014-11-06
+ */
+public class DeleteExecutionsResponseParser implements XmlNodeParser {
+ private String xpath;
+
+ public DeleteExecutionsResponseParser(final String xpath) {
+ this.xpath = xpath;
+ }
+
+ @Override public DeleteExecutionsResponse parseXmlNode(final Node node) {
+ final Node baseNode = xpath != null ? node.selectSingleNode(xpath) : node;
+
+ final DeleteExecutionsResponse response = new DeleteExecutionsResponse();
+ response.setAllsuccessful(Boolean.parseBoolean(baseNode.valueOf("@allsuccessful")));
+ response.setRequestCount(Integer.parseInt(baseNode.valueOf("@requestCount")));
+ response.setSuccessCount(Integer.parseInt(baseNode.valueOf("successful/@count")));
+
+ final Node failedNode = baseNode.selectSingleNode("failed");
+ //parse failures
+ final List failures = new ArrayList
+ ();
+ int failedCount = 0;
+ if (null != failedNode) {
+ failedCount = Integer.parseInt(baseNode.valueOf("failed/@count"));
+ final List list = baseNode.selectNodes("failed/execution");
+
+ for (final Object o : list) {
+ final Node execNode = (Node) o;
+ final DeleteExecutionsResponse.DeleteFailure deleteFailure =
+ new DeleteExecutionsResponse.DeleteFailure();
+ deleteFailure.setExecutionId(Long.parseLong(execNode.valueOf("@id")));
+ deleteFailure.setMessage(execNode.valueOf("@message"));
+ failures.add(deleteFailure);
+ }
+ }
+ response.setFailedCount(failedCount);
+ response.setFailures(failures);
+ return response;
+ }
+}
diff --git a/src/main/java/org/rundeck/api/parser/ExecutionParser.java b/src/main/java/org/rundeck/api/parser/ExecutionParser.java
index 63ea0d1..90a6e8d 100644
--- a/src/main/java/org/rundeck/api/parser/ExecutionParser.java
+++ b/src/main/java/org/rundeck/api/parser/ExecutionParser.java
@@ -15,12 +15,18 @@
*/
package org.rundeck.api.parser;
+import java.util.Collections;
import java.util.Date;
+import java.util.HashSet;
+import java.util.List;
+
import org.apache.commons.lang.StringUtils;
import org.dom4j.Node;
import org.rundeck.api.domain.RundeckExecution;
import org.rundeck.api.domain.RundeckJob;
import org.rundeck.api.domain.RundeckExecution.ExecutionStatus;
+import org.rundeck.api.domain.RundeckNode;
+import org.rundeck.api.domain.RundeckNodeIdentity;
/**
* Parser for a single {@link RundeckExecution}
@@ -76,6 +82,26 @@ public class ExecutionParser implements XmlNodeParser {
execution.setJob(job);
}
+ final Node successfulNodes = execNode.selectSingleNode("successfulNodes");
+ if (successfulNodes != null) {
+ final List rundeckNodes =
+ new ListParser(new NodeParser(), "successfulNodes/node")
+ .parseXmlNode(execNode);
+ execution.setSuccessfulNodes(new HashSet(rundeckNodes));
+ }else{
+ execution.setSuccessfulNodes(Collections.emptySet());
+ }
+
+ final Node failedNodes = execNode.selectSingleNode("failedNodes");
+ if (failedNodes != null) {
+ final List rundeckNodes =
+ new ListParser(new NodeParser(), "failedNodes/node")
+ .parseXmlNode(execNode);
+ execution.setFailedNodes(new HashSet(rundeckNodes));
+ } else {
+ execution.setFailedNodes(Collections.emptySet());
+ }
+
return execution;
}
diff --git a/src/main/java/org/rundeck/api/parser/ExecutionStateParser.java b/src/main/java/org/rundeck/api/parser/ExecutionStateParser.java
new file mode 100644
index 0000000..180b425
--- /dev/null
+++ b/src/main/java/org/rundeck/api/parser/ExecutionStateParser.java
@@ -0,0 +1,60 @@
+package org.rundeck.api.parser;
+
+import org.apache.commons.lang.StringUtils;
+import org.dom4j.Node;
+import org.rundeck.api.domain.*;
+
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+
+/**
+ * $INTERFACE is ... User: greg Date: 1/16/14 Time: 5:42 PM
+ */
+public class ExecutionStateParser implements XmlNodeParser {
+ private String xpath;
+
+ public ExecutionStateParser() {
+ super();
+ }
+
+ /**
+ * @param xpath of the execution element if it is not the root node
+ */
+ public ExecutionStateParser(String xpath) {
+ this();
+ this.xpath = xpath;
+ }
+
+ @Override
+ public RundeckExecutionState parseXmlNode(Node node) {
+ Node targetNode = xpath != null ? node.selectSingleNode(xpath) : node;
+ RundeckExecutionState rundeckExecutionState = new RundeckExecutionState();
+ rundeckExecutionState.setExecutionId(Long.valueOf(targetNode.valueOf("@id")));
+
+ WorkflowStateParser.parseWorkflowState(targetNode, rundeckExecutionState);
+
+
+ final List rundeckNodes =
+ new ListParser(new NodeParser(), "allNodes/nodes/node").parseXmlNode(targetNode);
+ rundeckExecutionState.setAllNodes(new HashSet(rundeckNodes));
+
+
+ //node states
+ HashMap> nodeStates = new HashMap>();
+
+ for (Object o : targetNode.selectNodes("nodes/node")) {
+ final Node nodeStateNode = (Node) o;
+ final String nodeName = StringUtils.trimToNull(nodeStateNode.valueOf("@name"));
+ if (null != nodeName) {
+ ListParser workflowStepStateListParser
+ = new ListParser(new IndexedWorkflowStepStateParser(rundeckExecutionState, nodeName)
+ , "steps/step");
+ nodeStates.put(nodeName, workflowStepStateListParser.parseXmlNode(nodeStateNode));
+ }
+ }
+ rundeckExecutionState.setNodeStates(nodeStates);
+
+ return rundeckExecutionState;
+ }
+}
diff --git a/src/main/java/org/rundeck/api/parser/IndexedWorkflowStepStateParser.java b/src/main/java/org/rundeck/api/parser/IndexedWorkflowStepStateParser.java
new file mode 100644
index 0000000..16f7fd4
--- /dev/null
+++ b/src/main/java/org/rundeck/api/parser/IndexedWorkflowStepStateParser.java
@@ -0,0 +1,61 @@
+package org.rundeck.api.parser;
+
+import org.apache.commons.lang.StringUtils;
+import org.dom4j.Node;
+import org.rundeck.api.domain.WorkflowState;
+import org.rundeck.api.domain.WorkflowStepContextState;
+import org.rundeck.api.domain.WorkflowStepState;
+
+/**
+ * Returns a WorkflowStepContextState by looking up the given Rundeck node's state in the workflow, using the step
+ * context path of the "stepctx" element of the selected DOM node.
+ */
+public class IndexedWorkflowStepStateParser implements XmlNodeParser {
+ private final WorkflowState workflowState;
+ private String rundeckNodeName;
+
+ @Override
+ public WorkflowStepContextState parseXmlNode(final Node node) {
+ //look for workflow step state based on node name and stepctx found on the node
+ final String stepctx = StringUtils.trimToNull(node.valueOf("stepctx"));
+ final WorkflowStepState foundStep = lookupContext(stepctx, workflowState);
+ //look up node state for this node
+ if (null != foundStep
+ && null != foundStep.getNodeStates()
+ && null != foundStep.getNodeStates().get(rundeckNodeName)) {
+ return foundStep.getNodeStates().get(rundeckNodeName);
+ }
+
+
+ return null;
+ }
+
+ /**
+ * look up the workflow step state for the step context, from the root workflow
+ *
+ * @param stepctx
+ * @param initial
+ *
+ * @return
+ */
+ public static WorkflowStepState lookupContext(final String stepctx, final WorkflowState initial) {
+ final String[] parts = stepctx.split("/");
+ //descend workflow steps to find correct step
+ WorkflowState current = initial;
+ WorkflowStepState currentStep = null;
+ for (int i = 0; i < parts.length; i++) {
+ final String part = parts[i];
+ final WorkflowStepState workflowStepState = current.getSteps().get(Integer.parseInt(part) - 1);
+ currentStep = workflowStepState;
+ if (i < parts.length - 1) {
+ current = currentStep.getSubWorkflow();
+ }
+ }
+ return currentStep;
+ }
+
+ public IndexedWorkflowStepStateParser(final WorkflowState workflowState, final String rundeckNodeName) {
+ this.workflowState = workflowState;
+ this.rundeckNodeName = rundeckNodeName;
+ }
+}
diff --git a/src/main/java/org/rundeck/api/parser/OutputEntryParser.java b/src/main/java/org/rundeck/api/parser/OutputEntryParser.java
index 9754377..c5268dc 100644
--- a/src/main/java/org/rundeck/api/parser/OutputEntryParser.java
+++ b/src/main/java/org/rundeck/api/parser/OutputEntryParser.java
@@ -6,6 +6,10 @@ import org.dom4j.Node;
import org.rundeck.api.domain.RundeckOutputEntry;
import org.rundeck.api.domain.RundeckOutputEntry.RundeckLogLevel;
+import java.text.ParseException;
+import java.text.SimpleDateFormat;
+import java.util.*;
+
/**
* Parses output message content for API v6
*/
@@ -16,15 +20,28 @@ public class OutputEntryParser implements XmlNodeParser {
public OutputEntryParser() {
super();
+ dateFormat = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'", Locale.US);
+ dateFormat.setTimeZone(TimeZone.getTimeZone("GMT"));
}
+ private SimpleDateFormat dateFormat;
/**
* @param xpath of the event element if it is not the root node
*/
public OutputEntryParser(String xpath) {
- super();
+ this();
this.xpath = xpath;
}
+ static HashSet nonMetaAttributes = new HashSet();
+ static {
+ nonMetaAttributes.add("time");
+ nonMetaAttributes.add("level");
+ nonMetaAttributes.add("user");
+ nonMetaAttributes.add("node");
+ nonMetaAttributes.add("type");
+ nonMetaAttributes.add("log");
+ nonMetaAttributes.add("absolute_type");
+ }
@Override
public RundeckOutputEntry parseXmlNode(Node node) {
@@ -38,15 +55,44 @@ public class OutputEntryParser implements XmlNodeParser {
} catch (IllegalArgumentException e) {
outputEntry.setLevel(null);
}
+ if(null!=entryNode.valueOf("@absolute_time")) {
+ outputEntry.setAbsoluteTime(parseDate(StringUtils.trimToNull(entryNode.valueOf("@absolute_time"))));
+ }
outputEntry.setUser(StringUtils.trimToNull(entryNode.valueOf("@user")));
- outputEntry.setCommand(StringUtils.trimToNull(entryNode.valueOf("@command")));
outputEntry.setNode(StringUtils.trimToNull(entryNode.valueOf("@node")));
+ outputEntry.setType(StringUtils.trimToNull(entryNode.valueOf("@type")));
+
+ HashMap meta = new HashMap();
+ List list = entryNode.selectNodes("@*");
+ for (Object node1 : list) {
+ if(node1 instanceof Node) {
+ Node child = (Node) node1;
+ if (!nonMetaAttributes.contains(child.getName())) {
+ meta.put(child.getName(), child.getText());
+ }
+ }
+ }
+ if(meta.size()>0){
+ outputEntry.setMetadata(meta);
+ }
outputEntry.setMessage(parseMessage(entryNode));
return outputEntry;
}
+ private Date parseDate(String s) {
+ if(null==s){
+ return null;
+ }
+ try {
+ Date parse = dateFormat.parse(s);
+ return parse;
+ } catch (ParseException e) {
+ return null;
+ }
+ }
+
/**
* Parse the message content
*/
@@ -54,4 +100,4 @@ public class OutputEntryParser implements XmlNodeParser {
return StringUtils.trimToNull(entryNode.valueOf("@log"));
}
-}
\ No newline at end of file
+}
diff --git a/src/main/java/org/rundeck/api/parser/OutputParser.java b/src/main/java/org/rundeck/api/parser/OutputParser.java
index f5fe2a2..bc988e2 100644
--- a/src/main/java/org/rundeck/api/parser/OutputParser.java
+++ b/src/main/java/org/rundeck/api/parser/OutputParser.java
@@ -47,6 +47,7 @@ public class OutputParser implements XmlNodeParser {
output.setCompleted(Boolean.valueOf(entryNode.valueOf("completed")));
output.setExecCompleted(Boolean.valueOf(entryNode.valueOf("execCompleted")));
output.setHasFailedNodes(Boolean.valueOf(entryNode.valueOf("hasFailedNodes")));
+ output.setUnmodified(Boolean.valueOf(entryNode.valueOf("unmodified")));
try {
output.setStatus(RundeckExecution.ExecutionStatus
@@ -78,6 +79,10 @@ public class OutputParser implements XmlNodeParser {
} catch (NumberFormatException e) {
output.setTotalSize(-1);
}
+ if(entryNode.selectSingleNode("filter")!=null){
+ output.setFilterNode(StringUtils.trimToNull(entryNode.valueOf("filter/@nodename")));
+ output.setFilterStep(StringUtils.trimToNull(entryNode.valueOf("filter/@stepctx")));
+ }
Node entriesListNode = entryNode.selectSingleNode("entries");
@@ -93,4 +98,4 @@ public class OutputParser implements XmlNodeParser {
return output;
}
-}
\ No newline at end of file
+}
diff --git a/src/main/java/org/rundeck/api/parser/PagedResultParser.java b/src/main/java/org/rundeck/api/parser/PagedResultParser.java
index 3eed01c..3389a87 100644
--- a/src/main/java/org/rundeck/api/parser/PagedResultParser.java
+++ b/src/main/java/org/rundeck/api/parser/PagedResultParser.java
@@ -26,6 +26,7 @@ package org.rundeck.api.parser;
import org.dom4j.Element;
import org.dom4j.Node;
+import org.rundeck.api.RundeckApiException;
import org.rundeck.api.util.PagedResults;
import java.util.*;
@@ -38,7 +39,7 @@ import java.util.*;
*/
public class PagedResultParser implements XmlNodeParser> {
ListParser itemParser;
- String xpath;
+ private String xpath;
/**
* Create a PagedResultParser
@@ -54,7 +55,9 @@ public class PagedResultParser implements XmlNodeParser> {
@Override
public PagedResults parseXmlNode(Node node) {
Node pagedNodeContainer = node.selectSingleNode(xpath);
-
+ if(null==pagedNodeContainer) {
+ throw new RundeckApiException("XML content did not match XPATH expression: " + xpath);
+ }
Element el = (Element) pagedNodeContainer;
final int max = integerAttribute(el, "max", -1);
final int offset = integerAttribute(el, "offset", -1);
@@ -113,4 +116,8 @@ public class PagedResultParser implements XmlNodeParser> {
}
return parseMax;
}
+
+ public String getXpath() {
+ return xpath;
+ }
}
diff --git a/src/main/java/org/rundeck/api/parser/ProjectConfigParser.java b/src/main/java/org/rundeck/api/parser/ProjectConfigParser.java
new file mode 100644
index 0000000..7e92ffe
--- /dev/null
+++ b/src/main/java/org/rundeck/api/parser/ProjectConfigParser.java
@@ -0,0 +1,43 @@
+package org.rundeck.api.parser;
+
+import org.dom4j.Node;
+import org.rundeck.api.domain.ProjectConfig;
+
+import java.util.List;
+
+/**
+ * ProjectConfigParser parses project "config" element contents
+ *
+ * @author greg
+ * @since 2014-02-27
+ */
+public class ProjectConfigParser implements XmlNodeParser {
+ private String xpath;
+
+ public ProjectConfigParser() {
+ }
+
+ public ProjectConfigParser(String xpath) {
+ this.xpath = xpath;
+ }
+
+ @Override
+ public ProjectConfig parseXmlNode(Node node) {
+ Node config1 = getXpath() != null ? node.selectSingleNode(getXpath()) : node;
+ ProjectConfig config = new ProjectConfig();
+ List property = config1.selectNodes("property");
+ for (Object o : property) {
+ Node propnode = (Node) o;
+ String key = propnode.valueOf("@key");
+ String value = propnode.valueOf("@value");
+ if (null != key && null != value) {
+ config.setProperty(key, value);
+ }
+ }
+ return config;
+ }
+
+ public String getXpath() {
+ return xpath;
+ }
+}
diff --git a/src/main/java/org/rundeck/api/parser/ProjectConfigPropertyParser.java b/src/main/java/org/rundeck/api/parser/ProjectConfigPropertyParser.java
new file mode 100644
index 0000000..9a57114
--- /dev/null
+++ b/src/main/java/org/rundeck/api/parser/ProjectConfigPropertyParser.java
@@ -0,0 +1,41 @@
+package org.rundeck.api.parser;
+
+import org.dom4j.Node;
+import org.rundeck.api.domain.ConfigProperty;
+
+/**
+ * ProjectConfigPropertyParser parses a {@literal {
+ private String xpath;
+
+ public ProjectConfigPropertyParser() {
+ }
+
+ public ProjectConfigPropertyParser(final String xpath) {
+ this.setXpath(xpath);
+ }
+
+ @Override
+ public ConfigProperty parseXmlNode(final Node node) {
+ final Node propnode = getXpath() != null ? node.selectSingleNode(getXpath()) : node;
+ final String key = propnode.valueOf("@key");
+ final String value = propnode.valueOf("@value");
+ final ConfigProperty config = new ConfigProperty();
+ config.setKey(key);
+ config.setValue(value);
+ return config;
+ }
+
+ public String getXpath() {
+ return xpath;
+ }
+
+ public void setXpath(final String xpath) {
+ this.xpath = xpath;
+ }
+}
diff --git a/src/main/java/org/rundeck/api/parser/ProjectParser.java b/src/main/java/org/rundeck/api/parser/ProjectParser.java
index 999ec70..ef6ca13 100644
--- a/src/main/java/org/rundeck/api/parser/ProjectParser.java
+++ b/src/main/java/org/rundeck/api/parser/ProjectParser.java
@@ -42,7 +42,7 @@ public class ProjectParser implements XmlNodeParser {
@Override
public RundeckProject parseXmlNode(Node node) {
- Node projectNode = xpath != null ? node.selectSingleNode(xpath) : node;
+ Node projectNode = getXpath() != null ? node.selectSingleNode(getXpath()) : node;
RundeckProject project = new RundeckProject();
@@ -53,4 +53,7 @@ public class ProjectParser implements XmlNodeParser {
return project;
}
+ protected String getXpath() {
+ return xpath;
+ }
}
diff --git a/src/main/java/org/rundeck/api/parser/ProjectParserV11.java b/src/main/java/org/rundeck/api/parser/ProjectParserV11.java
new file mode 100644
index 0000000..631d941
--- /dev/null
+++ b/src/main/java/org/rundeck/api/parser/ProjectParserV11.java
@@ -0,0 +1,36 @@
+package org.rundeck.api.parser;
+
+import org.dom4j.Node;
+import org.rundeck.api.domain.ProjectConfig;
+import org.rundeck.api.domain.RundeckProject;
+
+import java.util.List;
+
+/**
+ * ProjectParserV11 supports embedded "config" element.
+ *
+ * @author greg
+ * @since 2014-02-27
+ */
+public class ProjectParserV11 extends ProjectParser {
+ public ProjectParserV11() {
+ }
+
+ public ProjectParserV11(final String xpath) {
+ super(xpath);
+ }
+
+ @Override
+ public RundeckProject parseXmlNode(final Node node) {
+ final RundeckProject rundeckProject = super.parseXmlNode(node);
+ final Node projectNode = getXpath() != null ? node.selectSingleNode(getXpath()) : node;
+ final Node config1 = projectNode.selectSingleNode("config");
+ if (config1 == null) {
+ return rundeckProject;
+ }
+
+ rundeckProject.setProjectConfig(new ProjectConfigParser().parseXmlNode(config1));
+
+ return rundeckProject;
+ }
+}
diff --git a/src/main/java/org/rundeck/api/parser/RundeckTokenParser.java b/src/main/java/org/rundeck/api/parser/RundeckTokenParser.java
new file mode 100644
index 0000000..b48543d
--- /dev/null
+++ b/src/main/java/org/rundeck/api/parser/RundeckTokenParser.java
@@ -0,0 +1,33 @@
+package org.rundeck.api.parser;
+
+import org.dom4j.Node;
+import org.rundeck.api.domain.RundeckToken;
+
+/**
+ * RundeckTokenParser is ...
+ *
+ * @author Greg Schueler
+ * @since 2014-04-04
+ */
+public class RundeckTokenParser implements XmlNodeParser {
+ String xpath;
+
+ public RundeckTokenParser() {
+ }
+
+ public RundeckTokenParser(String xpath) {
+ this.xpath = xpath;
+ }
+
+ @Override
+ public RundeckToken parseXmlNode(Node node) {
+ Node targetNode = xpath != null ? node.selectSingleNode(xpath) : node;
+ RundeckToken rundeckToken = new RundeckToken();
+ String token = targetNode.valueOf("@id");
+ String user = targetNode.valueOf("@user");
+ rundeckToken.setToken(token);
+ rundeckToken.setUser(user);
+
+ return rundeckToken;
+ }
+}
diff --git a/src/main/java/org/rundeck/api/parser/SSHKeyResourceParser.java b/src/main/java/org/rundeck/api/parser/SSHKeyResourceParser.java
new file mode 100644
index 0000000..091ab2b
--- /dev/null
+++ b/src/main/java/org/rundeck/api/parser/SSHKeyResourceParser.java
@@ -0,0 +1,25 @@
+package org.rundeck.api.parser;
+
+import org.dom4j.Node;
+import org.rundeck.api.domain.BaseKeyResource;
+import org.rundeck.api.domain.KeyResource;
+
+/**
+ * SSHKeyResourceParser is ...
+ *
+ * @author Greg Schueler
+ * @since 2014-04-04
+ */
+public class SSHKeyResourceParser extends BaseXpathParser implements XmlNodeParser {
+ public SSHKeyResourceParser() {
+ }
+
+ public SSHKeyResourceParser(String xpath) {
+ super(xpath);
+ }
+
+ @Override
+ public KeyResource parse(Node node) {
+ return BaseKeyResource.from(new StorageResourceParser().parse(node));
+ }
+}
diff --git a/src/main/java/org/rundeck/api/parser/StorageResourceParser.java b/src/main/java/org/rundeck/api/parser/StorageResourceParser.java
new file mode 100644
index 0000000..f1c5e6a
--- /dev/null
+++ b/src/main/java/org/rundeck/api/parser/StorageResourceParser.java
@@ -0,0 +1,61 @@
+package org.rundeck.api.parser;
+
+import org.dom4j.Element;
+import org.dom4j.Node;
+import org.rundeck.api.domain.BaseStorageResource;
+import org.rundeck.api.domain.StorageResource;
+
+import java.util.HashMap;
+
+/**
+ * StorageResourceParser is ...
+ *
+ * @author Greg Schueler
+ * @since 2014-04-04
+ */
+public class StorageResourceParser extends BaseXpathParser {
+ private BaseStorageResource holder;
+ public StorageResourceParser() {
+
+ }
+ public StorageResourceParser(BaseStorageResource holder){
+ this.holder=holder;
+ }
+
+ public StorageResourceParser(String xpath) {
+ super(xpath);
+ }
+
+ @Override
+ public StorageResource parse(Node node) {
+ String path = node.valueOf("@path");
+ String type = node.valueOf("@type");
+ String url = node.valueOf("@url");
+ BaseStorageResource storageResource = null == holder ? new BaseStorageResource() : holder;
+ storageResource.setDirectory("directory".equals(type));
+ storageResource.setPath(path);
+ storageResource.setUrl(url);
+
+ if (storageResource.isDirectory()) {
+ if (node.selectSingleNode("contents") != null) {
+ storageResource.setDirectoryContents(new ListParser(new StorageResourceParser(),
+ "contents/resource").parseXmlNode(node));
+ }
+ } else {
+ String name = node.valueOf("@name");
+ storageResource.setName(name);
+
+ Node meta = node.selectSingleNode("resource-meta");
+ HashMap metamap = new HashMap();
+ if (null != meta) {
+ Element metaEl = (Element) meta;
+ for (Object o : metaEl.elements()) {
+ Element sub = (Element) o;
+ metamap.put(sub.getName(), sub.getText().trim());
+ }
+ }
+ storageResource.setMetadata(metamap);
+ }
+ return storageResource;
+ }
+}
diff --git a/src/main/java/org/rundeck/api/parser/WorkflowStateParser.java b/src/main/java/org/rundeck/api/parser/WorkflowStateParser.java
new file mode 100644
index 0000000..36ffe57
--- /dev/null
+++ b/src/main/java/org/rundeck/api/parser/WorkflowStateParser.java
@@ -0,0 +1,83 @@
+package org.rundeck.api.parser;
+
+import org.apache.commons.lang.StringUtils;
+import org.dom4j.Node;
+import org.rundeck.api.domain.*;
+
+import java.text.DateFormat;
+import java.text.ParseException;
+import java.text.SimpleDateFormat;
+import java.util.*;
+
+/**
+ * $INTERFACE is ... User: greg Date: 1/16/14 Time: 5:44 PM
+ */
+public class WorkflowStateParser implements XmlNodeParser {
+ private String xpath;
+
+ public WorkflowStateParser() {
+ }
+
+ public WorkflowStateParser(String xpath) {
+ this();
+ this.xpath = xpath;
+ }
+
+ private static final ThreadLocal w3cDateFormat = new ThreadLocal() {
+ protected DateFormat initialValue() {
+ SimpleDateFormat fmt = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'", Locale.US);
+ fmt.setTimeZone(TimeZone.getTimeZone("GMT"));
+ return fmt;
+ }
+ };
+ public static Date parseDate(String s) {
+ if (null == s) {
+ return null;
+ }
+ try {
+ Date parse = w3cDateFormat.get().parse(s);
+ return parse;
+ } catch (ParseException e) {
+ return null;
+ }
+ }
+
+ private static int integerValue(final String value, final int defValue) {
+ int parseMax = defValue;
+ try {
+ parseMax = null != value ? Integer.parseInt(value) : defValue;
+ } catch (NumberFormatException e) {
+ }
+ return parseMax;
+ }
+
+ @Override
+ public WorkflowState parseXmlNode(Node node) {
+ Node targetNode = xpath != null ? node.selectSingleNode(xpath) : node;
+ WorkflowState state = new WorkflowState();
+ parseWorkflowState(targetNode, state);
+
+
+ return state;
+ }
+
+ /**
+ * Parse the workflow state components from the given dom node
+ * @param targetNode
+ * @param state
+ */
+ public static void parseWorkflowState(Node targetNode, WorkflowState state) {
+ BaseStateParser.parseBaseState(targetNode, state);
+
+ state.setStepCount(integerValue(StringUtils.trimToNull(targetNode.valueOf("stepCount")), 0));
+
+ final List rundeckNodes =
+ new ListParser(new NodeParser(), "targetNodes/nodes/node").parseXmlNode(targetNode);
+ state.setTargetNodes(new HashSet(rundeckNodes));
+
+ //steps
+ state.setSteps(new ListParser(new WorkflowStepStateParser(),
+ "steps/step").parseXmlNode(targetNode));
+ }
+
+}
diff --git a/src/main/java/org/rundeck/api/parser/WorkflowStepContextStateParser.java b/src/main/java/org/rundeck/api/parser/WorkflowStepContextStateParser.java
new file mode 100644
index 0000000..c744cac
--- /dev/null
+++ b/src/main/java/org/rundeck/api/parser/WorkflowStepContextStateParser.java
@@ -0,0 +1,27 @@
+package org.rundeck.api.parser;
+
+import org.dom4j.Node;
+import org.rundeck.api.domain.WorkflowStepContextState;
+import org.rundeck.api.domain.WorkflowStepState;
+
+/**
+ * $INTERFACE is ... User: greg Date: 1/17/14 Time: 12:39 PM
+ */
+public class WorkflowStepContextStateParser implements XmlNodeParser {
+ WorkflowStepContextState inherit;
+
+ public WorkflowStepContextStateParser(WorkflowStepContextState inherit) {
+ this.inherit = inherit;
+ }
+
+ @Override
+ public WorkflowStepContextState parseXmlNode(Node node) {
+ WorkflowStepContextState workflowStepState = new WorkflowStepContextState();
+ if(null!=inherit) {
+ workflowStepState.setStepNum(inherit.getStepNum());
+ workflowStepState.setStepContextId(inherit.getStepContextId());
+ }
+ BaseStateParser.parseBaseState(node, workflowStepState);
+ return workflowStepState;
+ }
+}
diff --git a/src/main/java/org/rundeck/api/parser/WorkflowStepStateParser.java b/src/main/java/org/rundeck/api/parser/WorkflowStepStateParser.java
new file mode 100644
index 0000000..55b6386
--- /dev/null
+++ b/src/main/java/org/rundeck/api/parser/WorkflowStepStateParser.java
@@ -0,0 +1,51 @@
+package org.rundeck.api.parser;
+
+import org.apache.commons.lang.StringUtils;
+import org.dom4j.Node;
+import org.rundeck.api.domain.BaseState;
+import org.rundeck.api.domain.WorkflowStepContextState;
+import org.rundeck.api.domain.WorkflowStepState;
+
+import java.util.HashMap;
+
+/**
+ * $INTERFACE is ... User: greg Date: 1/17/14 Time: 12:09 PM
+ */
+public class WorkflowStepStateParser implements XmlNodeParser {
+ private String xpath;
+
+ public WorkflowStepStateParser(final String xpath) {
+ this.xpath = xpath;
+ }
+
+ public WorkflowStepStateParser() {
+ }
+
+ @Override
+ public WorkflowStepState parseXmlNode(final Node node) {
+ final Node targetNode = xpath != null ? node.selectSingleNode(xpath) : node;
+ final WorkflowStepState state = new WorkflowStepState();
+
+ BaseStateParser.parseBaseState(targetNode, state);
+ state.setStepContextId(StringUtils.trimToNull(targetNode.valueOf("@stepctx")));
+ state.setStepNum(Integer.valueOf(targetNode.valueOf("@id")));
+ state.setNodeStep(Boolean.valueOf(StringUtils.trimToNull(targetNode.valueOf("nodeStep"))));
+ if (Boolean.valueOf(StringUtils.trimToNull(targetNode.valueOf("hasSubworkflow")))) {
+ //parse sub workflow
+ state.setSubWorkflow(new WorkflowStateParser("workflow").parseXmlNode(targetNode));
+ }
+ if (Boolean.valueOf(StringUtils.trimToNull(targetNode.valueOf("nodeStep")))) {
+ //node states
+ final HashMap nodeStates = new HashMap();
+ for (final Object o : targetNode.selectNodes("nodeStates/nodeState")) {
+ final Node nodeStateNode = (Node) o;
+ final String nodeName = StringUtils.trimToNull(nodeStateNode.valueOf("@name"));
+ if (null != nodeName) {
+ nodeStates.put(nodeName, new WorkflowStepContextStateParser(state).parseXmlNode(nodeStateNode));
+ }
+ }
+ state.setNodeStates(nodeStates);
+ }
+ return state;
+ }
+}
diff --git a/src/main/java/org/rundeck/api/util/DocumentContentProducer.java b/src/main/java/org/rundeck/api/util/DocumentContentProducer.java
new file mode 100644
index 0000000..ace7840
--- /dev/null
+++ b/src/main/java/org/rundeck/api/util/DocumentContentProducer.java
@@ -0,0 +1,38 @@
+package org.rundeck.api.util;
+
+import org.apache.http.entity.ContentProducer;
+import org.dom4j.Document;
+import org.dom4j.io.OutputFormat;
+import org.dom4j.io.XMLWriter;
+
+import java.io.IOException;
+import java.io.OutputStream;
+
+/**
+ * DocumentContentProducer writes XML document to a stream
+ *
+ * @author greg
+ * @since 2014-02-27
+ */
+public class DocumentContentProducer implements ContentProducer {
+ Document document;
+ private OutputFormat format;
+
+ public DocumentContentProducer(final Document document, final OutputFormat format) {
+ this.document = document;
+ this.format = format;
+ }
+
+ public DocumentContentProducer(final Document document) {
+ this.document = document;
+ format = new OutputFormat("", false, "UTF-8");
+ }
+
+ @Override
+ public void writeTo(final OutputStream outstream) throws IOException {
+
+ final XMLWriter xmlWriter = new XMLWriter(outstream, format);
+ xmlWriter.write(document);
+ xmlWriter.flush();
+ }
+}
diff --git a/src/site/confluence/download.confluence b/src/site/confluence/download.confluence
index 5929431..b959285 100644
--- a/src/site/confluence/download.confluence
+++ b/src/site/confluence/download.confluence
@@ -7,13 +7,10 @@ The library is hosted on the [Maven Central Repository|http://search.maven.org/]
You can see all versions and download the files with this query : [g:"org.rundeck" AND a:"rundeck-api-java-client"|http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.rundeck%22%20AND%20a%3A%22rundeck-api-java-client%22].
-Alternatively, you can download [releases|https://oss.sonatype.org/content/repositories/releases/org/rundeck/rundeck-api-java-client/] or [snapshots|https://oss.sonatype.org/content/repositories/snapshots/org/rundeck/rundeck-api-java-client/] from [Sonatype Nexus OSS instance|https://oss.sonatype.org/] (which is then synchronized to Maven Central).
+Alternatively, you can download [releases|https://oss.sonatype.org/content/repositories/releases/org/rundeck/rundeck-api-java-client/] from [Sonatype Nexus OSS instance|https://oss.sonatype.org/] (which is then synchronized to Maven Central).
h2. Manual download
If you want to use this library from a [scripting language|./scripting.html], it is often easier to download a single *jar* file with all dependencies included (named "*rundeck-api-java-client-VERSION-jar-with-dependencies.jar *")
-You can download such files on GitHub : [https://github.com/vbehar/rundeck-api-java-client/downloads] (for each release)
-
-You can also download the latest version (not yet released) on Jenkins : [https://rundeck-api-java-client.ci.cloudbees.com/job/master/lastSuccessfulBuild/artifact/target/]
-
+You can download such files on GitHub : [https://github.com/rundeck/rundeck-api-java-client/releases] (for each release)
diff --git a/src/site/confluence/groovy.confluence b/src/site/confluence/groovy.confluence
index 6dc06e5..20fd4d4 100644
--- a/src/site/confluence/groovy.confluence
+++ b/src/site/confluence/groovy.confluence
@@ -1,5 +1,5 @@
-h1. Using the RunDeck API from Groovy scripts
+h1. Using the Rundeck API from Groovy scripts
Here are some examples of what you can do with this lib and a few lines of [Groovy|http://groovy.codehaus.org/].
@@ -11,16 +11,16 @@ Save the following script in a file named "{{rundeck.groovy}}", and execute it w
{code}
// we use Grape (Ivy) to download the lib (and its dependencies) from Maven Central Repository
-@Grab(group='org.rundeck', module='rundeck-api-java-client', version='2.0')
+@Grab(group='org.rundeck', module='rundeck-api-java-client', version='12.0')
import org.rundeck.api.RundeckClient
-rundeck = new RundeckClient("http://localhost:4440", "admin", "admin")
+rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
-println "RunDeck uptime : ${rundeck.systemInfo.uptime}"
-println "All RunDeck projects : ${rundeck.projects}"
-println "All RunDeck nodes : ${rundeck.nodes}"
-println "All RunDeck jobs : ${rundeck.jobs}"
-println "All RunDeck running executions : ${rundeck.runningExecutions}"
+println "Rundeck uptime : ${rundeck.systemInfo.uptime}"
+println "All Rundeck projects : ${rundeck.projects}"
+println "All Rundeck nodes : ${rundeck.nodes}"
+println "All Rundeck jobs : ${rundeck.jobs}"
+println "All Rundeck running executions : ${rundeck.runningExecutions}"
{code}
You can also [download|./download.html] the lib and all its dependencies in 1 big jar file, and add it to your classpath before running your script : save the following script in a file named "{{rundeck.groovy}}", and execute it with "{{groovy -cp /path/to/rundeck-api-java-client-VERSION-jar-with-dependencies.jar rundeck.groovy}}".
@@ -28,34 +28,34 @@ You can also [download|./download.html] the lib and all its dependencies in 1 bi
{code}
import org.rundeck.api.RundeckClient
-rundeck = new RundeckClient("http://localhost:4440", "admin", "admin")
+rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
-println "RunDeck uptime : ${rundeck.systemInfo.uptime}"
-println "All RunDeck projects : ${rundeck.projects}"
-println "All RunDeck nodes : ${rundeck.nodes}"
-println "All RunDeck jobs : ${rundeck.jobs}"
-println "All RunDeck running executions : ${rundeck.runningExecutions}"
+println "Rundeck uptime : ${rundeck.systemInfo.uptime}"
+println "All Rundeck projects : ${rundeck.projects}"
+println "All Rundeck nodes : ${rundeck.nodes}"
+println "All Rundeck jobs : ${rundeck.jobs}"
+println "All Rundeck running executions : ${rundeck.runningExecutions}"
{code}
h2. Authentication
-Starting with RunDeck API 2, there are 2 ways to authenticate :
+Starting with Rundeck API 2, there are 2 ways to authenticate :
* the *login-based authentication* : with your login and password
-* the *token-based authentication* : with a unique token that you can generate from the RunDeck webUI
+* the *token-based authentication* : with a unique token that you can generate from the Rundeck webUI
{code}
-// using login-based authentication (admin/admin is the default login/password for a new RunDeck instance) :
-rundeck = new RundeckClient("http://localhost:4440", "admin", "admin");
+// using login-based authentication (admin/admin is the default login/password for a new Rundeck instance) :
+rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
// using token-based authentication :
-rundeck = new RundeckClient("http://localhost:4440", "PDDNKo5VE29kpk4prOUDr2rsKdRkEvsD");
+rundeck = RundeckClient.builder().url("http://localhost:4440").token("PDDNKo5VE29kpk4prOUDr2rsKdRkEvsD").build()
{code}
h2. Running a job
{code}
import org.rundeck.api.RundeckClient
-rundeck = new RundeckClient("http://localhost:4440", "admin", "admin")
+rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
// find a job from its name, group and project
job = rundeck.findJob("my-project", "main-group/sub-group", "job-name")
@@ -80,9 +80,9 @@ h2. Running an ad-hoc command
{code}
import org.rundeck.api.RundeckClient
-rundeck = new RundeckClient("http://localhost:4440", "admin", "admin")
+rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
-// trigger the execution of the "uptime" command on the RunDeck server
+// trigger the execution of the "uptime" command on the Rundeck server
execution = rundeck.triggerAdhocCommand("my-project", "uptime")
// run the "uptime" command on all unix nodes
@@ -93,9 +93,9 @@ h2. Running an ad-hoc script
{code}
import org.rundeck.api.RundeckClient
-rundeck = new RundeckClient("http://localhost:4440", "admin", "admin")
+rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
-// trigger the execution of a custom bash script on the RunDeck server
+// trigger the execution of a custom bash script on the Rundeck server
execution = rundeck.triggerAdhocScript("my-project", "/tmp/my-script.sh")
// run a bash script (with options) on all unix nodes
@@ -106,7 +106,7 @@ h2. Exporting jobs
{code}
import org.rundeck.api.RundeckClient
-rundeck = new RundeckClient("http://localhost:4440", "admin", "admin")
+rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
rundeck.exportJobsToFile("/tmp/jobs.xml", "xml", "my-project")
rundeck.exportJobToFile("/tmp/job.yaml", "yaml", "job-id")
@@ -116,7 +116,7 @@ h2. Importing jobs
{code}
import org.rundeck.api.RundeckClient
-rundeck = new RundeckClient("http://localhost:4440", "admin", "admin")
+rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
result = rundeck.importJobs("/tmp/jobs.xml", "xml")
println "${result.succeededJobs.size} jobs successfully imported, ${result.skippedJobs.size} jobs skipped, and ${result.failedJobs.size} jobs failed"
@@ -124,5 +124,5 @@ println "${result.succeededJobs.size} jobs successfully imported, ${result.skipp
h2. And more...
-See the API documentation of the [RundeckClient|./apidocs/reference/org/rundeck/api/RundeckClient.html] class for more interactions with your RunDeck instance...
+See the API documentation of the [RundeckClient|./apidocs/reference/org/rundeck/api/RundeckClient.html] class for more interactions with your Rundeck instance...
diff --git a/src/site/confluence/jruby.confluence b/src/site/confluence/jruby.confluence
index cedb4ae..d761a36 100644
--- a/src/site/confluence/jruby.confluence
+++ b/src/site/confluence/jruby.confluence
@@ -1,5 +1,5 @@
-h1. Using the RunDeck API from JRuby scripts
+h1. Using the Rundeck API from JRuby scripts
Here are some examples of what you can do with this lib and a few lines of [Ruby|http://www.jruby.org/] (for the rubyist that don't fear running on the JVM !)
@@ -14,13 +14,13 @@ require 'java'
require '/path/to/rundeck-api-java-client-VERSION-jar-with-dependencies.jar'
import org.rundeck.api.RundeckClient
-rundeck = RundeckClient.new("http://localhost:4440", "admin", "admin")
+rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
-puts "RunDeck uptime : #{rundeck.systemInfo.uptime}"
-puts "All RunDeck projects : #{rundeck.projects}"
-puts "All RunDeck nodes : #{rundeck.nodes}"
-puts "All RunDeck jobs : #{rundeck.jobs}"
-puts "All RunDeck running executions : #{rundeck.runningExecutions}"
+puts "Rundeck uptime : #{rundeck.systemInfo.uptime}"
+puts "All Rundeck projects : #{rundeck.projects}"
+puts "All Rundeck nodes : #{rundeck.nodes}"
+puts "All Rundeck jobs : #{rundeck.jobs}"
+puts "All Rundeck running executions : #{rundeck.runningExecutions}"
{code}
You can also add the library to the classpath : save the following script in a file named "{{rundeck.rb}}", and execute it with "{{jruby -rjava -J-cp /path/to/rundeck-api-java-client-VERSION-jar-with-dependencies.jar rundeck.rb}}".
@@ -28,27 +28,27 @@ You can also add the library to the classpath : save the following script in a f
{code}
import org.rundeck.api.RundeckClient
-rundeck = RundeckClient.new("http://localhost:4440", "admin", "admin")
+rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
-puts "RunDeck uptime : #{rundeck.systemInfo.uptime}"
-puts "All RunDeck projects : #{rundeck.projects}"
-puts "All RunDeck nodes : #{rundeck.nodes}"
-puts "All RunDeck jobs : #{rundeck.jobs}"
-puts "All RunDeck running executions : #{rundeck.runningExecutions}"
+puts "Rundeck uptime : #{rundeck.systemInfo.uptime}"
+puts "All Rundeck projects : #{rundeck.projects}"
+puts "All Rundeck nodes : #{rundeck.nodes}"
+puts "All Rundeck jobs : #{rundeck.jobs}"
+puts "All Rundeck running executions : #{rundeck.runningExecutions}"
{code}
h2. Authentication
-Starting with RunDeck API 2, there are 2 ways to authenticate :
+Starting with Rundeck API 2, there are 2 ways to authenticate :
* the *login-based authentication* : with your login and password
-* the *token-based authentication* : with a unique token that you can generate from the RunDeck webUI
+* the *token-based authentication* : with a unique token that you can generate from the Rundeck webUI
{code}
-// using login-based authentication (admin/admin is the default login/password for a new RunDeck instance) :
-rundeck = RundeckClient.new("http://localhost:4440", "admin", "admin");
+// using login-based authentication (admin/admin is the default login/password for a new Rundeck instance) :
+rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
// using token-based authentication :
-rundeck = RundeckClient.new("http://localhost:4440", "PDDNKo5VE29kpk4prOUDr2rsKdRkEvsD");
+rundeck = RundeckClient.builder().url("http://localhost:4440").token("PDDNKo5VE29kpk4prOUDr2rsKdRkEvsD").build()
{code}
h2. Running a job
@@ -58,7 +58,7 @@ import org.rundeck.api.RundeckClient
import org.rundeck.api.OptionsBuilder
import org.rundeck.api.NodeFiltersBuilder
-rundeck = RundeckClient.new("http://localhost:4440", "admin", "admin")
+rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
// find a job from its name, group and project
job = rundeck.findJob("my-project", "main-group/sub-group", "job-name")
@@ -85,9 +85,9 @@ h2. Running an ad-hoc command
import org.rundeck.api.RundeckClient
import org.rundeck.api.NodeFiltersBuilder
-rundeck = RundeckClient.new("http://localhost:4440", "admin", "admin")
+rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
-// trigger the execution of the "uptime" command on the RunDeck server
+// trigger the execution of the "uptime" command on the Rundeck server
execution = rundeck.triggerAdhocCommand("my-project", "uptime")
// run the "uptime" command on all unix nodes
@@ -101,9 +101,9 @@ import org.rundeck.api.RundeckClient
import org.rundeck.api.OptionsBuilder
import org.rundeck.api.NodeFiltersBuilder
-rundeck = RundeckClient.new("http://localhost:4440", "admin", "admin")
+rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
-// trigger the execution of a custom bash script on the RunDeck server
+// trigger the execution of a custom bash script on the Rundeck server
execution = rundeck.triggerAdhocScript("my-project", "/tmp/my-script.sh")
// run a bash script (with options) on all unix nodes
@@ -114,7 +114,7 @@ h2. Exporting jobs
{code}
import org.rundeck.api.RundeckClient
-rundeck = RundeckClient.new("http://localhost:4440", "admin", "admin")
+rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
rundeck.exportJobsToFile("/tmp/jobs.xml", "xml", "my-project")
rundeck.exportJobToFile("/tmp/job.yaml", "yaml", "job-id")
@@ -124,7 +124,7 @@ h2. Importing jobs
{code}
import org.rundeck.api.RundeckClient
-rundeck = RundeckClient.new("http://localhost:4440", "admin", "admin")
+rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
result = rundeck.importJobs("/tmp/jobs.xml", "xml")
puts "#{result.succeededJobs.size} jobs successfully imported, #{result.skippedJobs.size} jobs skipped, and #{result.failedJobs.size} jobs failed"
@@ -132,5 +132,5 @@ puts "#{result.succeededJobs.size} jobs successfully imported, #{result.skippedJ
h2. And more...
-See the API documentation of the [RundeckClient|./apidocs/reference/org/rundeck/api/RundeckClient.html] class for more interactions with your RunDeck instance...
+See the API documentation of the [RundeckClient|./apidocs/reference/org/rundeck/api/RundeckClient.html] class for more interactions with your Rundeck instance...
diff --git a/src/site/confluence/jython.confluence b/src/site/confluence/jython.confluence
index b2dbc94..8e8bb0d 100644
--- a/src/site/confluence/jython.confluence
+++ b/src/site/confluence/jython.confluence
@@ -1,5 +1,5 @@
-h1. Using the RunDeck API from Jython scripts
+h1. Using the Rundeck API from Jython scripts
Here are some examples of what you can do with this lib and a few lines of [Python|http://www.jython.org/] (for the pythonist that don't fear running on the JVM !)
@@ -12,27 +12,27 @@ Save the following script in a file named "{{rundeck.py}}", and execute it with
{code}
from org.rundeck.api import RundeckClient
-rundeck = RundeckClient("http://localhost:4440", "admin", "admin")
+rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
-print("RunDeck uptime : %s" % rundeck.systemInfo.uptime)
-print("All RunDeck projects : %s" % rundeck.projects)
-print("All RunDeck nodes : %s" % rundeck.nodes)
-print("All RunDeck jobs : %s" % rundeck.jobs)
-print("All RunDeck running executions : %s" % rundeck.runningExecutions)
+print("Rundeck uptime : %s" % rundeck.systemInfo.uptime)
+print("All Rundeck projects : %s" % rundeck.projects)
+print("All Rundeck nodes : %s" % rundeck.nodes)
+print("All Rundeck jobs : %s" % rundeck.jobs)
+print("All Rundeck running executions : %s" % rundeck.runningExecutions)
{code}
h2. Authentication
-Starting with RunDeck API 2, there are 2 ways to authenticate :
+Starting with Rundeck API 2, there are 2 ways to authenticate :
* the *login-based authentication* : with your login and password
-* the *token-based authentication* : with a unique token that you can generate from the RunDeck webUI
+* the *token-based authentication* : with a unique token that you can generate from the Rundeck webUI
{code}
-// using login-based authentication (admin/admin is the default login/password for a new RunDeck instance) :
-rundeck = RundeckClient("http://localhost:4440", "admin", "admin");
+// using login-based authentication (admin/admin is the default login/password for a new Rundeck instance) :
+rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
// using token-based authentication :
-rundeck = RundeckClient("http://localhost:4440", "PDDNKo5VE29kpk4prOUDr2rsKdRkEvsD");
+rundeck = RundeckClient.builder().url("http://localhost:4440").token("PDDNKo5VE29kpk4prOUDr2rsKdRkEvsD").build()
{code}
h2. Running a job
@@ -42,7 +42,7 @@ from org.rundeck.api import RundeckClient
from org.rundeck.api import OptionsBuilder
from org.rundeck.api import NodeFiltersBuilder
-rundeck = RundeckClient("http://localhost:4440", "admin", "admin")
+rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
// find a job from its name, group and project
job = rundeck.findJob("my-project", "main-group/sub-group", "job-name")
@@ -69,9 +69,9 @@ h2. Running an ad-hoc command
from org.rundeck.api import RundeckClient
from org.rundeck.api import NodeFiltersBuilder
-rundeck = RundeckClient("http://localhost:4440", "admin", "admin")
+rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
-// trigger the execution of the "uptime" command on the RunDeck server
+// trigger the execution of the "uptime" command on the Rundeck server
execution = rundeck.triggerAdhocCommand("my-project", "uptime")
// run the "uptime" command on all unix nodes
@@ -85,9 +85,9 @@ from org.rundeck.api import RundeckClient
from org.rundeck.api import OptionsBuilder
from org.rundeck.api import NodeFiltersBuilder
-rundeck = RundeckClient("http://localhost:4440", "admin", "admin")
+rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
-// trigger the execution of a custom bash script on the RunDeck server
+// trigger the execution of a custom bash script on the Rundeck server
execution = rundeck.triggerAdhocScript("my-project", "/tmp/my-script.sh")
// run a bash script (with options) on all unix nodes
@@ -98,7 +98,7 @@ h2. Exporting jobs
{code}
from org.rundeck.api import RundeckClient
-rundeck = RundeckClient("http://localhost:4440", "admin", "admin")
+rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
rundeck.exportJobsToFile("/tmp/jobs.xml", "xml", "my-project")
rundeck.exportJobToFile("/tmp/job.yaml", "yaml", "job-id")
@@ -108,7 +108,7 @@ h2. Importing jobs
{code}
from org.rundeck.api import RundeckClient
-rundeck = RundeckClient("http://localhost:4440", "admin", "admin")
+rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
result = rundeck.importJobs("/tmp/jobs.xml", "xml")
print("%s jobs successfully imported, %s jobs skipped, and %s jobs failed" % (result.succeededJobs.size, result.skippedJobs.size, result.failedJobs.size))
@@ -116,5 +116,5 @@ print("%s jobs successfully imported, %s jobs skipped, and %s jobs failed" % (re
h2. And more...
-See the API documentation of the [RundeckClient|./apidocs/reference/org/rundeck/api/RundeckClient.html] class for more interactions with your RunDeck instance...
+See the API documentation of the [RundeckClient|./apidocs/reference/org/rundeck/api/RundeckClient.html] class for more interactions with your Rundeck instance...
diff --git a/src/site/confluence/status.confluence b/src/site/confluence/status.confluence
index 4807a5c..df82d52 100644
--- a/src/site/confluence/status.confluence
+++ b/src/site/confluence/status.confluence
@@ -1,9 +1,9 @@
-h1. Status of the implementation of the RunDeck API
+h1. Status of the implementation of the Rundeck API
-h2. RunDeck API version 1
+h2. Rundeck API version 1
-[Documentation of the RunDeck API version 1|http://rundeck.org/1.2.1/RunDeck-Guide.html#rundeck-api]
+[Documentation of the Rundeck API version 1|http://rundeck.org/1.2.1/Rundeck-Guide.html#rundeck-api]
* Login-based authentication - OK
* System Info - OK
@@ -26,60 +26,98 @@ h2. RunDeck API version 1
* Listing Resources - OK
* Getting Resource Info - OK
-h2. RunDeck API version 2
+h2. Rundeck API version 2
-[Documentation of the RunDeck API version 2|http://rundeck.org/1.3.2/api/index.html]
+[Documentation of the Rundeck API version 2|http://rundeck.org/1.3.2/api/index.html]
* Token-based authentication - OK
* Listing Jobs for a Project - *TODO*
* Updating and Listing Resources for a Project - *TODO*
* Refreshing Resources for a Project - *TODO*
-h2. RunDeck API version 3
+h2. Rundeck API version 3
-[Documentation of the RunDeck API version 3|http://rundeck.org/1.4.2/api/index.html]
+[Documentation of the Rundeck API version 3|http://rundeck.org/1.4.2/api/index.html]
* (only updates to Resource endpoints) - *TODO*
-h2. RunDeck API version 4
+h2. Rundeck API version 4
-[Documentation of the RunDeck API version 4|http://rundeck.org/1.4.3/api/index.html]
+[Documentation of the Rundeck API version 4|http://rundeck.org/1.4.3/api/index.html]
* Running Adhoc Script URLs - *TODO*
-h2. RunDeck API version 5
+h2. Rundeck API version 5
-[Documentation of the RunDeck API version 5|http://rundeck.org/1.4.4/api/index.html]
+[Documentation of the Rundeck API version 5|http://rundeck.org/1.4.4/api/index.html]
* Bulk Job Delete - OK
* Execution Output - OK
* Execution Query - OK
* History list query - OK
-h2. RunDeck API version 6
+h2. Rundeck API version 6
-[Documentation of the RunDeck API version 6|http://rundeck.org/1.5/api/index.html]
+[Documentation of the Rundeck API version 6|http://rundeck.org/1.5/api/index.html]
* Execution Output format fixed - OK
-h2. RunDeck API version 7
+h2. Rundeck API version 7
-[Documentation of the RunDeck API version 7|http://rundeck.org/1.5.3/api/index.html]
+[Documentation of the Rundeck API version 7|http://rundeck.org/1.5.3/api/index.html]
* Incubator for cluster mode job takeover - *TODO*
-h2. RunDeck API version 8
+h2. Rundeck API version 8
-[Documentation of the RunDeck API version 8|http://rundeck.org/1.6.0/api/index.html]
+[Documentation of the Rundeck API version 8|http://rundeck.org/1.6.0/api/index.html]
* scriptInterpreter addition to run script and run url - OK
* project parameter added to jobs import - OK
-h2. RunDeck API version 9
+h2. Rundeck API version 9
-[Documentation of the RunDeck API version 9|http://rundeck.org/1.6.1/api/index.html]
+[Documentation of the Rundeck API version 9|http://rundeck.org/1.6.1/api/index.html]
* list running executions across all projects - OK
* include project name in execution results - OK
* Add uuidOption parameter to allow removing imported UUIDs to avoid creation conflicts - OK
+
+h2. Rundeck API version 10
+
+[Documentation of the Rundeck API version 10|http://rundeck.org/2.0.0/api/index.html]
+
+* Execution State - Retrieve workflow step and node state information - OK
+* Execution Output with State - Retrieve log output with state change information - OK
+* Execution Output - Retrieve log output for a particular node or step - OK
+* Execution Info - added successfulNodes and failedNodes detail. - OK
+* Deprecation: Remove methods deprecated until version 10. - OK
+
+
+h2. Rundeck API version 11
+
+[Documentation of the Rundeck API version 11|http://rundeck.org/2.1.0/api/index.html]
+
+* Project creation - OK
+* Get Project configuration - OK
+* Set Project configuration - OK
+* Get/Set Project configuration keys - OK
+* Delete project - OK
+* Export project archive - OK
+* Import project archive - OK
+* Key file upload - OK
+* Key file delete - OK
+* Key file list - OK
+* Key file get - OK
+* API Token create - OK
+* API Token list - OK
+* API Token delete - OK
+
+h2. Rundeck API version 12
+
+[Documentation of the Rundeck API version 12|http://rundeck.org/2.2.0/api/index.html]
+
+* Bulk delete executions - OK
+* Delete execution - OK
+* Delete all executions for a job - OK
diff --git a/src/site/site.xml b/src/site/site.xml
index 2e2843a..db7f566 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -28,8 +28,8 @@
-
diff --git a/src/test/java/org/rundeck/api/ExecutionQueryParametersTest.java b/src/test/java/org/rundeck/api/ExecutionQueryParametersTest.java
new file mode 100644
index 0000000..dad5254
--- /dev/null
+++ b/src/test/java/org/rundeck/api/ExecutionQueryParametersTest.java
@@ -0,0 +1,54 @@
+package org.rundeck.api;
+
+import junit.framework.Assert;
+import org.junit.Test;
+import org.rundeck.api.query.ExecutionQuery;
+
+import java.util.Arrays;
+import java.util.Date;
+
+/**
+ * ExecutionQueryParametersTest is ...
+ *
+ * @author Greg Schueler
+ * @since 2014-11-07
+ */
+public class ExecutionQueryParametersTest {
+
+ @Test
+ public void stringParameter() {
+ ExecutionQuery.Builder description = ExecutionQuery.builder().description("a description");
+ ExecutionQueryParameters executionQueryParameters = new ExecutionQueryParameters(
+ description.build()
+ );
+ ApiPathBuilder param = new ApiPathBuilder("").param(executionQueryParameters);
+ Assert.assertEquals("?descFilter=a+description", param.toString());
+ }
+ @Test
+ public void listParameter() {
+ ExecutionQuery.Builder description = ExecutionQuery.builder().excludeJobList(
+ Arrays.asList(
+ "a",
+ "b"
+ )
+ );
+ ExecutionQueryParameters executionQueryParameters = new ExecutionQueryParameters(
+ description.build()
+ );
+ ApiPathBuilder param = new ApiPathBuilder("").param(executionQueryParameters);
+ Assert.assertEquals("?excludeJobListFilter=a&excludeJobListFilter=b", param.toString());
+ }
+ @Test
+ public void dateParameter() {
+ ExecutionQuery.Builder description = ExecutionQuery.builder().end(
+ new Date(1347581178168L)
+ );
+ ExecutionQueryParameters executionQueryParameters = new ExecutionQueryParameters(
+ description.build()
+ );
+ ApiPathBuilder param = new ApiPathBuilder("").param(executionQueryParameters);
+ //nb: timezone should be GMT
+ //2012-09-14T00:06:18Z
+ Assert.assertEquals("?end=2012-09-14T00%3A06%3A18Z", param.toString());
+ }
+}
diff --git a/src/test/java/org/rundeck/api/RundeckClientTest.java b/src/test/java/org/rundeck/api/RundeckClientTest.java
index c5330be..04211f6 100644
--- a/src/test/java/org/rundeck/api/RundeckClientTest.java
+++ b/src/test/java/org/rundeck/api/RundeckClientTest.java
@@ -19,6 +19,7 @@ import betamax.Betamax;
import betamax.MatchRule;
import betamax.Recorder;
import betamax.TapeMode;
+import org.apache.commons.io.IOUtils;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Rule;
@@ -27,8 +28,7 @@ import org.rundeck.api.domain.*;
import org.rundeck.api.query.ExecutionQuery;
import org.rundeck.api.util.PagedResults;
-import java.io.ByteArrayInputStream;
-import java.io.InputStream;
+import java.io.*;
import java.util.*;
@@ -55,6 +55,8 @@ public class RundeckClientTest {
public static final String TEST_TOKEN_4 = "sN5RRSNvu15DnV6EcNDdc2CkdPcv3s32";
public static final String TEST_TOKEN_5 = "C3O6d5O98Kr6Dpv71sdE4ERdCuU12P6d";
public static final String TEST_TOKEN_6 = "Do4d3NUD5DKk21DR4sNK755RcPk618vn";
+ public static final String TEST_TOKEN_7 = "8Dp9op111ER6opsDRkddvE86K9sE499s";
+ public static final String TEST_TOKEN_8 = "GG7uj1y6UGahOs7QlmeN2sIwz1Y2j7zI";
@Rule
public Recorder recorder = new Recorder();
@@ -82,6 +84,131 @@ public class RundeckClientTest {
Assert.assertNull(projects.get(0).getDescription());
}
@Test
+ @Betamax(tape = "create_projectv11")
+ public void createProject() throws Exception {
+
+ RundeckProject project = createClient(TEST_TOKEN_6,11).createProject("monkey1", null);
+ Assert.assertEquals("monkey1", project.getName());
+ Assert.assertEquals(null, project.getDescription());
+ Assert.assertNotNull(project.getProjectConfig());
+
+ }
+ @Test
+ @Betamax(tape = "delete_projectv11")
+ public void deleteProject() throws Exception {
+ RundeckClient client1 = createClient(TEST_TOKEN_6, 11);
+ client1.deleteProject("delete_me");
+ RundeckProject delete_me = null;
+ try {
+ delete_me = client1.getProject("delete_me");
+ Assert.fail();
+ } catch (RundeckApiException.RundeckApiHttpStatusException e) {
+ Assert.assertEquals(404,e.getStatusCode());
+ }
+
+ }
+
+ @Test
+ @Betamax(tape = "get_project_configv11")
+ public void getProjectConfig() throws Exception {
+ ProjectConfig config = createClient(TEST_TOKEN_6, 11).getProjectConfig("monkey1");
+ Assert.assertNotNull(config);
+ Assert.assertNotNull(config.getProperties());
+ Assert.assertEquals(9,config.getProperties().size());
+ Assert.assertEquals("monkey1", config.getProperties().get("project.name"));
+ }
+ @Test
+ @Betamax(tape = "set_project_configv11")
+ public void setProjectConfig() throws Exception {
+ HashMap config = new HashMap();
+ config.put("alphabetty", "spaghetti");
+ config.put("blha.blee", "a big amazing thingy so there.");
+ ProjectConfig result = createClient(TEST_TOKEN_6, 11).setProjectConfig("monkey1", config);
+ Assert.assertNotNull(result);
+ Assert.assertNotNull(result.getProperties());
+ Assert.assertEquals(3, result.getProperties().size());
+ Assert.assertEquals("monkey1", result.getProperties().get("project.name"));
+ Assert.assertEquals("spaghetti", result.getProperties().get("alphabetty"));
+ Assert.assertEquals("a big amazing thingy so there.", result.getProperties().get("blha.blee"));
+ }
+
+ @Test
+ @Betamax(tape = "get_project_config_keyedv11")
+ public void getProjectConfigKeyed() throws Exception {
+ String value = createClient(TEST_TOKEN_6, 11).getProjectConfig("ABC", "project.name");
+ Assert.assertNotNull(value);
+ Assert.assertEquals("ABC", value);
+ }
+ @Test
+ @Betamax(tape = "get_project_config_keyed_dne_v11")
+ public void getProjectConfigKeyedDNE() throws Exception {
+ String value = createClient(TEST_TOKEN_6, 11).getProjectConfig("ABC", "does-not-exist");
+ Assert.assertNull(value);
+ }
+ @Test
+ @Betamax(tape = "set_project_config_keyedv11")
+ public void setProjectConfigKeyed() throws Exception {
+ String value = createClient(TEST_TOKEN_6, 11).setProjectConfig("ABC", "monkey-burrito", "lemon pie");
+ Assert.assertNotNull(value);
+ Assert.assertEquals("lemon pie", value);
+ }
+ @Test
+ @Betamax(tape = "delete_project_config_keyedv11")
+ public void deleteProjectConfigKeyed() throws Exception {
+ RundeckClient client1 = createClient(TEST_TOKEN_6, 11);
+ Assert.assertEquals("7up", client1.setProjectConfig("ABC", "monkey-burrito", "7up"));
+ client1.deleteProjectConfig("ABC", "monkey-burrito");
+ String value=client1.getProjectConfig("ABC", "monkey-burrito");
+ Assert.assertNull(value);
+ }
+ @Test
+ @Betamax(tape = "export_projectv11")
+ public void exportProject() throws Exception {
+ RundeckClient client1 = createClient(TEST_TOKEN_6, 11);
+ File temp = File.createTempFile("test-archive", ".zip");
+ temp.deleteOnExit();
+ int i = client1.exportProject("DEF1", temp);
+ Assert.assertEquals(8705, i);
+ }
+ @Test
+ @Betamax(tape = "import_project_suv11",mode = TapeMode.READ_ONLY)
+ public void importProjectSuccess() throws Exception {
+ RundeckClient client1 = createClient(TEST_TOKEN_6, 11);
+ InputStream resourceAsStream = getClass().getResourceAsStream("test-archive.zip");
+ File temp = File.createTempFile("test-archive", ".zip");
+ temp.deleteOnExit();
+ IOUtils.copy(resourceAsStream, new FileOutputStream(temp));
+ ArchiveImport def1 = client1.importArchive("DEF2", temp, true, true);
+ Assert.assertTrue(def1.isSuccessful());
+ Assert.assertEquals(0, def1.getErrorMessages().size());
+
+ ArchiveImport def2 = client1.importArchive("DEF2", temp, false, true);
+ Assert.assertTrue(def2.isSuccessful());
+ Assert.assertEquals(0, def2.getErrorMessages().size());
+
+ ArchiveImport def3 = client1.importArchive("DEF2", temp, true, false);
+ Assert.assertTrue(def3.isSuccessful());
+ Assert.assertEquals(0, def3.getErrorMessages().size());
+ temp.delete();
+ }
+ @Test
+ @Betamax(tape = "import_project_failure_v11", mode = TapeMode.READ_ONLY)
+ public void importProjectFailure() throws Exception {
+ RundeckClient client1 = createClient(TEST_TOKEN_6, 11);
+ InputStream resourceAsStream = getClass().getResourceAsStream("test-archive.zip");
+ File temp = File.createTempFile("test-archive", ".zip");
+ temp.deleteOnExit();
+ IOUtils.copy(resourceAsStream, new FileOutputStream(temp));
+ ArchiveImport def1 = client1.importArchive("DEF1", temp, false, true);
+ Assert.assertFalse(def1.isSuccessful());
+ Assert.assertEquals(10, def1.getErrorMessages().size());
+ Assert.assertEquals("Job at index [1] at archive path: " +
+ "rundeck-DEF1/jobs/job-6fd1808c-eafb-49ac-abf2-4de7ec75872f.xml had errors: Validation errors: Cannot" +
+ " create a Job with UUID 6fd1808c-eafb-49ac-abf2-4de7ec75872f: a Job already exists with this UUID. " +
+ "Change the UUID or delete the other Job.", def1.getErrorMessages().get(0));
+
+ }
+ @Test
@Betamax(tape = "get_history")
public void getHistory() throws Exception {
final RundeckHistory test = client.getHistory("test");
@@ -148,7 +275,47 @@ public class RundeckClientTest {
}
Assert.assertEquals(Arrays.asList("bob"), names);
}
+ @Test
+ @Betamax(tape="get_execution")
+ public void getExecution() throws Exception{
+ RundeckClient client = createClient(TEST_TOKEN_7, 5);
+ RundeckExecution execution = client.getExecution(945L);
+ Assert.assertEquals("echo test trigger_adhoc_command", execution.getDescription());
+ Assert.assertEquals("2 seconds", execution.getDuration());
+ Assert.assertEquals("test", execution.getProject());
+ Assert.assertEquals("admin", execution.getStartedBy());
+ Assert.assertEquals(null, execution.getJob());
+ Assert.assertEquals(null, execution.getAbortedBy());
+ }
+ @Test
+ @Betamax(tape="get_execution_v11")
+ public void getExecution_v11() throws Exception{
+ RundeckClient client = createClient(TEST_TOKEN_7, 11);
+ RundeckExecution execution = client.getExecution(945L);
+ Assert.assertEquals("echo test trigger_adhoc_command", execution.getDescription());
+ Assert.assertEquals("2 seconds", execution.getDuration());
+ Assert.assertEquals("test", execution.getProject());
+ Assert.assertEquals("admin", execution.getStartedBy());
+ Assert.assertEquals(null, execution.getJob());
+ Assert.assertEquals(null, execution.getAbortedBy());
+ }
+ /**
+ * Test incorrect <result> wrapper is handled correctly
+ * @throws Exception
+ */
+ @Test
+ @Betamax(tape="get_execution_v11_buggy")
+ public void getExecution_v11_buggy() throws Exception{
+ RundeckClient client = createClient(TEST_TOKEN_7, 11);
+ RundeckExecution execution = client.getExecution(945L);
+ Assert.assertEquals("echo test trigger_adhoc_command", execution.getDescription());
+ Assert.assertEquals("2 seconds", execution.getDuration());
+ Assert.assertEquals("test", execution.getProject());
+ Assert.assertEquals("admin", execution.getStartedBy());
+ Assert.assertEquals(null, execution.getJob());
+ Assert.assertEquals(null, execution.getAbortedBy());
+ }
@Test
@Betamax(tape = "get_executions",
mode = TapeMode.READ_ONLY,
@@ -275,6 +442,132 @@ public class RundeckClientTest {
.build(), 2L, 0L);
assertPageResults(adhocTest, 2, 2, 2, 0, 2);
}
+ @Test
+ @Betamax(tape = "get_executions_v11",
+ mode = TapeMode.READ_ONLY,
+ match = {MatchRule.uri, MatchRule.headers, MatchRule.method, MatchRule.path, MatchRule.query})
+ public void getExecutionsV11() throws Exception {
+
+ RundeckClient client = createClient(TEST_TOKEN_7, 11);
+
+
+ final String projectName = "blah";
+ final PagedResults jobTest = client.getExecutions(ExecutionQuery.builder()
+ .project(projectName)
+ .job("test job")
+ .build(),
+ 2L,
+ 0L);
+ assertPageResults(jobTest, 2, 2, 2, 0, 2);
+ final PagedResults jobExactTest = client.getExecutions(ExecutionQuery.builder()
+ .project(projectName)
+ .jobExact("test job")
+ .build(),
+ 2L,
+ 0L);
+ assertPageResults(jobExactTest, 2, 2, 2, 0, 2);
+ final PagedResults excludeJobTest = client.getExecutions(ExecutionQuery.builder()
+ .project(projectName)
+ .excludeJob("test job")
+ .build(),
+ 2L,
+ 0L);
+ assertPageResults(excludeJobTest, 2, 2, 2, 0, 2);
+ final PagedResults excludeJobExactTest = client.getExecutions(ExecutionQuery.builder()
+ .project(projectName)
+ .excludeJobExact("test job")
+ .build(),
+ 2L,
+ 0L);
+ assertPageResults(excludeJobExactTest, 2, 2, 2, 0, 2);
+ final PagedResults descriptionTest = client.getExecutions(ExecutionQuery.builder()
+ .project(projectName)
+ .description("a description")
+ .build(), 2L, 0L);
+ assertPageResults(descriptionTest, 2, 2, 2, 0, 2);
+ final PagedResults abortedbyTest = client.getExecutions(ExecutionQuery.builder()
+ .project(projectName)
+ .abortedby("admin")
+ .build(),
+ 2L,
+ 0L);
+ assertPageResults(abortedbyTest, 1, 1, 2, 0, 1);
+ final PagedResults beginTest = client.getExecutions(ExecutionQuery.builder()
+ .project(projectName)
+ .begin(new Date(1347581178168L))
+ .build(), 2L, 0L);
+ assertPageResults(beginTest, 2, 2, 2, 0, 6);
+ final PagedResults endTest = client.getExecutions(ExecutionQuery.builder()
+ .project(projectName)
+ .end(new Date(1415388156385L))
+ .build(), 2L, 0L);
+ assertPageResults(endTest, 2, 2, 2, 0, 4);
+ final List excludeJobIdList = Arrays.asList("123", "456");
+ final PagedResults excludeJobIdListTest = client.getExecutions(ExecutionQuery.builder()
+ .project(projectName)
+ .excludeJobIdList(excludeJobIdList)
+ .build(), 2L, 0L);
+ assertPageResults(excludeJobIdListTest, 2, 2, 2, 0, 4);
+ final List jobList = Arrays.asList("fruit/mango", "fruit/lemon");
+ final PagedResults jobListTest = client.getExecutions(ExecutionQuery.builder()
+ .project(projectName)
+ .jobList(jobList)
+ .build(), 2L, 0L);
+ assertPageResults(jobListTest, 2, 2, 2, 0, 2);
+ final List excludeJobList = Arrays.asList("a/path/job1", "path/to/job2");
+ final PagedResults excludeJobListTest = client.getExecutions(ExecutionQuery.builder()
+ .project(projectName)
+ .excludeJobList(excludeJobList)
+ .build(), 2L, 0L);
+ assertPageResults(excludeJobListTest, 2, 2, 2, 0, 4);
+ final List list = Arrays.asList("9aa33253-17a3-4dce-890c-e5f10f9f00d6",
+ "2dd94199-00c4-4690-9b4d-beda4812bed0");
+ final PagedResults jobIdListTest = client.getExecutions(ExecutionQuery.builder()
+ .project(projectName)
+ .jobIdList(list)
+ .build(), 2L, 0L);
+ assertPageResults(jobIdListTest, 2, 2, 2, 0, 2);
+ final PagedResults groupPathTest = client.getExecutions(ExecutionQuery.builder()
+ .project(projectName)
+ .groupPath("fruit")
+ .build(),
+ 2L,
+ 0L);
+ assertPageResults(groupPathTest, 2, 2, 2, 0, 2);
+ final PagedResults groupPathExactTest = client.getExecutions(ExecutionQuery.builder()
+ .project(projectName)
+ .groupPathExact("fruit")
+ .build(), 2L, 0L);
+ assertPageResults(groupPathExactTest, 2, 2, 2, 0, 2);
+
+ final PagedResults excludeGroupPathTest = client.getExecutions(ExecutionQuery.builder()
+ .project(projectName)
+ .excludeGroupPath("fruit")
+ .build(),
+ 2L,
+ 0L);
+ assertPageResults(excludeGroupPathTest, 2, 2, 2, 0, 2);
+ final PagedResults excliudeGroupPathExactTest = client.getExecutions(ExecutionQuery.builder()
+ .project(projectName)
+ .excludeGroupPathExact("fruit")
+ .build(), 2L, 0L);
+ assertPageResults(excliudeGroupPathExactTest, 2, 2, 2, 0, 2);
+
+ final PagedResults recentTest = client.getExecutions(ExecutionQuery.builder()
+ .project(projectName)
+ .recent("1h").build(), 2L, 0L);
+ assertPageResults(recentTest, 2, 2, 2, 0, 2);
+ final PagedResults statusTest = client.getExecutions(ExecutionQuery.builder()
+ .project(projectName)
+ .status(RundeckExecution.ExecutionStatus.SUCCEEDED)
+ .build(), 2L, 0L);
+ assertPageResults(statusTest, 2, 2, 2, 0, 3);
+ final PagedResults adhocTest = client.getExecutions(ExecutionQuery.builder()
+ .project(projectName)
+ .adhoc(true)
+ .build(), 2L, 0L);
+ assertPageResults(adhocTest, 2, 2, 2, 0, 2);
+ }
/**
* Test paging values from results
@@ -364,22 +657,7 @@ public class RundeckClientTest {
Assert.assertNull(delete.getMessage());
Assert.assertEquals("3a6d16be-4268-4d26-86a9-cebc1781f768", delete.getId());
}
- @Test
- @Betamax(tape = "trigger_job_basic")
- public void triggerJobDeprecatedBasic() throws Exception {
- RundeckClient client = createClient(TEST_TOKEN_3, 5);
- final RundeckExecution test
- = client.triggerJob("3170ba0e-6093-4b58-94d2-52988aefbfc9", null, null, null);
-
- Assert.assertEquals((Long) 19L, test.getId());
- Assert.assertEquals(null, test.getArgstring());
- Assert.assertEquals(null, test.getAbortedBy());
- Assert.assertEquals("echo hi there ${job.username} ; sleep 90", test.getDescription());
- Assert.assertEquals("admin", test.getStartedBy());
- Assert.assertEquals(RundeckExecution.ExecutionStatus.RUNNING, test.getStatus());
-
- }
@Test
@Betamax(tape = "trigger_job_basic")
public void triggerJobBasic() throws Exception {
@@ -396,22 +674,49 @@ public class RundeckClientTest {
Assert.assertEquals(RundeckExecution.ExecutionStatus.RUNNING, test.getStatus());
}
+
+ /**
+ * API v11 request to trigger job, with expected xml response without <result> wrapper
+ * @throws Exception
+ */
@Test
- @Betamax(tape = "trigger_job_as_user")
- public void triggerJobDeprecatedAsUser() throws Exception {
- RundeckClient client = createClient(TEST_TOKEN_3, 5);
+ @Betamax(tape = "trigger_job_basic_v11")
+ public void triggerJobBasic_v11() throws Exception {
+ RundeckClient client = createClient(TEST_TOKEN_7, 11);
final RundeckExecution test
- = client.triggerJob("3170ba0e-6093-4b58-94d2-52988aefbfc9", null, null, "api-java-client-user-test1");
+ = client.triggerJob(RunJobBuilder.builder().setJobId("bda8b956-43a5-4eef-9c67" +
+ "-3f27cc0ee1a5").build());
- Assert.assertEquals((Long) 20L, test.getId());
+ Assert.assertEquals((Long) 943L, test.getId());
Assert.assertEquals(null, test.getArgstring());
Assert.assertEquals(null, test.getAbortedBy());
Assert.assertEquals("echo hi there ${job.username} ; sleep 90", test.getDescription());
- Assert.assertEquals("api-java-client-user-test1", test.getStartedBy());
+ Assert.assertEquals("admin", test.getStartedBy());
Assert.assertEquals(RundeckExecution.ExecutionStatus.RUNNING, test.getStatus());
-
}
+
+ /**
+ * Response for API v11 incorrectly includes <result>, but we should handle this case
+ * @throws Exception
+ */
+ @Test
+ @Betamax(tape = "trigger_job_basic_v11_patch")
+ public void triggerJobBasic_v11_patch() throws Exception {
+ RundeckClient client = createClient(TEST_TOKEN_7, 11);
+
+ final RundeckExecution test
+ = client.triggerJob(RunJobBuilder.builder().setJobId("bda8b956-43a5-4eef-9c67" +
+ "-3f27cc0ee1a5").build());
+
+ Assert.assertEquals((Long) 944L, test.getId());
+ Assert.assertEquals(null, test.getArgstring());
+ Assert.assertEquals(null, test.getAbortedBy());
+ Assert.assertEquals("echo hi there ${job.username} ; sleep 90", test.getDescription());
+ Assert.assertEquals("admin", test.getStartedBy());
+ Assert.assertEquals(RundeckExecution.ExecutionStatus.RUNNING, test.getStatus());
+ }
+
@Test
@Betamax(tape = "trigger_job_as_user")
public void triggerJobAsUser() throws Exception {
@@ -431,19 +736,7 @@ public class RundeckClientTest {
Assert.assertEquals(RundeckExecution.ExecutionStatus.RUNNING, test.getStatus());
}
- @Test
- @Betamax(tape = "trigger_job_as_user_unauthorized")
- public void triggerJobDeprecatedAsUserUnauthorized() throws Exception {
- RundeckClient client = createClient(TEST_TOKEN_3, 5);
- final RundeckExecution test;
- try {
- test = client.triggerJob("3170ba0e-6093-4b58-94d2-52988aefbfc9",null,null,"api-java-client-user-test2");
- Assert.fail("should not succeed");
- } catch (RundeckApiException e) {
- Assert.assertEquals("Not authorized for action \"Run as User\" for Job ID 3170ba0e-6093-4b58-94d2-52988aefbfc9", e.getMessage());
- }
- }
@Test
@Betamax(tape = "trigger_job_as_user_unauthorized")
public void triggerJobAsUserUnauthorized() throws Exception {
@@ -461,21 +754,7 @@ public class RundeckClientTest {
}
}
- @Test
- @Betamax(tape = "trigger_adhoc_command")
- public void triggerAdhocCommandDeprecated() throws Exception {
- RundeckClient client = createClient(TEST_TOKEN_3, 5);
- final RundeckExecution test
- = client.triggerAdhocCommand("test", "echo test trigger_adhoc_command");
-
- Assert.assertEquals((Long) 23L, test.getId());
- Assert.assertEquals(null, test.getArgstring());
- Assert.assertEquals(null, test.getAbortedBy());
- Assert.assertEquals("echo test trigger_adhoc_command", test.getDescription());
- Assert.assertEquals("admin", test.getStartedBy());
- Assert.assertEquals(RundeckExecution.ExecutionStatus.SUCCEEDED, test.getStatus());
- }
@Test
@Betamax(tape = "trigger_adhoc_command")
@@ -497,20 +776,43 @@ public class RundeckClientTest {
}
@Test
- @Betamax(tape = "trigger_adhoc_command_as_user")
- public void triggerAdhocCommandDeprecatedAsUser() throws Exception {
- RundeckClient client = createClient(TEST_TOKEN_3, 5);
+ @Betamax(tape = "trigger_adhoc_command_v11_buggy")
+ public void triggerAdhocCommand_v11_buggy() throws Exception {
+ RundeckClient client = createClient(TEST_TOKEN_7, 11);
final RundeckExecution test
- = client.triggerAdhocCommand("test", "echo test trigger_adhoc_command_as_user",null,null,null,"api-java-client-test-run-command-as-user1");
+ = client.triggerAdhocCommand(RunAdhocCommandBuilder.builder()
+ .setProject("test")
+ .setCommand("echo test trigger_adhoc_command")
+ .build());
- Assert.assertEquals((Long) 24L, test.getId());
+ Assert.assertEquals((Long) 945L, test.getId());
Assert.assertEquals(null, test.getArgstring());
Assert.assertEquals(null, test.getAbortedBy());
- Assert.assertEquals("echo test trigger_adhoc_command_as_user", test.getDescription());
- Assert.assertEquals("api-java-client-test-run-command-as-user1", test.getStartedBy());
- Assert.assertEquals(RundeckExecution.ExecutionStatus.SUCCEEDED, test.getStatus());
+ Assert.assertEquals("echo test trigger_adhoc_command", test.getDescription());
+ Assert.assertEquals("admin", test.getStartedBy());
+ Assert.assertEquals(RundeckExecution.ExecutionStatus.RUNNING, test.getStatus());
}
+ @Test
+ @Betamax(tape = "trigger_adhoc_command_v11")
+ public void triggerAdhocCommand_v11() throws Exception {
+ RundeckClient client = createClient(TEST_TOKEN_7, 11);
+
+ final RundeckExecution test
+ = client.triggerAdhocCommand(RunAdhocCommandBuilder.builder()
+ .setProject("test")
+ .setCommand("echo test trigger_adhoc_command")
+ .build());
+
+ Assert.assertEquals((Long) 946L, test.getId());
+ Assert.assertEquals(null, test.getArgstring());
+ Assert.assertEquals(null, test.getAbortedBy());
+ Assert.assertEquals("echo test trigger_adhoc_command", test.getDescription());
+ Assert.assertEquals("admin", test.getStartedBy());
+ Assert.assertEquals(RundeckExecution.ExecutionStatus.RUNNING, test.getStatus());
+ }
+
+
@Test
@Betamax(tape = "trigger_adhoc_command_as_user")
public void triggerAdhocCommandAsUser() throws Exception {
@@ -532,19 +834,7 @@ public class RundeckClientTest {
Assert.assertEquals("api-java-client-test-run-command-as-user1", test.getStartedBy());
Assert.assertEquals(RundeckExecution.ExecutionStatus.SUCCEEDED, test.getStatus());
}
- @Test
- @Betamax(tape = "trigger_adhoc_command_as_user_unauthorized")
- public void triggerAdhocCommandDeprecatedAsUserUnauthorized() throws Exception {
- RundeckClient client = createClient(TEST_TOKEN_3, 5);
- final RundeckExecution test;
- try {
- test = client.triggerAdhocCommand("test", "echo test trigger_adhoc_command_as_user",null,null,null,"api-java-client-test-run-command-as-user1");
- Assert.fail("should not succeed");
- } catch (RundeckApiException e) {
- Assert.assertEquals("Not authorized for action \"Run as User\" for Run Adhoc", e.getMessage());
- }
- }
@Test
@Betamax(tape = "trigger_adhoc_command_as_user_unauthorized")
public void triggerAdhocCommandAsUserUnauthorized() throws Exception {
@@ -565,24 +855,7 @@ public class RundeckClientTest {
}
}
- @Test
- @Betamax(tape = "trigger_adhoc_script")
- public void triggerAdhocScriptDeprecated() throws Exception {
- RundeckClient client = createClient(TEST_TOKEN_3, 5);
- String script = "#!/bin/bash\n" +
- "echo test trigger_adhoc_script\n";
- ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(script.getBytes());
- final RundeckExecution test
- = client.triggerAdhocScript("test", byteArrayInputStream,(Properties) null, null, null, null, null);
-
- Assert.assertEquals((Long) 25L, test.getId());
- Assert.assertEquals(null, test.getArgstring());
- Assert.assertEquals(null, test.getAbortedBy());
- Assert.assertEquals("#!/bin/bash\necho test trigger_adhoc_script", test.getDescription());
- Assert.assertEquals("admin", test.getStartedBy());
- Assert.assertEquals(RundeckExecution.ExecutionStatus.RUNNING, test.getStatus());
- }
@Test
@Betamax(tape = "trigger_adhoc_script")
public void triggerAdhocScript() throws Exception {
@@ -602,24 +875,55 @@ public class RundeckClientTest {
Assert.assertEquals("admin", test.getStartedBy());
Assert.assertEquals(RundeckExecution.ExecutionStatus.RUNNING, test.getStatus());
}
+
+
+ /**
+ * Handle incorrect <result> wrapper for v11 response
+ * @throws Exception
+ */
@Test
- @Betamax(tape = "trigger_adhoc_script_as_user")
- public void triggerAdhocScriptDeprecatedAsUser() throws Exception {
- RundeckClient client = createClient(TEST_TOKEN_3, 5);
+ @Betamax(tape = "trigger_adhoc_script_v11_buggy")
+ public void triggerAdhocScript_v11_buggy() throws Exception {
+ RundeckClient client = createClient(TEST_TOKEN_7, 11);
String script = "#!/bin/bash\n" +
"echo test trigger_adhoc_script\n";
ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(script.getBytes());
final RundeckExecution test
- = client.triggerAdhocScript("test", byteArrayInputStream, (Properties) null, null, null, null, "api-java-client-test-adhoc-script-as-user1");
+ = client.triggerAdhocScript(RunAdhocScriptBuilder.builder().setProject("test").setScript
+ (byteArrayInputStream).build());
- Assert.assertEquals((Long) 26L, test.getId());
+ Assert.assertEquals((Long) 947L, test.getId());
Assert.assertEquals(null, test.getArgstring());
Assert.assertEquals(null, test.getAbortedBy());
Assert.assertEquals("#!/bin/bash\necho test trigger_adhoc_script", test.getDescription());
- Assert.assertEquals("api-java-client-test-adhoc-script-as-user1", test.getStartedBy());
+ Assert.assertEquals("admin", test.getStartedBy());
Assert.assertEquals(RundeckExecution.ExecutionStatus.RUNNING, test.getStatus());
}
+ /**
+ * Handle v11 response without <result> wrapper
+ * @throws Exception
+ */
+ @Test
+ @Betamax(tape = "trigger_adhoc_script_v11")
+ public void triggerAdhocScript_v11() throws Exception {
+ RundeckClient client = createClient(TEST_TOKEN_7, 11);
+ String script = "#!/bin/bash\n" +
+ "echo test trigger_adhoc_script\n";
+ ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(script.getBytes());
+
+ final RundeckExecution test
+ = client.triggerAdhocScript(RunAdhocScriptBuilder.builder().setProject("test").setScript
+ (byteArrayInputStream).build());
+
+ Assert.assertEquals((Long) 948L, test.getId());
+ Assert.assertEquals(null, test.getArgstring());
+ Assert.assertEquals(null, test.getAbortedBy());
+ Assert.assertEquals("#!/bin/bash\necho test trigger_adhoc_script", test.getDescription());
+ Assert.assertEquals("admin", test.getStartedBy());
+ Assert.assertEquals(RundeckExecution.ExecutionStatus.RUNNING, test.getStatus());
+ }
+
@Test
@Betamax(tape = "trigger_adhoc_script_as_user")
public void triggerAdhocScriptAsUser() throws Exception {
@@ -639,23 +943,7 @@ public class RundeckClientTest {
Assert.assertEquals("api-java-client-test-adhoc-script-as-user1", test.getStartedBy());
Assert.assertEquals(RundeckExecution.ExecutionStatus.RUNNING, test.getStatus());
}
- @Test
- @Betamax(tape = "trigger_adhoc_script_as_user_unauthorized")
- public void triggerAdhocScriptDeprecatedAsUserUnauthorized() throws Exception {
- RundeckClient client = createClient(TEST_TOKEN_3, 5);
- String script = "#!/bin/bash\n" +
- "echo test trigger_adhoc_script\n";
- ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(script.getBytes());
-
- try{
- final RundeckExecution test
- = client.triggerAdhocScript("test", byteArrayInputStream, (Properties) null, null, null, null, "api-java-client-test-adhoc-script-as-user1");
- Assert.fail("should not succeed");
- } catch (RundeckApiException e) {
- Assert.assertEquals("Not authorized for action \"Run as User\" for Run Adhoc", e.getMessage());
- }
-
- }
+
@Test
@Betamax(tape = "trigger_adhoc_script_as_user_unauthorized")
public void triggerAdhocScriptAsUserUnauthorized() throws Exception {
@@ -1034,7 +1322,647 @@ public class RundeckClientTest {
RundeckExecution exec2 = runningExecutions.get(1);
Assert.assertEquals("test2", exec2.getProject());
}
+ /**
+ * Execution output
+ */
+ @Test
+ @Betamax(tape = "execution_output_basic", mode = TapeMode.READ_ONLY)
+ public void executionOutputBasic() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_6, 10);
+ RundeckOutput output = client.getJobExecutionOutput(146L,0,0L,-1);
+ Assert.assertEquals(new Long(1602), output.getExecDuration());
+ Assert.assertEquals(new Long(146), output.getExecutionId());
+ Assert.assertEquals(new Long(1389894504000L), output.getLastModified());
+ Assert.assertEquals(null, output.getFilterNode());
+ Assert.assertEquals(null, output.getFilterStep());
+ Assert.assertEquals(1409, output.getOffset());
+ Assert.assertEquals(RundeckExecution.ExecutionStatus.SUCCEEDED, output.getStatus());
+ Assert.assertEquals(new Float(99.57597), output.getPercentLoaded());
+ Assert.assertEquals(1415, output.getTotalSize());
+ Assert.assertEquals(true, output.isCompleted());
+ Assert.assertEquals(true, output.isExecCompleted());
+ Assert.assertEquals(false, output.isEmpty());
+ Assert.assertEquals(false, output.isHasFailedNodes());
+ Assert.assertEquals(false, output.isUnmodified());
+ Assert.assertEquals(3, output.getLogEntries().size());
+ }
+ /**
+ * Execution output for a node
+ */
+ @Test
+ @Betamax(tape = "execution_output_fornode", mode = TapeMode.READ_ONLY)
+ public void executionOutputForNode() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_6, 10);
+ RundeckOutput output = client.getExecutionOutputForNode(146L, "node-14.qa.subgroup.mycompany.com", 0, -1, 0L, -1);
+
+ Assert.assertEquals(new Long(1602), output.getExecDuration());
+ Assert.assertEquals(new Long(146), output.getExecutionId());
+ Assert.assertEquals(new Long(1389894504000L), output.getLastModified());
+ Assert.assertEquals("node-14.qa.subgroup.mycompany.com", output.getFilterNode());
+ Assert.assertEquals(null, output.getFilterStep());
+ Assert.assertEquals(1409, output.getOffset());
+ Assert.assertEquals(RundeckExecution.ExecutionStatus.SUCCEEDED, output.getStatus());
+ Assert.assertEquals(new Float(99.57597), output.getPercentLoaded());
+ Assert.assertEquals(1415, output.getTotalSize());
+ Assert.assertEquals(true, output.isCompleted());
+ Assert.assertEquals(true, output.isExecCompleted());
+ Assert.assertEquals(false, output.isEmpty());
+ Assert.assertEquals(false, output.isHasFailedNodes());
+ Assert.assertEquals(false, output.isUnmodified());
+ Assert.assertEquals(1, output.getLogEntries().size());
+ }
+ /**
+ * Execution output for a step
+ */
+ @Test
+ @Betamax(tape = "execution_output_forstep", mode = TapeMode.READ_ONLY)
+ public void executionOutputForStep() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_6, 10);
+ RundeckOutput output = client.getExecutionOutputForStep(146L, "1", 0, -1, 0L, -1);
+
+ Assert.assertEquals(new Long(1602), output.getExecDuration());
+ Assert.assertEquals(new Long(146), output.getExecutionId());
+ Assert.assertEquals(new Long(1389894504000L), output.getLastModified());
+ Assert.assertEquals(null, output.getFilterNode());
+ Assert.assertEquals("1", output.getFilterStep());
+ Assert.assertEquals(1409, output.getOffset());
+ Assert.assertEquals(RundeckExecution.ExecutionStatus.SUCCEEDED, output.getStatus());
+ Assert.assertEquals(new Float(99.57597), output.getPercentLoaded());
+ Assert.assertEquals(1415, output.getTotalSize());
+ Assert.assertEquals(true, output.isCompleted());
+ Assert.assertEquals(true, output.isExecCompleted());
+ Assert.assertEquals(false, output.isEmpty());
+ Assert.assertEquals(false, output.isHasFailedNodes());
+ Assert.assertEquals(false, output.isUnmodified());
+ Assert.assertEquals(3, output.getLogEntries().size());
+ }
+
+ /**
+ * Execution output for a node and step
+ */
+ @Test
+ @Betamax(tape = "execution_output_fornodeandstep", mode = TapeMode.READ_ONLY)
+ public void executionOutputForNodeAndStep() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_6, 10);
+ RundeckOutput output = client.getExecutionOutputForNodeAndStep(146L, "node-14.qa.subgroup.mycompany.com",
+ "1", 0, -1, 0L, -1);
+
+ Assert.assertEquals(new Long(1602), output.getExecDuration());
+ Assert.assertEquals(new Long(146), output.getExecutionId());
+ Assert.assertEquals(new Long(1389894504000L), output.getLastModified());
+ Assert.assertEquals("node-14.qa.subgroup.mycompany.com", output.getFilterNode());
+ Assert.assertEquals("1", output.getFilterStep());
+ Assert.assertEquals(1409, output.getOffset());
+ Assert.assertEquals(RundeckExecution.ExecutionStatus.SUCCEEDED, output.getStatus());
+ Assert.assertEquals(new Float(99.57597), output.getPercentLoaded());
+ Assert.assertEquals(1415, output.getTotalSize());
+ Assert.assertEquals(true, output.isCompleted());
+ Assert.assertEquals(true, output.isExecCompleted());
+ Assert.assertEquals(false, output.isEmpty());
+ Assert.assertEquals(false, output.isHasFailedNodes());
+ Assert.assertEquals(false, output.isUnmodified());
+ Assert.assertEquals(1, output.getLogEntries().size());
+ }
+
+ /**
+ * Execution output state sequence
+ */
+ @Test
+ @Betamax(tape = "execution_output_state", mode = TapeMode.READ_ONLY)
+ public void executionOutputState() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_6, 10);
+ RundeckOutput output = client.getExecutionOutputState(146L, false, 0, 0L, -1);
+
+ Assert.assertEquals(new Long(1602), output.getExecDuration());
+ Assert.assertEquals(new Long(146), output.getExecutionId());
+ Assert.assertEquals(new Long(1389894504000L), output.getLastModified());
+ Assert.assertEquals(null, output.getFilterNode());
+ Assert.assertEquals(null, output.getFilterStep());
+ Assert.assertEquals(1409, output.getOffset());
+ Assert.assertEquals(RundeckExecution.ExecutionStatus.SUCCEEDED, output.getStatus());
+ Assert.assertEquals(new Float(99.57597), output.getPercentLoaded());
+ Assert.assertEquals(1415, output.getTotalSize());
+ Assert.assertEquals(true, output.isCompleted());
+ Assert.assertEquals(true, output.isExecCompleted());
+ Assert.assertEquals(false, output.isEmpty());
+ Assert.assertEquals(false, output.isHasFailedNodes());
+ Assert.assertEquals(false, output.isUnmodified());
+ Assert.assertEquals(15, output.getLogEntries().size());
+ }
+ /**
+ * Execution output state sequence
+ */
+ @Test
+ @Betamax(tape = "execution_output_state_only", mode = TapeMode.READ_ONLY)
+ public void executionOutputStateOnly() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_6, 10);
+ RundeckOutput output = client.getExecutionOutputState(146L, true, 0, 0L, -1);
+
+ Assert.assertEquals(new Long(1602), output.getExecDuration());
+ Assert.assertEquals(new Long(146), output.getExecutionId());
+ Assert.assertEquals(new Long(1389894504000L), output.getLastModified());
+ Assert.assertEquals(null, output.getFilterNode());
+ Assert.assertEquals(null, output.getFilterStep());
+ Assert.assertEquals(1409, output.getOffset());
+ Assert.assertEquals(RundeckExecution.ExecutionStatus.SUCCEEDED, output.getStatus());
+ Assert.assertEquals(new Float(99.57597), output.getPercentLoaded());
+ Assert.assertEquals(1415, output.getTotalSize());
+ Assert.assertEquals(true, output.isCompleted());
+ Assert.assertEquals(true, output.isExecCompleted());
+ Assert.assertEquals(false, output.isEmpty());
+ Assert.assertEquals(false, output.isHasFailedNodes());
+ Assert.assertEquals(false, output.isUnmodified());
+ Assert.assertEquals(12, output.getLogEntries().size());
+ }
+ /**
+ * Execution state structure
+ */
+ @Test
+ @Betamax(tape = "execution_state", mode = TapeMode.READ_ONLY)
+ public void executionState() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_6, 10);
+ RundeckExecutionState output = client.getExecutionState(149L);
+
+ Assert.assertEquals(149,output.getExecutionId());
+ Assert.assertEquals(3,output.getTargetNodes().size());
+ Assert.assertEquals(3,output.getAllNodes().size());
+ Assert.assertEquals(1,output.getStepCount());
+ Assert.assertEquals(1,output.getSteps().size());
+ Assert.assertEquals(RundeckWFExecState.SUCCEEDED,output.getExecutionState());
+ }
+
+ /**
+ * generate api token
+ */
+ @Test
+ @Betamax(tape = "api_token_generate", mode = TapeMode.READ_ONLY)
+ public void generateApiToken() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_7, 11);
+ String token = client.generateApiToken("bob");
+
+ Assert.assertNotNull(token);
+ Assert.assertEquals("MiquQjELTrEaugpmdgAKs1W3a7xonAwU", token);
+ }
+ /**
+ * get api token
+ */
+ @Test
+ @Betamax(tape = "api_token_get", mode = TapeMode.READ_ONLY)
+ public void getApiToken() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_7, 11);
+ RundeckToken token = client.getApiToken("MiquQjELTrEaugpmdgAKs1W3a7xonAwU");
+
+ Assert.assertNotNull(token);
+ Assert.assertEquals("MiquQjELTrEaugpmdgAKs1W3a7xonAwU", token.getToken());
+ Assert.assertEquals("bob", token.getUser());
+ }
+ /**
+ * list api tokens for user
+ */
+ @Test
+ @Betamax(tape = "api_tokens_list_user", mode = TapeMode.READ_ONLY)
+ public void listApiTokens_user() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_7, 11);
+ List tokens = client.listApiTokens("bob");
+
+ Assert.assertNotNull(tokens);
+ Assert.assertEquals(3, tokens.size());
+ Assert.assertEquals("hINp5eGzvYA9UePbUChaKHd5NiRkwWbx", tokens.get(0).getToken());
+ Assert.assertEquals("bob", tokens.get(0).getUser());
+ Assert.assertEquals("NaNnwVzAHAG83qOS7Wtwh6mjcXViyWUV", tokens.get(1).getToken());
+ Assert.assertEquals("bob", tokens.get(1).getUser());
+ Assert.assertEquals("MiquQjELTrEaugpmdgAKs1W3a7xonAwU", tokens.get(2).getToken());
+ Assert.assertEquals("bob", tokens.get(2).getUser());
+ }
+ /**
+ * list api tokens all
+ */
+ @Test
+ @Betamax(tape = "api_tokens_list_all", mode = TapeMode.READ_ONLY)
+ public void listApiTokens() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_7, 11);
+ List tokens = client.listApiTokens();
+
+ Assert.assertNotNull(tokens);
+ Assert.assertEquals(4, tokens.size());
+ Assert.assertEquals("8Dp9op111ER6opsDRkddvE86K9sE499s", tokens.get(0).getToken());
+ Assert.assertEquals("admin", tokens.get(0).getUser());
+ Assert.assertEquals("hINp5eGzvYA9UePbUChaKHd5NiRkwWbx", tokens.get(1).getToken());
+ Assert.assertEquals("bob", tokens.get(1).getUser());
+ Assert.assertEquals("NaNnwVzAHAG83qOS7Wtwh6mjcXViyWUV", tokens.get(2).getToken());
+ Assert.assertEquals("bob", tokens.get(2).getUser());
+ Assert.assertEquals("MiquQjELTrEaugpmdgAKs1W3a7xonAwU", tokens.get(3).getToken());
+ Assert.assertEquals("bob", tokens.get(3).getUser());
+ }
+
+ /**
+ * get api token
+ */
+ @Test
+ @Betamax(tape = "api_token_delete", mode = TapeMode.READ_ONLY)
+ public void deleteApiToken() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_7, 11);
+
+ client.deleteApiToken("MiquQjELTrEaugpmdgAKs1W3a7xonAwU");
+
+ //get should now return 404
+ try {
+ client.getApiToken("MiquQjELTrEaugpmdgAKs1W3a7xonAwU");
+ Assert.fail("expected failure");
+ } catch (RundeckApiException.RundeckApiHttpStatusException e) {
+ Assert.assertEquals(404, e.getStatusCode());
+ }
+ }
+ /**
+ * Store ssh key
+ */
+ @Test
+ @Betamax(tape = "key_store_private", mode = TapeMode.READ_ONLY)
+ public void storeKey_private() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_7, 11);
+ File temp = File.createTempFile("test-key", ".tmp");
+ temp.deleteOnExit();
+ FileOutputStream out = new FileOutputStream(temp);
+ try{
+ out.write("test1".getBytes());
+ }finally {
+ out.close();
+ }
+ KeyResource storageResource = client.storeKey("keys/test/example/file1.pem", temp, true);
+ Assert.assertNotNull(storageResource);
+ Assert.assertFalse(storageResource.isDirectory());
+ Assert.assertTrue(storageResource.isPrivateKey());
+ Assert.assertEquals("file1.pem", storageResource.getName());
+ Assert.assertEquals("keys/test/example/file1.pem", storageResource.getPath());
+ Assert.assertEquals("http://dignan.local:4440/api/11/storage/keys/test/example/file1.pem",
+ storageResource.getUrl());
+ Assert.assertEquals(0, storageResource.getDirectoryContents().size());
+ Map metadata = storageResource.getMetadata();
+ Assert.assertNotNull(metadata);
+ Assert.assertEquals("application/octet-stream", metadata.get("Rundeck-content-type"));
+ Assert.assertEquals("private", metadata.get("Rundeck-key-type"));
+ }
+ /**
+ * Store ssh key
+ */
+ @Test
+ @Betamax(tape = "key_store_public", mode = TapeMode.READ_ONLY)
+ public void storeKey_public() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_7, 11);
+ File temp = File.createTempFile("test-key", ".tmp");
+ temp.deleteOnExit();
+ FileOutputStream out = new FileOutputStream(temp);
+ try{
+ out.write("test1".getBytes());
+ }finally {
+ out.close();
+ }
+ KeyResource storageResource = client.storeKey("keys/test/example/file2.pub", temp, false);
+ Assert.assertNotNull(storageResource);
+ Assert.assertFalse(storageResource.isDirectory());
+ Assert.assertFalse(storageResource.isPrivateKey());
+ Assert.assertEquals("file2.pub", storageResource.getName());
+ Assert.assertEquals("keys/test/example/file2.pub", storageResource.getPath());
+ Assert.assertEquals("http://dignan.local:4440/api/11/storage/keys/test/example/file2.pub",
+ storageResource.getUrl());
+ Assert.assertEquals(0, storageResource.getDirectoryContents().size());
+ Map metadata = storageResource.getMetadata();
+ Assert.assertNotNull(metadata);
+ Assert.assertEquals("application/pgp-keys", metadata.get("Rundeck-content-type"));
+ Assert.assertEquals("public", metadata.get("Rundeck-key-type"));
+ }
+ /**
+ * get ssh key
+ */
+ @Test
+ @Betamax(tape = "key_get_public", mode = TapeMode.READ_ONLY)
+ public void getKey_public() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_7, 11);
+ KeyResource storageResource = client.getKey("keys/test/example/file2.pub");
+ Assert.assertNotNull(storageResource);
+ Assert.assertFalse(storageResource.isDirectory());
+ Assert.assertFalse(storageResource.isPrivateKey());
+ Assert.assertEquals("file2.pub", storageResource.getName());
+ Assert.assertEquals("keys/test/example/file2.pub", storageResource.getPath());
+ Assert.assertEquals("http://dignan.local:4440/api/11/storage/keys/test/example/file2.pub",
+ storageResource.getUrl());
+ Assert.assertEquals(0, storageResource.getDirectoryContents().size());
+ Map metadata = storageResource.getMetadata();
+ Assert.assertNotNull(metadata);
+ Assert.assertEquals("application/pgp-keys", metadata.get("Rundeck-content-type"));
+ Assert.assertEquals("public", metadata.get("Rundeck-key-type"));
+ }
+ /**
+ * get ssh key
+ */
+ @Test
+ @Betamax(tape = "key_get_private", mode = TapeMode.READ_ONLY)
+ public void getKey_private() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_7, 11);
+ KeyResource storageResource = client.getKey("keys/test/example/file1.pem");
+ Assert.assertNotNull(storageResource);
+ Assert.assertFalse(storageResource.isDirectory());
+ Assert.assertTrue(storageResource.isPrivateKey());
+ Assert.assertEquals("file1.pem", storageResource.getName());
+ Assert.assertEquals("keys/test/example/file1.pem", storageResource.getPath());
+ Assert.assertEquals("http://dignan.local:4440/api/11/storage/keys/test/example/file1.pem",
+ storageResource.getUrl());
+ Assert.assertEquals(0, storageResource.getDirectoryContents().size());
+ Map metadata = storageResource.getMetadata();
+ Assert.assertNotNull(metadata);
+ Assert.assertEquals("application/octet-stream", metadata.get("Rundeck-content-type"));
+ Assert.assertEquals("private", metadata.get("Rundeck-key-type"));
+ }
+ /**
+ * get ssh key data
+ */
+ @Test
+ @Betamax(tape = "key_get_data_private", mode = TapeMode.READ_ONLY)
+ public void getKeyData_private() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_7, 11);
+ File temp = File.createTempFile("test-key", ".tmp");
+ temp.deleteOnExit();
+ try {
+ int data = client.getPublicKeyContent("keys/test/example/file1.pem", temp);
+ Assert.fail("expected failure");
+ } catch (RundeckApiException e) {
+ Assert.assertEquals("Requested Key path was not a Public key: keys/test/example/file1.pem",
+ e.getMessage());
+ }
+ }
+ /**
+ * get ssh key data
+ */
+ @Test
+ @Betamax(tape = "key_get_data_public", mode = TapeMode.READ_ONLY)
+ public void getKeyData_public() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_7, 11);
+ File temp = File.createTempFile("test-key", ".tmp");
+ temp.deleteOnExit();
+ int length = client.getPublicKeyContent("keys/test/example/file2.pub", temp);
+ Assert.assertEquals(5, length);
+ }
+ /**
+ * list directory
+ */
+ @Test
+ @Betamax(tape = "key_list_directory", mode = TapeMode.READ_ONLY)
+ public void listKeyDirectory() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_7, 11);
+ List list = client.listKeyDirectory("keys/test/example");
+ Assert.assertEquals(2, list.size());
+ KeyResource storageResource1 = list.get(0);
+ KeyResource storageResource2 = list.get(1);
+
+ Assert.assertFalse(storageResource2.isDirectory());
+ Assert.assertTrue(storageResource2.isPrivateKey());
+ Assert.assertEquals("file1.pem", storageResource2.getName());
+ Assert.assertEquals("keys/test/example/file1.pem", storageResource2.getPath());
+ Assert.assertEquals("http://dignan.local:4440/api/11/storage/keys/test/example/file1.pem", storageResource2.getUrl());
+ Assert.assertNotNull(storageResource2.getMetadata());
+
+ Assert.assertEquals("application/octet-stream", storageResource2.getMetadata().get("Rundeck-content-type"));
+ Assert.assertEquals("private", storageResource2.getMetadata().get("Rundeck-key-type"));
+
+ Assert.assertFalse(storageResource1.isDirectory());
+ Assert.assertFalse(storageResource1.isPrivateKey());
+ Assert.assertEquals("file2.pub", storageResource1.getName());
+ Assert.assertEquals("keys/test/example/file2.pub", storageResource1.getPath());
+ Assert.assertEquals("http://dignan.local:4440/api/11/storage/keys/test/example/file2.pub",
+ storageResource1.getUrl());
+ Assert.assertNotNull(storageResource1.getMetadata());
+ Assert.assertEquals("application/pgp-keys", storageResource1.getMetadata().get("Rundeck-content-type"));
+ Assert.assertEquals("public", storageResource1.getMetadata().get("Rundeck-key-type"));
+ }
+ /**
+ * list root
+ */
+ @Test
+ @Betamax(tape = "key_list_root", mode = TapeMode.READ_ONLY)
+ public void listKeyDirectoryRoot() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_7, 11);
+ List list = client.listKeyDirectoryRoot();
+ Assert.assertEquals(2, list.size());
+ KeyResource storageResource0 = list.get(0);
+ KeyResource storageResource1 = list.get(1);
+
+ Assert.assertFalse(storageResource0.isDirectory());
+ Assert.assertTrue(storageResource0.isPrivateKey());
+ Assert.assertEquals("test1.pem", storageResource0.getName());
+ Assert.assertEquals("keys/test1.pem", storageResource0.getPath());
+ Assert.assertEquals("http://dignan.local:4440/api/11/storage/keys/test1.pem", storageResource0.getUrl());
+ Assert.assertNotNull(storageResource0.getMetadata());
+
+ Assert.assertEquals("application/octet-stream", storageResource0.getMetadata().get("Rundeck-content-type"));
+ Assert.assertEquals("private", storageResource0.getMetadata().get("Rundeck-key-type"));
+
+ Assert.assertTrue(storageResource1.toString(), storageResource1.isDirectory());
+ Assert.assertEquals(null, storageResource1.getName());
+ Assert.assertEquals("keys/test", storageResource1.getPath());
+ Assert.assertEquals("http://dignan.local:4440/api/11/storage/keys/test",
+ storageResource1.getUrl());
+ Assert.assertNull(storageResource1.getMetadata());
+
+
+ }
+
+ /**
+ * delete ssh key
+ */
+ @Test
+ @Betamax(tape = "key_delete", mode = TapeMode.READ_ONLY)
+ public void deleteKey() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_7, 11);
+ client.deleteKey("keys/test/example/file2.pub");
+
+ try {
+ client.getKey("keys/test/example/file2.pub");
+ Assert.fail("expected failure");
+ } catch (RundeckApiException.RundeckApiHttpStatusException e) {
+ Assert.assertEquals(404,e.getStatusCode());
+ }
+ }
+ /**
+ * delete job
+ */
+ @Test
+ @Betamax(tape = "delete_job", mode = TapeMode.READ_ONLY)
+ public void deleteJob() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_7, 11);
+ String result = client.deleteJob("api-test-job-run-scheduled");
+
+ Assert.assertEquals("Job api-test-job-run-scheduled was deleted successfully", result);
+ }
+ /**
+ * delete job (DNE)
+ */
+ @Test
+ @Betamax(tape = "delete_job_not_found", mode = TapeMode.READ_ONLY)
+ public void deleteJobNotFound() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_7, 11);
+ try {
+ String result = client.deleteJob("does-not-exist");
+ Assert.fail();
+ } catch (RundeckApiException.RundeckApiHttpStatusException e) {
+ Assert.assertEquals(404, e.getStatusCode());
+ }
+
+ }
+
+ /**
+ * delete executions with failure
+ */
+ @Test
+ @Betamax(tape = "delete_executions_unauthorized", mode = TapeMode.READ_ONLY)
+ public void deleteExecutionsUnauthorized() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_8, 12);
+ final DeleteExecutionsResponse response = client.deleteExecutions(
+ new HashSet() {{
+ add(640L);
+ add(641L);
+ }}
+ );
+ Assert.assertEquals(2, response.getRequestCount());
+ Assert.assertEquals(0, response.getSuccessCount());
+ Assert.assertEquals(2, response.getFailedCount());
+ Assert.assertFalse(response.isAllsuccessful());
+ Assert.assertNotNull(response.getFailures());
+ Assert.assertEquals(2, response.getFailures().size());
+ Assert.assertEquals(Long.valueOf(641L), response.getFailures().get(0).getExecutionId());
+ Assert.assertEquals(
+ "Unauthorized: Delete execution in project test",
+ response.getFailures().get(0).getMessage()
+ );
+ Assert.assertEquals(Long.valueOf(640L), response.getFailures().get(1).getExecutionId());
+ Assert.assertEquals(
+ "Unauthorized: Delete execution in project test",
+ response.getFailures().get(1).getMessage()
+ );
+ }
+ /**
+ * delete executions with success
+ */
+ @Test
+ @Betamax(tape = "delete_executions_success", mode = TapeMode.READ_ONLY)
+ public void deleteExecutionsSuccess() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_8, 12);
+ final DeleteExecutionsResponse response = client.deleteExecutions(
+ new HashSet() {{
+ add(640L);
+ add(641L);
+ }}
+ );
+ Assert.assertEquals(2, response.getRequestCount());
+ Assert.assertEquals(2, response.getSuccessCount());
+ Assert.assertEquals(0, response.getFailedCount());
+ Assert.assertTrue(response.isAllsuccessful());
+ Assert.assertNotNull(response.getFailures());
+ Assert.assertEquals(0, response.getFailures().size());
+ }
+ /**
+ * delete executions mixed success
+ */
+ @Test
+ @Betamax(tape = "delete_executions_mixed", mode = TapeMode.READ_ONLY)
+ public void deleteExecutionsMixed() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_8, 12);
+ final DeleteExecutionsResponse response = client.deleteExecutions(
+ new HashSet() {{
+ add(642L);
+ add(640L);
+ add(1640L);
+ }}
+ );
+ Assert.assertEquals(3, response.getRequestCount());
+ Assert.assertEquals(1, response.getSuccessCount());
+ Assert.assertEquals(2, response.getFailedCount());
+ Assert.assertFalse(response.isAllsuccessful());
+ Assert.assertNotNull(response.getFailures());
+ Assert.assertEquals(2, response.getFailures().size());
+ Assert.assertEquals(Long.valueOf(1640L), response.getFailures().get(0).getExecutionId());
+ Assert.assertEquals(
+ "Execution Not found: 1640",
+ response.getFailures().get(0).getMessage()
+ );
+ Assert.assertEquals(Long.valueOf(640L), response.getFailures().get(1).getExecutionId());
+ Assert.assertEquals(
+ "Execution Not found: 640",
+ response.getFailures().get(1).getMessage()
+ );
+ }
+ /**
+ * delete executions with failure
+ */
+ @Test
+ @Betamax(tape = "delete_all_job_executions_unauthorized", mode = TapeMode.READ_ONLY)
+ public void deleteAllJobExecutionsUnauthorized() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_8, 12);
+ try {
+ final DeleteExecutionsResponse response = client.deleteAllJobExecutions(
+ "764c1209-68ed-4185-8d43-a739364bf156"
+ );
+ Assert.fail();
+ } catch (RundeckApiException.RundeckApiTokenException e) {
+ e.printStackTrace();
+ }
+ }
+
+ /**
+ *
+ * @throws Exception
+ */
+ @Test
+ @Betamax(tape = "delete_all_job_executions_success", mode = TapeMode.READ_ONLY)
+ public void deleteAllJobExecutionsSuccess() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_8, 12);
+ final DeleteExecutionsResponse response = client.deleteAllJobExecutions(
+ "764c1209-68ed-4185-8d43-a739364bf156"
+ );
+ Assert.assertEquals(2, response.getRequestCount());
+ Assert.assertEquals(2, response.getSuccessCount());
+ Assert.assertEquals(0, response.getFailedCount());
+ Assert.assertTrue(response.isAllsuccessful());
+ Assert.assertNotNull(response.getFailures());
+ Assert.assertEquals(0, response.getFailures().size());
+ }
+
+ /**
+ * delete single execution success
+ */
+ @Test
+ @Betamax(tape = "delete_execution_success", mode = TapeMode.READ_ONLY)
+ public void deleteExecutionSuccess() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_8, 12);
+ client.deleteExecution(643L);
+ }
+ /**
+ * delete single execution failure (does not exist)
+ */
+ @Test
+ @Betamax(tape = "delete_execution_failure", mode = TapeMode.READ_ONLY)
+ public void deleteExecutionFailure() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_8, 12);
+ try {
+ client.deleteExecution(640L);
+ Assert.fail();
+ } catch (RundeckApiException.RundeckApiHttpStatusException e) {
+ Assert.assertEquals(404, e.getStatusCode());
+ }
+ }
+ /**
+ * delete single execution null input
+ */
+ @Test
+ public void deleteExecutionNullInput() throws Exception {
+ final RundeckClient client = createClient(TEST_TOKEN_8, 12);
+ try {
+ client.deleteExecution(null);
+ Assert.fail();
+ } catch (IllegalArgumentException e) {
+
+ }
+ }
@Before
public void setUp() throws Exception {
// not that you can put whatever here, because we don't actually connect to the RunDeck instance
diff --git a/src/test/java/org/rundeck/api/generator/ProjectConfigGeneratorTest.java b/src/test/java/org/rundeck/api/generator/ProjectConfigGeneratorTest.java
new file mode 100644
index 0000000..aa6d5da
--- /dev/null
+++ b/src/test/java/org/rundeck/api/generator/ProjectConfigGeneratorTest.java
@@ -0,0 +1,41 @@
+package org.rundeck.api.generator;
+
+import junit.framework.Assert;
+import org.dom4j.Document;
+import org.dom4j.Element;
+import org.dom4j.io.XMLWriter;
+import org.junit.Test;
+import org.rundeck.api.domain.ProjectConfig;
+import org.rundeck.api.domain.RundeckProject;
+
+import java.io.UnsupportedEncodingException;
+
+/**
+ * ProjectConfigGeneratorTest is ...
+ *
+ * @author greg
+ * @since 2014-02-27
+ */
+public class ProjectConfigGeneratorTest {
+ @Test
+ public void generate() throws Exception {
+ ProjectConfig config = new ProjectConfig();
+ config.setProperty("abc", "123");
+ config.setProperty("monkey.bonanza", "pale\ncomparison");
+
+ Document doc = new ProjectConfigGenerator(config).generateXmlDocument();
+ XMLWriter xmlWriter = new XMLWriter(System.out);
+ xmlWriter.write(doc);
+ xmlWriter.flush();
+ Element configElement = doc.getRootElement();
+ Assert.assertEquals("config", configElement.getName());
+ Assert.assertNotNull(configElement.selectSingleNode("property[1]"));
+ Assert.assertEquals("abc", configElement.selectSingleNode("property[1]/@key").getText());
+ Assert.assertEquals("123", configElement.selectSingleNode("property[1]/@value").getText());
+
+ Assert.assertNotNull(configElement.selectSingleNode("property[2]"));
+ Assert.assertEquals("monkey.bonanza", configElement.selectSingleNode("property[2]/@key").getText());
+ Assert.assertEquals("pale\ncomparison", configElement.selectSingleNode("property[2]/@value").getText());
+
+ }
+}
diff --git a/src/test/java/org/rundeck/api/generator/ProjectGeneratorTest.java b/src/test/java/org/rundeck/api/generator/ProjectGeneratorTest.java
new file mode 100644
index 0000000..26beb33
--- /dev/null
+++ b/src/test/java/org/rundeck/api/generator/ProjectGeneratorTest.java
@@ -0,0 +1,25 @@
+package org.rundeck.api.generator;
+
+import junit.framework.Assert;
+import org.dom4j.Document;
+import org.junit.Test;
+import org.rundeck.api.domain.RundeckProject;
+
+/**
+ * ProjectGeneratorTest is ...
+ *
+ * @author greg
+ * @since 2014-02-27
+ */
+public class ProjectGeneratorTest {
+ @Test
+ public void generate() {
+ RundeckProject project = new RundeckProject();
+ project.setName("monkey1");
+
+ Document doc = new ProjectGenerator(project).generateXmlDocument();
+ Assert.assertEquals("project", doc.getRootElement().getName());
+ Assert.assertNotNull(doc.selectSingleNode("/project/name"));
+ Assert.assertEquals("monkey1", doc.selectSingleNode("/project/name").getText());
+ }
+}
diff --git a/src/test/java/org/rundeck/api/parser/BaseStateParserTest.java b/src/test/java/org/rundeck/api/parser/BaseStateParserTest.java
new file mode 100644
index 0000000..3c17f27
--- /dev/null
+++ b/src/test/java/org/rundeck/api/parser/BaseStateParserTest.java
@@ -0,0 +1,40 @@
+package org.rundeck.api.parser;
+
+import junit.framework.Assert;
+import org.dom4j.Document;
+import org.junit.Test;
+import org.rundeck.api.domain.BaseState;
+import org.rundeck.api.domain.RundeckWFExecState;
+
+import java.io.InputStream;
+import java.util.Date;
+
+/**
+ * $INTERFACE is ... User: greg Date: 1/18/14 Time: 8:33 AM
+ */
+public class BaseStateParserTest {
+ @Test
+ public void testBase1(){
+ InputStream input = getClass().getResourceAsStream("execution-state1.xml");
+ Document document = ParserHelper.loadDocument(input);
+ BaseState baseState = new BaseState();
+ BaseStateParser.parseBaseState(document.selectSingleNode("/result/executionState"), baseState);
+
+ Assert.assertEquals(1390066160000L, baseState.getEndTime().getTime());
+ Assert.assertEquals(1390066159000L, baseState.getStartTime().getTime());
+ Assert.assertEquals(1390066160000L, baseState.getUpdateTime().getTime());
+ Assert.assertEquals(RundeckWFExecState.SUCCEEDED, baseState.getExecutionState());
+ }
+ @Test
+ public void testBase2(){
+ InputStream input = getClass().getResourceAsStream("execution-state1.xml");
+ Document document = ParserHelper.loadDocument(input);
+ BaseState baseState = new BaseState();
+ BaseStateParser.parseBaseState(document.selectSingleNode("/result/executionState/steps/step[1]"), baseState);
+
+ Assert.assertEquals(1390066159000L, baseState.getStartTime().getTime());
+ Assert.assertEquals(1390066160000L, baseState.getEndTime().getTime());
+ Assert.assertEquals(1390066160000L, baseState.getUpdateTime().getTime());
+ Assert.assertEquals(RundeckWFExecState.SUCCEEDED, baseState.getExecutionState());
+ }
+}
diff --git a/src/test/java/org/rundeck/api/parser/ExecutionParserTest.java b/src/test/java/org/rundeck/api/parser/ExecutionParserTest.java
index 0e4daa4..b34cbb5 100644
--- a/src/test/java/org/rundeck/api/parser/ExecutionParserTest.java
+++ b/src/test/java/org/rundeck/api/parser/ExecutionParserTest.java
@@ -16,13 +16,17 @@
package org.rundeck.api.parser;
import java.io.InputStream;
+import java.util.Arrays;
import java.util.Date;
+import java.util.HashSet;
+
import org.dom4j.Document;
import org.junit.Assert;
import org.junit.Test;
import org.rundeck.api.domain.RundeckExecution;
import org.rundeck.api.domain.RundeckJob;
import org.rundeck.api.domain.RundeckExecution.ExecutionStatus;
+import org.rundeck.api.domain.RundeckNodeIdentity;
/**
* Test the {@link ExecutionParser}
@@ -156,4 +160,47 @@ public class ExecutionParserTest {
}
+ @Test
+ public void parseV10Execution() throws Exception {
+ InputStream input = getClass().getResourceAsStream("execution-result-v10.xml");
+ Document document = ParserHelper.loadDocument(input);
+
+ RundeckExecution execution = new ExecutionParser("result/executions/execution").parseXmlNode(document);
+ RundeckJob job = execution.getJob();
+
+ Assert.assertNotNull(job);
+ Assert.assertEquals(new Long(146), execution.getId());
+ Assert.assertEquals("http://dignan.local:4440/execution/follow/146", execution.getUrl());
+ Assert.assertEquals(ExecutionStatus.SUCCEEDED, execution.getStatus());
+ Assert.assertEquals("admin", execution.getStartedBy());
+ Assert.assertEquals(new Date(1389894502959L), execution.getStartedAt());
+ Assert.assertEquals(new Date(1389894504561L), execution.getEndedAt());
+ Assert.assertEquals((Long)(1389894504561L- 1389894502959L), execution.getDurationInMillis());
+ Assert.assertEquals(null, execution.getAbortedBy());
+ Assert.assertEquals("fdfd", execution.getProject());
+
+ Assert.assertNotNull(execution.getSuccessfulNodes());
+ Assert.assertEquals(3, execution.getSuccessfulNodes().size());
+
+ HashSet expectedSuccess = new HashSet();
+ expectedSuccess.addAll(Arrays.asList(
+ "node-111.qa.subgroup.mycompany.com",
+ "node-6.qa.subgroup.mycompany.com",
+ "node-14.qa.subgroup.mycompany.com"));
+ for (RundeckNodeIdentity rundeckNodeIdentity : execution.getSuccessfulNodes()) {
+ Assert.assertTrue(expectedSuccess.contains(rundeckNodeIdentity.getName()));
+ }
+
+ Assert.assertNotNull(execution.getFailedNodes());
+ Assert.assertEquals(3, execution.getFailedNodes().size());
+ HashSet expectedFailure = new HashSet();
+ expectedFailure.addAll(Arrays.asList(
+ "node-112.qa.subgroup.mycompany.com",
+ "node-62.qa.subgroup.mycompany.com",
+ "node-12.qa.subgroup.mycompany.com"));
+ for (RundeckNodeIdentity rundeckNodeIdentity : execution.getFailedNodes()) {
+ Assert.assertTrue(expectedFailure.contains(rundeckNodeIdentity.getName()));
+ }
+ }
+
}
diff --git a/src/test/java/org/rundeck/api/parser/ExecutionStateParserTest.java b/src/test/java/org/rundeck/api/parser/ExecutionStateParserTest.java
new file mode 100644
index 0000000..c8170bd
--- /dev/null
+++ b/src/test/java/org/rundeck/api/parser/ExecutionStateParserTest.java
@@ -0,0 +1,43 @@
+package org.rundeck.api.parser;
+
+import junit.framework.Assert;
+import org.dom4j.Document;
+import org.junit.Test;
+import org.rundeck.api.domain.RundeckExecutionState;
+import org.rundeck.api.domain.RundeckNodeIdentity;
+
+import java.io.InputStream;
+import java.util.Arrays;
+import java.util.HashSet;
+
+/**
+ * $INTERFACE is ... User: greg Date: 1/16/14 Time: 5:42 PM
+ */
+public class ExecutionStateParserTest {
+ @Test
+ public void testBasic(){
+ InputStream input = getClass().getResourceAsStream("execution-state1.xml");
+ Document document = ParserHelper.loadDocument(input);
+
+ RundeckExecutionState execution = new ExecutionStateParser("/result/executionState").parseXmlNode
+ (document);
+
+ Assert.assertEquals(149L, execution.getExecutionId());
+
+ HashSet expectedTargetNodes = new HashSet(Arrays.asList(
+ "node-111.qa.subgroup.mycompany.com",
+ "node-14.qa.subgroup.mycompany.com",
+ "node-6.qa.subgroup.mycompany.com"
+ ));
+
+ Assert.assertEquals(3, execution.getAllNodes().size());
+ for (RundeckNodeIdentity rundeckNodeIdentity : execution.getAllNodes()) {
+ Assert.assertTrue(expectedTargetNodes.contains(rundeckNodeIdentity.getName()));
+ }
+
+ Assert.assertEquals(3,execution.getNodeStates().size());
+ for (String s : execution.getNodeStates().keySet()) {
+ Assert.assertTrue(expectedTargetNodes.contains(s));
+ }
+ }
+}
diff --git a/src/test/java/org/rundeck/api/parser/IndexedWorkflowStepStateParserTest.java b/src/test/java/org/rundeck/api/parser/IndexedWorkflowStepStateParserTest.java
new file mode 100644
index 0000000..7b865c8
--- /dev/null
+++ b/src/test/java/org/rundeck/api/parser/IndexedWorkflowStepStateParserTest.java
@@ -0,0 +1,73 @@
+package org.rundeck.api.parser;
+
+import junit.framework.Assert;
+import org.dom4j.Document;
+import org.dom4j.DocumentException;
+import org.dom4j.DocumentHelper;
+import org.dom4j.Element;
+import org.junit.Test;
+import org.rundeck.api.domain.WorkflowState;
+import org.rundeck.api.domain.WorkflowStepContextState;
+import org.rundeck.api.domain.WorkflowStepState;
+
+import java.util.Arrays;
+import java.util.HashMap;
+
+/**
+ * $INTERFACE is ... User: greg Date: 1/18/14 Time: 9:57 AM
+ */
+public class IndexedWorkflowStepStateParserTest {
+ @Test
+ public void testLookupContextSimple1(){
+ WorkflowState workflowState = new WorkflowState();
+ WorkflowStepState step1 = new WorkflowStepState();
+ workflowState.setSteps(Arrays.asList(step1));
+ WorkflowStepState stepState = IndexedWorkflowStepStateParser.lookupContext("1", workflowState);
+ Assert.assertEquals(step1,stepState);
+ }
+ @Test
+ public void testLookupContextSimple2(){
+ WorkflowState workflowState = new WorkflowState();
+ WorkflowStepState step1 = new WorkflowStepState();
+ WorkflowStepState step2 = new WorkflowStepState();
+ workflowState.setSteps(Arrays.asList(step1,step2));
+ WorkflowStepState stepState = IndexedWorkflowStepStateParser.lookupContext("2", workflowState);
+ Assert.assertEquals(step2,stepState);
+ }
+ @Test
+ public void testLookupContextDescend1(){
+ WorkflowState workflowState = new WorkflowState();
+ WorkflowStepState step1 = new WorkflowStepState();
+ WorkflowStepState step2 = new WorkflowStepState();
+ WorkflowState sub1 = new WorkflowState();
+ step2.setSubWorkflow(sub1);
+ workflowState.setSteps(Arrays.asList(step1,step2));
+
+ WorkflowStepState step21 = new WorkflowStepState();
+ sub1.setSteps(Arrays.asList(step21));
+
+ WorkflowStepState stepState = IndexedWorkflowStepStateParser.lookupContext("2/1", workflowState);
+ Assert.assertEquals(step21,stepState);
+ }
+ @Test
+ public void testParse1() throws DocumentException {
+ WorkflowState workflowState = new WorkflowState();
+ WorkflowStepState step1 = new WorkflowStepState();
+ WorkflowStepState step2 = new WorkflowStepState();
+ WorkflowState sub1 = new WorkflowState();
+ step2.setSubWorkflow(sub1);
+ workflowState.setSteps(Arrays.asList(step1,step2));
+
+ WorkflowStepState step21 = new WorkflowStepState();
+ sub1.setSteps(Arrays.asList(step21));
+ HashMap nodeStates = new HashMap();
+ WorkflowStepContextState nodeState1 = new WorkflowStepContextState();
+ nodeStates.put("dignan", nodeState1);
+ step21.setNodeStates(nodeStates);
+
+ Document document = DocumentHelper.parseText("2/1 ");
+
+ WorkflowStepContextState result = new IndexedWorkflowStepStateParser(workflowState,"dignan").parseXmlNode(document);
+ Assert.assertEquals(nodeState1,result);
+ }
+}
diff --git a/src/test/java/org/rundeck/api/parser/OutputEntryParserTest.java b/src/test/java/org/rundeck/api/parser/OutputEntryParserTest.java
new file mode 100644
index 0000000..40b1155
--- /dev/null
+++ b/src/test/java/org/rundeck/api/parser/OutputEntryParserTest.java
@@ -0,0 +1,55 @@
+package org.rundeck.api.parser;
+
+import org.dom4j.Document;
+import org.junit.Assert;
+import org.junit.Test;
+import org.rundeck.api.domain.RundeckOutputEntry;
+
+import java.io.InputStream;
+import java.util.Date;
+
+/**
+ * $INTERFACE is ... User: greg Date: 1/16/14 Time: 4:35 PM
+ */
+public class OutputEntryParserTest {
+ @Test
+ public void testEntryBasic() {
+ InputStream input = getClass().getResourceAsStream("output1.xml");
+ Document document = ParserHelper.loadDocument(input);
+ OutputEntryParser outputEntryParser = new OutputEntryParser("//entry[1]");
+
+ RundeckOutputEntry rundeckOutputEntry = outputEntryParser.parseXmlNode(document);
+ Assert.assertEquals("hi there", rundeckOutputEntry.getMessage());
+ Assert.assertEquals(null, rundeckOutputEntry.getCommand());
+ Assert.assertEquals(RundeckOutputEntry.RundeckLogLevel.NORMAL, rundeckOutputEntry.getLevel());
+ Assert.assertEquals("node-111.qa.subgroup.mycompany.com", rundeckOutputEntry.getNode());
+ Assert.assertEquals("09:48:23", rundeckOutputEntry.getTime());
+ Assert.assertEquals(new Date(1389894503000L), rundeckOutputEntry.getAbsoluteTime());
+ Assert.assertEquals(null, rundeckOutputEntry.getType());
+ Assert.assertEquals("Raif", rundeckOutputEntry.getUser());
+ Assert.assertNotNull(rundeckOutputEntry.getMetadata());
+ Assert.assertNotNull(rundeckOutputEntry.getMetadata().get("stepctx"));
+ Assert.assertEquals("1",rundeckOutputEntry.getMetadata().get("stepctx"));
+ }
+ @Test
+ public void testEntryState() {
+ InputStream input = getClass().getResourceAsStream("output-state.xml");
+ Document document = ParserHelper.loadDocument(input);
+ OutputEntryParser outputEntryParser = new OutputEntryParser("//entry[1]");
+
+ RundeckOutputEntry rundeckOutputEntry = outputEntryParser.parseXmlNode(document);
+ Assert.assertEquals(null, rundeckOutputEntry.getMessage());
+ Assert.assertEquals(null, rundeckOutputEntry.getCommand());
+ Assert.assertEquals(RundeckOutputEntry.RundeckLogLevel.NORMAL, rundeckOutputEntry.getLevel());
+ Assert.assertEquals("dignan", rundeckOutputEntry.getNode());
+ Assert.assertEquals("09:48:23", rundeckOutputEntry.getTime());
+ Assert.assertEquals(new Date(1389894503000L), rundeckOutputEntry.getAbsoluteTime());
+ Assert.assertEquals("stepbegin", rundeckOutputEntry.getType());
+ Assert.assertEquals("admin", rundeckOutputEntry.getUser());
+ Assert.assertNotNull(rundeckOutputEntry.getMetadata());
+ Assert.assertNotNull(rundeckOutputEntry.getMetadata().get("stepctx"));
+ Assert.assertEquals("1",rundeckOutputEntry.getMetadata().get("stepctx"));
+ Assert.assertNotNull(rundeckOutputEntry.getMetadata().get("step"));
+ Assert.assertEquals("1",rundeckOutputEntry.getMetadata().get("step"));
+ }
+}
diff --git a/src/test/java/org/rundeck/api/parser/OutputParserTest.java b/src/test/java/org/rundeck/api/parser/OutputParserTest.java
new file mode 100644
index 0000000..dec471a
--- /dev/null
+++ b/src/test/java/org/rundeck/api/parser/OutputParserTest.java
@@ -0,0 +1,85 @@
+package org.rundeck.api.parser;
+
+import org.dom4j.Document;
+import org.junit.Assert;
+import org.junit.Test;
+import org.rundeck.api.domain.RundeckExecution;
+import org.rundeck.api.domain.RundeckOutput;
+import org.rundeck.api.domain.RundeckProject;
+
+import java.io.InputStream;
+
+/**
+ * $INTERFACE is ... User: greg Date: 1/16/14 Time: 4:24 PM
+ */
+public class OutputParserTest {
+ @Test
+ public void parseOutputBasic() throws Exception {
+ InputStream input = getClass().getResourceAsStream("output1.xml");
+ Document document = ParserHelper.loadDocument(input);
+
+ RundeckOutput output = new OutputParser("result/output", new OutputEntryParser()).parseXmlNode(document);
+
+ Assert.assertEquals(new Long(1602), output.getExecDuration());
+ Assert.assertEquals(new Long(146), output.getExecutionId());
+ Assert.assertEquals(new Long(1389894504000L), output.getLastModified());
+ Assert.assertEquals(null, output.getFilterNode());
+ Assert.assertEquals(null, output.getFilterStep());
+ Assert.assertEquals(1409, output.getOffset());
+ Assert.assertEquals(RundeckExecution.ExecutionStatus.SUCCEEDED, output.getStatus());
+ Assert.assertEquals(new Float(99.9), output.getPercentLoaded());
+ Assert.assertEquals(1415, output.getTotalSize());
+ Assert.assertEquals(true, output.isCompleted());
+ Assert.assertEquals(true, output.isExecCompleted());
+ Assert.assertEquals(false, output.isEmpty());
+ Assert.assertEquals(false, output.isHasFailedNodes());
+ Assert.assertEquals(false, output.isUnmodified());
+ Assert.assertEquals(3, output.getLogEntries().size());
+ }
+ @Test
+ public void parseOutputFiltered() throws Exception {
+ InputStream input = getClass().getResourceAsStream("output-filtered.xml");
+ Document document = ParserHelper.loadDocument(input);
+
+ RundeckOutput output = new OutputParser("result/output", new OutputEntryParser()).parseXmlNode(document);
+
+ Assert.assertEquals(new Long(1602), output.getExecDuration());
+ Assert.assertEquals(new Long(146), output.getExecutionId());
+ Assert.assertEquals(new Long(1389894504000L), output.getLastModified());
+ Assert.assertEquals("node-111.qa.subgroup.mycompany.com", output.getFilterNode());
+ Assert.assertEquals("1", output.getFilterStep());
+ Assert.assertEquals(1409, output.getOffset());
+ Assert.assertEquals(RundeckExecution.ExecutionStatus.SUCCEEDED, output.getStatus());
+ Assert.assertEquals(new Float(99.9), output.getPercentLoaded());
+ Assert.assertEquals(1415, output.getTotalSize());
+ Assert.assertEquals(true, output.isCompleted());
+ Assert.assertEquals(true, output.isExecCompleted());
+ Assert.assertEquals(false, output.isEmpty());
+ Assert.assertEquals(false, output.isHasFailedNodes());
+ Assert.assertEquals(false, output.isUnmodified());
+ Assert.assertEquals(1, output.getLogEntries().size());
+ }
+ @Test
+ public void parseOutputUnmodified() throws Exception {
+ InputStream input = getClass().getResourceAsStream("output-unmodified.xml");
+ Document document = ParserHelper.loadDocument(input);
+
+ RundeckOutput output = new OutputParser("result/output", new OutputEntryParser()).parseXmlNode(document);
+
+ Assert.assertEquals(new Long(1602), output.getExecDuration());
+ Assert.assertEquals(new Long(146), output.getExecutionId());
+ Assert.assertEquals(new Long(1389894504000L), output.getLastModified());
+ Assert.assertEquals(null, output.getFilterNode());
+ Assert.assertEquals(null, output.getFilterStep());
+ Assert.assertEquals(0, output.getOffset());
+ Assert.assertEquals(RundeckExecution.ExecutionStatus.SUCCEEDED, output.getStatus());
+ Assert.assertEquals(null, output.getPercentLoaded());
+ Assert.assertEquals(1415, output.getTotalSize());
+ Assert.assertEquals(true, output.isCompleted());
+ Assert.assertEquals(true, output.isExecCompleted());
+ Assert.assertEquals(false, output.isEmpty());
+ Assert.assertEquals(false, output.isHasFailedNodes());
+ Assert.assertEquals(true, output.isUnmodified());
+ Assert.assertEquals(null, output.getLogEntries());
+ }
+}
diff --git a/src/test/java/org/rundeck/api/parser/ProjectConfigParserTest.java b/src/test/java/org/rundeck/api/parser/ProjectConfigParserTest.java
new file mode 100644
index 0000000..cee0f6f
--- /dev/null
+++ b/src/test/java/org/rundeck/api/parser/ProjectConfigParserTest.java
@@ -0,0 +1,51 @@
+package org.rundeck.api.parser;
+
+import org.dom4j.Document;
+import org.junit.Assert;
+import org.junit.Test;
+import org.rundeck.api.domain.ProjectConfig;
+import org.rundeck.api.domain.RundeckProject;
+
+import java.io.InputStream;
+
+/**
+ * ProjectConfigParserTest is ...
+ *
+ * @author greg
+ * @since 2014-02-27
+ */
+public class ProjectConfigParserTest {
+ @Test
+ public void parseProject() throws Exception {
+ InputStream input = getClass().getResourceAsStream("projectv11.xml");
+ Document document = ParserHelper.loadDocument(input);
+
+ ProjectConfig config = new ProjectConfigParser("project/config").parseXmlNode(document);
+
+ Assert.assertEquals(10, config.getProperties().size());
+ Assert.assertEquals("ziggy", config.getProperties().get("project.name"));
+ Assert.assertEquals("false", config.getProperties().get("resources.source.1.config.requireFileExists"));
+ Assert.assertEquals("privateKey", config.getProperties().get("project.ssh-authentication"));
+ Assert.assertEquals("jsch-ssh", config.getProperties().get("service.NodeExecutor.default.provider"));
+ Assert.assertEquals("false", config.getProperties().get("resources.source.1.config.includeServerNode"));
+ Assert.assertEquals("false", config.getProperties().get("resources.source.1.config.generateFileAutomatically"));
+ Assert.assertEquals("/var/rundeck/projects/${project.name}/etc/resources.xml",
+ config.getProperties().get("resources.source.1.config.file"));
+ Assert.assertEquals("/var/lib/rundeck/.ssh/id_rsa", config.getProperties().get("project.ssh-keypath"));
+ Assert.assertEquals("jsch-scp", config.getProperties().get("service.FileCopier.default.provider"));
+ Assert.assertEquals("file", config.getProperties().get("resources.source.1.type"));
+ /*
+ expectedTargetNodes = new HashSet(Arrays.asList(
+ "node-111.qa.subgroup.mycompany.com",
+ "node-14.qa.subgroup.mycompany.com",
+ "node-6.qa.subgroup.mycompany.com"
+ ));
+ for (RundeckNodeIdentity rundeckNodeIdentity : execution.getTargetNodes()) {
+ Assert.assertTrue(expectedTargetNodes.contains(rundeckNodeIdentity.getName()));
+ }
+
+ //
+ Assert.assertEquals(1,execution.getSteps().size());
+ WorkflowStepState step1 = execution.getSteps().get(0);
+ }
+ @Test
+ public void parse(){
+ InputStream input = getClass().getResourceAsStream("execution-state2.xml");
+ Document document = ParserHelper.loadDocument(input);
+
+ WorkflowState execution = new WorkflowStateParser("result/executionState").parseXmlNode(document);
+ Assert.assertEquals(1390066061000L, execution.getStartTime().getTime());
+ Assert.assertEquals(null, execution.getEndTime());
+ Assert.assertEquals(1390066067000L, execution.getUpdateTime().getTime());
+ Assert.assertEquals(RundeckWFExecState.RUNNING, execution.getExecutionState());
+ Assert.assertEquals(2, execution.getStepCount());
+ Assert.assertEquals(1, execution.getTargetNodes().size());
+ HashSet expectedTargetNodes = new HashSet