public DispatcherResult killDispatcherExecution(final String execId)
throws CentralDispatcherException {
final HashMap<String, String> params = new HashMap<String, String>();
final String rundeckApiKillJobPath =
substitutePathVariable(RUNDECK_API_KILL_JOB_PATH, "id", execId);
// 2. send request via ServerService
final WebserviceResponse response;
try {
response = serverService.makeRundeckRequest(rundeckApiKillJobPath, params, null, null);
} catch (MalformedURLException e) {
throw new CentralDispatcherServerRequestException("Failed to make request", e);
}
final Envelope envelope = validateResponse(response);
final Node result1 = envelope.doc.selectSingleNode("result");
final String abortStatus = result1.selectSingleNode("abort/@status").getStringValue();
final boolean result = !"failed".equals(abortStatus);
final StringBuffer sb = envelope.successMessages();
return new DispatcherResult() {
public boolean isSuccessful() {
return result;
}
public String getMessage() {
return sb.toString();
}
};
}
public DispatcherResult killDispatcherExecution(final String execId)
throws CentralDispatcherException {
final HashMap<String, String> params = new HashMap<String, String>();
params.put("id", execId);
params.put("xmlreq", "true");
// 2. send request via ServerService
final WebserviceResponse response;
try {
response = serverService.makeRundeckRequest(RUNDECK_KILL_JOB_PATH, params, null, null);
} catch (MalformedURLException e) {
throw new CentralDispatcherServerRequestException("Failed to make request", e);
}
final Envelope envelope = validateResponse(response);
final boolean result = envelope.isSuccessResult();
final StringBuffer sb = envelope.successMessages();
return new DispatcherResult() {
public boolean isSuccessful() {
return result;
}
public String getMessage() {
return sb.toString();
}
};
}
/**
* List the items on the dispatcher queue for a project
*
* @param project Project name
* @return Collection of Strings listing the active dispatcher queue items
* @throws CentralDispatcherException if an error occurs
*/
public Collection<QueuedItem> listDispatcherQueue(final String project)
throws CentralDispatcherException {
if (null == project) {
throw new CentralDispatcherException(
"Unsupported operation: project is required by the RunDeck API");
}
final HashMap<String, String> params = new HashMap<String, String>();
params.put("project", project);
final WebserviceResponse response;
try {
response =
serverService.makeRundeckRequest(RUNDECK_API_LIST_EXECUTIONS_PATH, params, null, null);
} catch (MalformedURLException e) {
throw new CentralDispatcherServerRequestException("Failed to make request", e);
}
validateResponse(response);
////////////////////
// parse result list of queued items, return the collection of QueuedItems
///////////////////
return parseExecutionListResult(response);
}
/**
* Submit a request to the server which expects an execution id in response, and return a single
* QueuedItemResult parsed from the response.
*
* @param tempxml xml temp file (or null)
* @param otherparams parameters for the request
* @param requestPath
* @return a single QueuedItemResult
* @throws com.dtolabs.rundeck.core.dispatcher.CentralDispatcherException if an error occurs
*/
private QueuedItemResult submitRunRequest(
final File tempxml, final HashMap<String, String> otherparams, final String requestPath)
throws CentralDispatcherException {
final HashMap<String, String> params = new HashMap<String, String>();
if (null != otherparams) {
params.putAll(otherparams);
}
final WebserviceResponse response;
try {
response = serverService.makeRundeckRequest(requestPath, params, tempxml, null);
} catch (MalformedURLException e) {
throw new CentralDispatcherServerRequestException("Failed to make request", e);
}
validateResponse(response);
final Document resultDoc = response.getResultDoc();
if (null != resultDoc.selectSingleNode("/result/execution")
&& null != resultDoc.selectSingleNode("/result/execution/@id")) {
final Node node = resultDoc.selectSingleNode("/result/execution/@id");
final String succeededId = node.getStringValue();
final String name = "adhoc";
String url = createExecutionURL(succeededId);
url = makeAbsoluteURL(url);
logger.info("\t[" + succeededId + "] <" + url + ">");
return QueuedItemResultImpl.successful("Succeeded queueing " + name, succeededId, url, name);
}
return QueuedItemResultImpl.failed("Server response contained no success information.");
}
/**
* Submit a request to the server which expects a list of execution items in the response, and
* return a single QueuedItemResult parsed from the response.
*
* @param tempxml xml temp file (or null)
* @param otherparams parameters for the request
* @param requestPath
* @return a single QueuedItemResult
* @throws com.dtolabs.rundeck.core.dispatcher.CentralDispatcherException if an error occurs
*/
private QueuedItemResult submitExecutionRequest(
final File tempxml, final HashMap<String, String> otherparams, final String requestPath)
throws CentralDispatcherException {
final HashMap<String, String> params = new HashMap<String, String>();
if (null != otherparams) {
params.putAll(otherparams);
}
final WebserviceResponse response;
try {
response = serverService.makeRundeckRequest(requestPath, params, tempxml, null);
} catch (MalformedURLException e) {
throw new CentralDispatcherServerRequestException("Failed to make request", e);
}
validateResponse(response);
final ArrayList<QueuedItem> list = parseExecutionListResult(response);
if (null == list || list.size() < 1) {
return QueuedItemResultImpl.failed("Server response contained no success information.");
} else {
final QueuedItem next = list.iterator().next();
return QueuedItemResultImpl.successful(
"Succeeded queueing " + next.getName(), next.getId(), next.getUrl(), next.getName());
}
}
/**
* If the url appears relative to an authority, i.e. it starts with "/", then convert it to be
* absolute using the server URL (including context path) provided by the ServerService.
*
* @param url a context-relative url path to convert into absolute url.
* @return absolute URL if input was a url path, otherwise returns the input string.
*/
String makeContextAbsoluteURL(String url) {
if (null != url && url.startsWith("/")) {
// change relative URL into absolute using the base server URL
try {
final URL newUrl = new URL(serverService.getConnParams().getServerUrl() + url);
url = newUrl.toExternalForm();
} catch (MalformedURLException e) {
e.printStackTrace();
}
}
return url;
}
public Collection<IStoredJob> reallistStoredJobs(final IStoredJobsQuery iStoredJobsQuery)
throws CentralDispatcherException {
final HashMap<String, String> params = new HashMap<String, String>();
final String nameMatch = iStoredJobsQuery.getNameMatch();
String groupMatch = iStoredJobsQuery.getGroupMatch();
final String projectFilter = iStoredJobsQuery.getProjectFilter();
final String idlistFilter = iStoredJobsQuery.getIdlist();
if (null != nameMatch) {
params.put("jobExactFilter", nameMatch);
}
if (null != groupMatch) {
final Matcher matcher = Pattern.compile("^/*(.+?)/*$").matcher(groupMatch);
if (matcher.matches()) {
// strip leading and trailing slashes
groupMatch = matcher.group(1);
}
params.put("groupPathExact", groupMatch);
}
if (null != projectFilter) {
params.put("project", projectFilter);
}
if (null != idlistFilter) {
params.put("idlist", idlistFilter);
}
// 2. send request via ServerService
final WebserviceResponse response;
try {
response = serverService.makeRundeckRequest(RUNDECK_API_JOBS_LIST_PATH, params, null, null);
} catch (MalformedURLException e) {
throw new CentralDispatcherServerRequestException("Failed to make request", e);
}
validateResponse(response);
// extract job list
final Document resultDoc = response.getResultDoc();
final ArrayList<IStoredJob> list = new ArrayList<IStoredJob>();
final Node jobs = resultDoc.selectSingleNode("/result/jobs");
for (final Object job1 : jobs.selectNodes("job")) {
final Node job = (Node) job1;
final String id = job.selectSingleNode("@id").getStringValue();
final String name = job.selectSingleNode("name").getStringValue();
final String group = job.selectSingleNode("group").getStringValue();
final String desc = job.selectSingleNode("description").getStringValue();
final String url = createJobURL(id);
list.add(StoredJobImpl.create(id, name, url, group, desc, projectFilter));
}
return list;
}
/**
* Report execution status
*
* @param project project
* @param title execution title
* @param status result status, either 'succeed','cancel','fail'
* @param failedNodeCount total node count
* @param successNodeCount count of successful nodes
* @param tags
* @param script script content (can be null if summary specified)
* @param summary summary of execution (can be null if script specified)
* @param start start date (can be null)
* @param end end date (can be null)
* @throws com.dtolabs.rundeck.core.dispatcher.CentralDispatcherException
*/
public void reportExecutionStatus(
final String project,
final String title,
final String status,
final int failedNodeCount,
final int successNodeCount,
final String tags,
final String script,
final String summary,
final Date start,
final Date end)
throws CentralDispatcherException {
final HashMap<String, String> params = new HashMap<String, String>();
params.put("project", project);
params.put("title", title);
params.put("status", status);
params.put("nodesuccesscount", Integer.toString(successNodeCount));
params.put("nodefailcount", Integer.toString(failedNodeCount));
if (null != tags) {
params.put("tags", tags);
}
if (null != script) {
params.put("script", script);
}
params.put("summary", summary);
if (null != start) {
params.put("start", Long.toString(start.getTime()));
}
if (null != end) {
params.put("end", Long.toString(end.getTime()));
}
final WebserviceResponse response;
try {
response = serverService.makeRundeckRequest(RUNDECK_API_EXECUTION_REPORT, params, null, null);
} catch (MalformedURLException e) {
throw new CentralDispatcherServerRequestException("Failed to make request", e);
}
validateResponse(response);
}
public Collection<QueuedItem> listDispatcherQueue() throws CentralDispatcherException {
final HashMap<String, String> params = new HashMap<String, String>();
params.put("xmlreq", "true");
final WebserviceResponse response;
try {
response = serverService.makeRundeckRequest(RUNDECK_LIST_EXECUTIONS_PATH, params, null, null);
} catch (MalformedURLException e) {
throw new CentralDispatcherServerRequestException("Failed to make request", e);
}
validateResponse(response);
////////////////////
// parse result list of queued items, return the collection of QueuedItems
///////////////////
final Document resultDoc = response.getResultDoc();
final Node node = resultDoc.selectSingleNode("/result/items");
final List items = node.selectNodes("item");
final ArrayList<QueuedItem> list = new ArrayList<QueuedItem>();
if (null != items && items.size() > 0) {
for (final Object o : items) {
final Node node1 = (Node) o;
final String id = node1.selectSingleNode("id").getStringValue();
final String name = node1.selectSingleNode("name").getStringValue();
String url = node1.selectSingleNode("url").getStringValue();
url = makeAbsoluteURL(url);
logger.info("\t" + ": " + name + " [" + id + "] <" + url + ">");
list.add(QueuedItemResultImpl.createQueuedItem(id, url, name));
}
}
return list;
}
public Collection<IStoredJobLoadResult> loadJobs(ILoadJobsRequest iLoadJobsRequest, File input)
throws CentralDispatcherException {
final HashMap params = new HashMap();
params.put("dupeOption", iLoadJobsRequest.getDuplicateOption().toString());
params.put("xmlreq", "true");
/*
* Send the request bean and the file as a multipart request.
*/
// 2. send request via ServerService
final WebserviceResponse response;
try {
response = serverService.makeRundeckRequest(RUNDECK_JOBS_UPLOAD, params, input, null);
} catch (MalformedURLException e) {
throw new CentralDispatcherServerRequestException("Failed to make request", e);
}
validateResponse(response);
////////////////////
// parse result list of queued items, return the collection of QueuedItems
///////////////////
final Document result = response.getResultDoc();
final int succeeded;
final int failed;
final int skipped;
Node node = result.selectSingleNode("/result/succeeded/@count");
if (null != node) {
succeeded = Integer.parseInt(node.getStringValue());
} else {
succeeded = -1;
}
node = result.selectSingleNode("/result/failed/@count");
if (null != node) {
failed = Integer.parseInt(node.getStringValue());
} else {
failed = -1;
}
node = result.selectSingleNode("/result/skipped/@count");
if (null != node) {
skipped = Integer.parseInt(node.getStringValue());
} else {
skipped = -1;
}
ArrayList<IStoredJobLoadResult> resultList = new ArrayList<IStoredJobLoadResult>();
if (succeeded > 0) {
logger.debug("Succeeded creating/updating " + succeeded + " Jobs:");
final List nodes = result.selectNodes("/result/succeeded/job");
for (final Object node2 : nodes) {
final Node node1 = (Node) node2;
final IStoredJobLoadResult storedJobLoadResult =
parseStoredJobResult(node1, true, false, "Succeeded");
resultList.add(storedJobLoadResult);
}
}
if (failed > 0) {
logger.debug("Failed to add " + failed + " Jobs:");
final List nodes = result.selectNodes("/result/failed/job");
for (final Object node2 : nodes) {
final Node node1 = (Node) node2;
final String error =
null != node1.selectSingleNode("error")
? node1.selectSingleNode("error").getStringValue()
: "Failed";
final IStoredJobLoadResult storedJobLoadResult =
parseStoredJobResult(node1, false, false, error);
resultList.add(storedJobLoadResult);
}
}
if (skipped > 0) {
logger.debug("Skipped " + skipped + " Jobs:");
final List nodes = result.selectNodes("/result/skipped/job");
for (final Object node2 : nodes) {
final Node node1 = (Node) node2;
final String error =
null != node1.selectSingleNode("error")
? node1.selectSingleNode("error").getStringValue()
: "Skipped";
final IStoredJobLoadResult storedJobLoadResult =
parseStoredJobResult(node1, true, true, error);
resultList.add(storedJobLoadResult);
}
}
return resultList;
}
public Collection<IStoredJob> listStoredJobs(
final IStoredJobsQuery iStoredJobsQuery, final OutputStream output)
throws CentralDispatcherException {
final HashMap<String, String> params = new HashMap<String, String>();
params.put("xmlreq", "true");
final String nameMatch = iStoredJobsQuery.getNameMatch();
String groupMatch = iStoredJobsQuery.getGroupMatch();
final String projectFilter = iStoredJobsQuery.getProjectFilter();
final String commandFilter = iStoredJobsQuery.getCommand();
final String idlistFilter = iStoredJobsQuery.getIdlist();
final String typeFilter = iStoredJobsQuery.getType();
final String resourceFilter = iStoredJobsQuery.getResource();
if (null != nameMatch) {
params.put("jobFilter", nameMatch);
}
if (null != groupMatch) {
final Matcher matcher = Pattern.compile("^/*(.+?)/*$").matcher(groupMatch);
if (matcher.matches()) {
// strip leading and trailing slashes
groupMatch = matcher.group(1);
}
params.put("groupPath", groupMatch);
}
if (null != projectFilter) {
params.put("projFilter", projectFilter);
}
if (null != resourceFilter) {
params.put("objFilter", resourceFilter);
}
if (null != typeFilter) {
params.put("typeFilter", typeFilter);
}
if (null != commandFilter) {
params.put("cmdFilter", commandFilter);
}
if (null != idlistFilter) {
params.put("idlist", idlistFilter);
}
params.put("xmlreq", "true");
// 2. send request via ServerService
final WebserviceResponse response;
try {
response =
serverService.makeRundeckRequest(RUNDECK_LIST_STORED_JOBS_PATH, params, null, null);
} catch (MalformedURLException e) {
throw new CentralDispatcherServerRequestException("Failed to make request", e);
}
validateJobsResponse(response);
////////////////////
// parse result list of queued items, return the collection of QueuedItems
///////////////////
final Document resultDoc = response.getResultDoc();
final Node node = resultDoc.selectSingleNode("/joblist");
final ArrayList<IStoredJob> list = new ArrayList<IStoredJob>();
if (null == node) {
return list;
}
final List items = node.selectNodes("job");
if (null != items && items.size() > 0) {
for (final Object o : items) {
final Node node1 = (Node) o;
final String id = node1.selectSingleNode("id").getStringValue();
final String name = node1.selectSingleNode("name").getStringValue();
final String url = createJobURL(id);
final Node gnode = node1.selectSingleNode("group");
final String group = null != gnode ? gnode.getStringValue() : null;
final String description = node1.selectSingleNode("description").getStringValue();
list.add(StoredJobImpl.create(id, name, url, group, description));
}
}
if (null != output) {
// write output doc to the outputstream
final OutputFormat format = OutputFormat.createPrettyPrint();
try {
final XMLWriter writer = new XMLWriter(output, format);
writer.write(resultDoc);
writer.flush();
} catch (IOException e) {
throw new CentralDispatcherServerRequestException(e);
}
}
return list;
}
/**
* Submit a request to the server which expects a list of queued item results in the response, and
* return a single QueuedItemResult parsed from the response.
*
* @param tempxml xml temp file (or null)
* @param otherparams parameters for the request
* @param requestPath
* @return a single QueuedItemResult
* @throws CentralDispatcherException if an error occurs
*/
private QueuedItemResult submitQueueRequest(
final File tempxml, final HashMap<String, String> otherparams, final String requestPath)
throws CentralDispatcherException {
final HashMap<String, String> params = new HashMap<String, String>();
params.put("xmlreq", "true");
if (null != otherparams) {
params.putAll(otherparams);
}
final WebserviceResponse response;
try {
response = serverService.makeRundeckRequest(requestPath, params, tempxml, null);
} catch (MalformedURLException e) {
throw new CentralDispatcherServerRequestException("Failed to make request", e);
}
validateResponse(response);
////////////////////
// parse result list of execution responses. this implementation handles multiple responses,
// but only
// returns a single QueuedItem (the first one found).
// TODO: update to return multiple QueuedItems when multiple job queue requests are supported
///////////////////
final Document resultDoc = response.getResultDoc();
final int succeeded;
final int failed;
Node node = resultDoc.selectSingleNode("/result/succeeded/@count");
if (null != node) {
succeeded = Integer.parseInt(node.getStringValue());
} else {
succeeded = -1;
}
node = resultDoc.selectSingleNode("/result/failed/@count");
if (null != node) {
failed = Integer.parseInt(node.getStringValue());
} else {
failed = -1;
}
final String succeededId;
if (succeeded > 0) {
logger.info("Succeeded queueing " + succeeded + " Job" + (succeeded > 1 ? "s" : "") + ":");
final List nodes = resultDoc.selectNodes("/result/succeeded/execution");
final Node node1 = (Node) nodes.iterator().next();
final String index = node1.selectSingleNode("@index").getStringValue();
final String id = node1.selectSingleNode("id").getStringValue();
succeededId = id;
final String name = node1.selectSingleNode("name").getStringValue();
String url = node1.selectSingleNode("url").getStringValue();
url = makeAbsoluteURL(url);
logger.info("\t" + index + ": " + name + " [" + id + "] <" + url + ">");
return QueuedItemResultImpl.successful("Succeeded queueing " + name, succeededId, url, name);
}
if (failed > 0) {
final String s1 = "Failed to queue " + failed + " Job" + (failed > 1 ? "s" : "") + ":";
logger.error(s1);
final List nodes = resultDoc.selectNodes("/result/failed/execution");
final Node node1 = (Node) nodes.iterator().next();
final String index = node1.selectSingleNode("@index").getStringValue();
final String id =
null != node1.selectSingleNode("id")
? node1.selectSingleNode("id").getStringValue()
: null;
String url =
null != node1.selectSingleNode("url")
? node1.selectSingleNode("url").getStringValue()
: null;
url = makeAbsoluteURL(url);
final String error =
null != node1.selectSingleNode("error")
? node1.selectSingleNode("error").getStringValue()
: null;
final String message =
null != node1.selectSingleNode("message")
? node1.selectSingleNode("message").getStringValue()
: null;
final String errmsg =
error
+ (null != id ? " [" + id + "] <" + url + ">" : "")
+ (null != message ? " : " + message : "");
final String s2 = index + ": " + errmsg;
logger.error(s2);
return QueuedItemResultImpl.failed(errmsg);
}
return QueuedItemResultImpl.failed("Server response contained no success information.");
}
public Collection<IStoredJob> listStoredJobs(
final IStoredJobsQuery iStoredJobsQuery,
final OutputStream output,
final JobDefinitionFileFormat fformat)
throws CentralDispatcherException {
final HashMap<String, String> params = new HashMap<String, String>();
final String nameMatch = iStoredJobsQuery.getNameMatch();
String groupMatch = iStoredJobsQuery.getGroupMatch();
final String projectFilter = iStoredJobsQuery.getProjectFilter();
final String idlistFilter = iStoredJobsQuery.getIdlist();
final String expectedContentType;
if (null != fformat) {
params.put("format", fformat.getName());
expectedContentType = fformat == JobDefinitionFileFormat.xml ? "text/xml" : "text/yaml";
} else {
params.put("format", JobDefinitionFileFormat.xml.getName());
expectedContentType = "text/xml";
}
if (null != nameMatch) {
params.put("jobFilter", nameMatch);
}
if (null != groupMatch) {
final Matcher matcher = Pattern.compile("^/*(.+?)/*$").matcher(groupMatch);
if (matcher.matches()) {
// strip leading and trailing slashes
groupMatch = matcher.group(1);
}
params.put("groupPath", groupMatch);
}
if (null != projectFilter) {
params.put("project", projectFilter);
}
if (null != idlistFilter) {
params.put("idlist", idlistFilter);
}
// 2. send request via ServerService
final WebserviceResponse response;
try {
response =
serverService.makeRundeckRequest(
RUNDECK_API_JOBS_EXPORT_PATH, params, null, null, expectedContentType);
} catch (MalformedURLException e) {
throw new CentralDispatcherServerRequestException("Failed to make request", e);
}
checkErrorResponse(response);
// if xml, do local validation and listing
if (null == fformat || fformat == JobDefinitionFileFormat.xml) {
validateJobsResponse(response);
////////////////////
// parse result list of queued items, return the collection of QueuedItems
///////////////////
final Document resultDoc = response.getResultDoc();
final Node node = resultDoc.selectSingleNode("/joblist");
final ArrayList<IStoredJob> list = new ArrayList<IStoredJob>();
if (null == node) {
return list;
}
final List items = node.selectNodes("job");
if (null != items && items.size() > 0) {
for (final Object o : items) {
final Node node1 = (Node) o;
final Node uuid = node1.selectSingleNode("uuid");
final Node id1 = node1.selectSingleNode("id");
final String id = null != uuid ? uuid.getStringValue() : id1.getStringValue();
final String name = node1.selectSingleNode("name").getStringValue();
final String url = createJobURL(id);
final Node gnode = node1.selectSingleNode("group");
final String group = null != gnode ? gnode.getStringValue() : null;
final String description = node1.selectSingleNode("description").getStringValue();
list.add(StoredJobImpl.create(id, name, url, group, description, projectFilter));
}
}
if (null != output) {
// write output doc to the outputstream
final OutputFormat format = OutputFormat.createPrettyPrint();
try {
final XMLWriter writer = new XMLWriter(output, format);
writer.write(resultDoc);
writer.flush();
} catch (IOException e) {
throw new CentralDispatcherServerRequestException(e);
}
}
return list;
} else if (fformat == JobDefinitionFileFormat.yaml) {
// do rought yaml parse
final Collection<Map> mapCollection = validateJobsResponseYAML(response);
final ArrayList<IStoredJob> list = new ArrayList<IStoredJob>();
if (null == mapCollection || mapCollection.size() < 1) {
return list;
}
for (final Map map : mapCollection) {
final Object uuidobj = map.get("uuid");
final Object idobj = map.get("id");
final String id = null != uuidobj ? uuidobj.toString() : idobj.toString();
final String name = (String) map.get("name");
final String group = map.containsKey("group") ? (String) map.get("group") : null;
final String desc = map.containsKey("description") ? (String) map.get("description") : "";
final String url = createJobURL(id);
list.add(StoredJobImpl.create(id, name, url, group, desc, projectFilter));
}
if (null != output) {
// write output doc to the outputstream
try {
final Writer writer = new OutputStreamWriter(output);
writer.write(response.getResults());
writer.flush();
} catch (IOException e) {
throw new CentralDispatcherServerRequestException(e);
}
}
return list;
}
return null;
}