GitHub-Mirror/rundeck-api-java-client
2
0
Fork 0
mirror of https://github.com/Fishwaldo/rundeck-api-java-client.git synced 2025-07-06 13:08:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add default Accept header text/xml to requests, allow overriding it

Browse source
This commit is contained in:
Greg Schueler 2014-01-16 16:04:48 -08:00
parent 9ca85e810f
commit af37fd1f56
3 changed files with 54 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

22
src/main/java/org/rundeck/api/ApiCall.java
View file

@ -177,7 +177,11 @@ class ApiCall {
*/
public <T> T get(ApiPathBuilder apiPath, XmlNodeParser<T> parser) throws RundeckApiException,
RundeckApiLoginException, RundeckApiTokenException {
return execute(new HttpGet(client.getUrl() + client.getApiEndpoint() + apiPath), parser);
HttpGet request = new HttpGet(client.getUrl() + client.getApiEndpoint() + apiPath);
if (null != apiPath.getAccept()) {
request.setHeader("Accept", apiPath.getAccept());
}
return execute(request, parser);
}
/**
@ -192,7 +196,11 @@ class ApiCall {
*/
public InputStream get(ApiPathBuilder apiPath) throws RundeckApiException, RundeckApiLoginException,
RundeckApiTokenException {
ByteArrayInputStream response = execute(new HttpGet(client.getUrl() + client.getApiEndpoint() + apiPath));
HttpGet request = new HttpGet(client.getUrl() + client.getApiEndpoint() + apiPath);
if (null != apiPath.getAccept()) {
request.setHeader("Accept", apiPath.getAccept());
}
ByteArrayInputStream response = execute(request);
// try to load the document, to throw an exception in case of error
ParserHelper.loadDocument(response);
@ -213,7 +221,11 @@ class ApiCall {
*/
public InputStream getNonApi(ApiPathBuilder apiPath) throws RundeckApiException, RundeckApiLoginException,
RundeckApiTokenException {
ByteArrayInputStream response = execute(new HttpGet(client.getUrl() + apiPath));
HttpGet request = new HttpGet(client.getUrl() + apiPath);
if (null != apiPath.getAccept()) {
request.setHeader("Accept", apiPath.getAccept());
}
ByteArrayInputStream response = execute(request);
response.reset();
return response;
@ -257,7 +269,9 @@ class ApiCall {
public <T> T post(ApiPathBuilder apiPath, XmlNodeParser<T> parser) throws RundeckApiException,
RundeckApiLoginException, RundeckApiTokenException {
HttpPost httpPost = new HttpPost(client.getUrl() + client.getApiEndpoint() + apiPath);
if(null!= apiPath.getAccept()) {
httpPost.setHeader("Accept", apiPath.getAccept());
}
// POST a multi-part request, with all attachments
if(apiPath.getAttachments().size()>0){
MultipartEntity entity = new MultipartEntity(HttpMultipartMode.BROWSER_COMPATIBLE);

16
src/main/java/org/rundeck/api/ApiPathBuilder.java
View file

@ -38,6 +38,8 @@ class ApiPathBuilder {
/** Internally, we store everything in a {@link StringBuilder} */
private final StringBuilder apiPath;
private String accept="text/xml";
/** When POSTing, we can add attachments */
private final Map<String, InputStream> attachments;
private final List<NameValuePair> form = new ArrayList<NameValuePair>();
@ -63,6 +65,13 @@ class ApiPathBuilder {
}
}
/**
* Set the accept header
*/
public ApiPathBuilder accept(String mimeTypes) {
accept=mimeTypes;
return this;
}
/**
* Visit a {@link BuildsParameters} and add the parameters
*/
@ -305,6 +314,13 @@ class ApiPathBuilder {
return getAttachments().size() > 0 || getForm().size() > 0;
}
/**
* Accept header value, default "text/xml"
*/
public String getAccept() {
return accept;
}
/**
* BuildsParameters can add URL or POST parameters to an {@link ApiPathBuilder}
*

20
src/test/resources/betamax/tapes/get_executions.yaml
View file

@ -6,6 +6,7 @@ interactions:
method: GET
uri: http://rundeck.local:4440/api/5/executions?jobFilter=test+job&project=blah&max=2&offset=0
headers:
Accept: text/xml
Host: rundeck.local:4440
Proxy-Connection: Keep-Alive
User-Agent: RunDeck API Java Client 5
@ -23,6 +24,7 @@ interactions:
method: GET
uri: http://rundeck.local:4440/api/5/executions?project=blah&descFilter=a+description&max=2&offset=0
headers:
Accept: text/xml
Host: rundeck.local:4440
Proxy-Connection: Keep-Alive
User-Agent: RunDeck API Java Client 5
@ -38,6 +40,7 @@ interactions:
method: GET
uri: http://rundeck.local:4440/api/5/executions?project=blah&begin=2012-09-13T17%3A06%3A18Z&max=2&offset=0
headers:
Accept: text/xml
Host: rundeck.local:4440
Proxy-Connection: Keep-Alive
User-Agent: RunDeck API Java Client 5
@ -53,6 +56,7 @@ interactions:
method: GET
uri: http://rundeck.local:4440/api/5/executions?project=blah&end=2012-09-13T17%3A06%3A18Z&max=2&offset=0
headers:
Accept: text/xml
Host: rundeck.local:4440
Proxy-Connection: Keep-Alive
User-Agent: RunDeck API Java Client 5
@ -68,6 +72,7 @@ interactions:
method: GET
uri: http://rundeck.local:4440/api/5/executions?project=blah&excludeJobIdListFilter=123&excludeJobIdListFilter=456&max=2&offset=0
headers:
Accept: text/xml
Host: rundeck.local:4440
Proxy-Connection: Keep-Alive
User-Agent: RunDeck API Java Client 5
@ -83,6 +88,7 @@ interactions:
method: GET
uri: http://rundeck.local:4440/api/5/executions?project=blah&jobListFilter=fruit%2Fmango&jobListFilter=fruit%2Flemon&max=2&offset=0
headers:
Accept: text/xml
Host: rundeck.local:4440
Proxy-Connection: Keep-Alive
User-Agent: RunDeck API Java Client 5
@ -98,6 +104,7 @@ interactions:
method: GET
uri: http://rundeck.local:4440/api/5/executions?project=blah&excludeJobListFilter=a%2Fpath%2Fjob1&excludeJobListFilter=path%2Fto%2Fjob2&max=2&offset=0
headers:
Accept: text/xml
Host: rundeck.local:4440
Proxy-Connection: Keep-Alive
User-Agent: RunDeck API Java Client 5
@ -113,6 +120,7 @@ interactions:
method: GET
uri: http://rundeck.local:4440/api/5/executions?project=blah&jobIdListFilter=1f4415d7-3b52-4fc8-ba42-b6ac97508bff&jobIdListFilter=d9fc5ee6-f1db-4d24-8808-feda18345bab&max=2&offset=0
headers:
Accept: text/xml
Host: rundeck.local:4440
Proxy-Connection: Keep-Alive
User-Agent: RunDeck API Java Client 5
@ -128,6 +136,7 @@ interactions:
method: GET
uri: http://rundeck.local:4440/api/5/executions?project=blah&groupPath=fruit&max=2&offset=0
headers:
Accept: text/xml
Host: rundeck.local:4440
Proxy-Connection: Keep-Alive
User-Agent: RunDeck API Java Client 5
@ -143,6 +152,7 @@ interactions:
method: GET
uri: http://rundeck.local:4440/api/5/executions?project=blah&groupPathExact=fruit&max=2&offset=0
headers:
Accept: text/xml
Host: rundeck.local:4440
Proxy-Connection: Keep-Alive
User-Agent: RunDeck API Java Client 5
@ -158,6 +168,7 @@ interactions:
method: GET
uri: http://rundeck.local:4440/api/5/executions?jobExactFilter=test+job&project=blah&max=2&offset=0
headers:
Accept: text/xml
Host: rundeck.local:4440
Proxy-Connection: Keep-Alive
User-Agent: RunDeck API Java Client 5
@ -173,6 +184,7 @@ interactions:
method: GET
uri: http://rundeck.local:4440/api/5/executions?project=blah&loglevelFilter=INFO&max=2&offset=0
headers:
Accept: text/xml
Host: rundeck.local:4440
Proxy-Connection: Keep-Alive
User-Agent: RunDeck API Java Client 5
@ -188,6 +200,7 @@ interactions:
method: GET
uri: http://rundeck.local:4440/api/5/executions?project=blah&recentFilter=1h&max=2&offset=0
headers:
Accept: text/xml
Host: rundeck.local:4440
Proxy-Connection: Keep-Alive
User-Agent: RunDeck API Java Client 5
@ -203,6 +216,7 @@ interactions:
method: GET
uri: http://rundeck.local:4440/api/5/executions?project=blah&statusFilter=succeeded&max=2&offset=0
headers:
Accept: text/xml
Host: rundeck.local:4440
Proxy-Connection: Keep-Alive
User-Agent: RunDeck API Java Client 5
@ -218,6 +232,7 @@ interactions:
method: GET
uri: http://rundeck.local:4440/api/5/executions?project=blah&adhoc=true&max=2&offset=0
headers:
Accept: text/xml
Host: rundeck.local:4440
Proxy-Connection: Keep-Alive
User-Agent: RunDeck API Java Client 5
@ -235,6 +250,7 @@ interactions:
method: GET
uri: http://rundeck.local:4440/api/5/executions?project=blah&abortedbyFilter=admin&max=2&offset=0
headers:
Accept: text/xml
Host: rundeck.local:4440
Proxy-Connection: Keep-Alive
User-Agent: RunDeck API Java Client 5
@ -252,6 +268,7 @@ interactions:
method: GET
uri: http://rundeck.local:4440/api/5/executions?excludeJobFilter=test+job&project=blah&max=2&offset=0
headers:
Accept: text/xml
Host: rundeck.local:4440
Proxy-Connection: Keep-Alive
User-Agent: RunDeck API Java Client 5
@ -269,6 +286,7 @@ interactions:
method: GET
uri: http://rundeck.local:4440/api/5/executions?excludeJobExactFilter=test+job&project=blah&max=2&offset=0
headers:
Accept: text/xml
Host: rundeck.local:4440
Proxy-Connection: Keep-Alive
User-Agent: RunDeck API Java Client 5
@ -284,6 +302,7 @@ interactions:
method: GET
uri: http://rundeck.local:4440/api/5/executions?project=blah&excludeGroupPath=fruit&max=2&offset=0
headers:
Accept: text/xml
Host: rundeck.local:4440
Proxy-Connection: Keep-Alive
User-Agent: RunDeck API Java Client 5
@ -301,6 +320,7 @@ interactions:
method: GET
uri: http://rundeck.local:4440/api/5/executions?project=blah&excludeGroupPathExact=fruit&max=2&offset=0
headers:
Accept: text/xml
Host: rundeck.local:4440
Proxy-Connection: Keep-Alive
User-Agent: RunDeck API Java Client 5