com.cultofbits.integrationm.service.actionpack

Class RestActionPack

java.lang.Object

com.cultofbits.integrationm.service.actionpack.RestActionPack

public class RestActionPack
extends Object

Generic REST Action pack to allow interaction with any given endpoint.
The action pack should be configured in com.cultofbits.integrationm.service.properties file with rest key; for example:

  action.names=...,<rest-ap-name>

  action.<rest-ap-name>=rest
  action.<rest-ap-name>.base-url=<some url>
  action.<rest-ap-name>.cookie-name=<cookie-name>
  action.<rest-ap-name>.cookie-value=<cookie-value>
 

Constructor Summary

Constructors

Constructor and Description
RestActionPack(String url, String cookieName, String cookieValue, com.cultofbits.integrationm.service.internal.security.UserCookiesGenerator userCookiesGenerator)

Method Summary

Modifier and Type	Method and Description
String	delete(String relativeUri) Does a DELETE of the given uri
String	delete(String relativeUri, Map<String,String> queryParams, String runAsUser) Does a DELETE of the given uri Same as the standard DELETE method but with an additional map, containing query parameters for the request
String	delete(String relativeUri, String runAsUser) Does a DELETE of the given uri Same as the standard DELETE method but with an additional arg that allows to run the operation as a given user
String	get(String relativeUri) Does a GET of the given uri.
String	get(String relativeUri, Map<String,String> queryParams, String runAsUser) Does a GET of the given uri.
String	get(String relativeUri, String runAsUser) Does a GET of the given uri.
String	post(String relativeUri, List values) Transforms the passed List into a JSON object and POSTs it to the given uri.
String	post(String relativeUri, List values, String runAsUser) Transforms the passed List into a JSON object and POSTs it to the given uri.
String	post(String relativeUri, Map<String,String> keyValues) Transforms the passed Map into a JSON object and POSTs it to the given uri.
String	post(String relativeUri, Map<String,String> keyValues, String runAsUser) Transforms the passed Map into a JSON object and POSTs it to the given uri.
String	put(String relativeUri, List values) Transforms the passed List into a JSON object and PUTs it to the given uri.
String	put(String relativeUri, List values, String runAsUser) Transforms the passed List into a JSON object and PUTs it to the given uri.
String	put(String relativeUri, Map<String,String> keyValues) Transforms the passed Map into a JSON object and PUTs it to the given uri.
String	put(String relativeUri, Map<String,String> keyValues, String runAsUser) Transforms the passed Map into a JSON object and PUTs it to the given uri.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RestActionPack

public RestActionPack(String url,
                      String cookieName,
                      String cookieValue,
                      com.cultofbits.integrationm.service.internal.security.UserCookiesGenerator userCookiesGenerator)

Method Detail

delete

public String delete(String relativeUri)

Does a DELETE of the given uri

Parameters:

relativeUri - the relative URI to be appended to the baseurl (ex: integration/cpe/123)

Returns:

a String with the DELETE response entity (or "OK" if none is returned) or "NOT_OK" if an error occurred

delete

public String delete(String relativeUri,
                     Map<String,String> queryParams,
                     String runAsUser)

Does a DELETE of the given uri Same as the standard DELETE method but with an additional map, containing query parameters for the request

Parameters:

relativeUri - the relative URI to be appended to the baseurl (ex: integration/cpe/123)

queryParams - a map of query parameters

runAsUser - the username that will be used to make the request

Returns:

a String with the DELETE response entity (or "OK" if none is returned) or "NOT_OK" if an error occurred

delete

public String delete(String relativeUri,
                     String runAsUser)

Does a DELETE of the given uri Same as the standard DELETE method but with an additional arg that allows to run the operation as a given user

Parameters:

relativeUri - the relative URI to be appended to the baseurl (ex: integration/cpe/123)

runAsUser - the username that will be used to make the request

Returns:

a String with the DELETE response entity (or "OK" if none is returned) or "NOT_OK" if an error occurred

get

public String get(String relativeUri)

Does a GET of the given uri.

Parameters:

relativeUri - the relative URI to be appended to the baseurl (ex: integration/cpe/123)

Returns:

a String with the GET response entity (or "OK" if none is returned) or "NOT_OK" if an error occurred

get

public String get(String relativeUri,
                  Map<String,String> queryParams,
                  String runAsUser)

Does a GET of the given uri. Same as the standard GET method but with an additional map with query parameters
NOTE: the query parameters received will be url encoded here, so please call with plain values.

Parameters:

relativeUri - the relative URI to be appended to the baseurl (ex: integration/cpe/123)

queryParams - a map of query parameters

runAsUser - the username that will be used to make the request

Returns:

a String with the GET response entity (or "OK" if none is returned) or "NOT_OK" if an error occurred

get

public String get(String relativeUri,
                  String runAsUser)

Does a GET of the given uri. Same as the standard GET method but with an additional arg that allows to run the operation as a given user

Parameters:

relativeUri - the relative URI to be appended to the baseurl (ex: integration/cpe/123)

runAsUser - the username that will be used to make the request

Returns:

a String with the GET response entity (or "OK" if none is returned) or "NOT_OK" if an error occurred

post

public String post(String relativeUri,
                   List values)

Transforms the passed List into a JSON object and POSTs it to the given uri.

Parameters:

relativeUri - the relative URI to be appended to the baseurl (ex: integration/cpe/123)

values - a list to be converted to a JSON array

Returns:

a String with the response entity (or "OK" if none is returned) or "NOT_OK" if an error occurred

post

public String post(String relativeUri,
                   List values,
                   String runAsUser)

Transforms the passed List into a JSON object and POSTs it to the given uri.
Same as the standard POST method, but with an additional arg that allows one to run the operation as a different user.

Parameters:

relativeUri - the relative URI to be appended to the baseurl (ex: integration/cpe/123)

values - a list to be converted to a JSON array

runAsUser - the username that will be used to make the request

Returns:

a String with the response entity (or "OK" if none is returned) or "NOT_OK" if an error occurred

post

public String post(String relativeUri,
                   Map<String,String> keyValues)

Transforms the passed Map into a JSON object and POSTs it to the given uri.

Parameters:

relativeUri - the relative URI to be appended to the baseurl (ex: integration/cpe/123)

keyValues - a map to be converted to a JSON object

Returns:

a String with the response entity (or "OK" if none is returned) or "NOT_OK" if an error occurred

post

public String post(String relativeUri,
                   Map<String,String> keyValues,
                   String runAsUser)

Transforms the passed Map into a JSON object and POSTs it to the given uri.
Same as the standard POST method, but with an additional arg that allows one to run the operation as a different user.

Parameters:

relativeUri - the relative URI to be appended to the baseurl (ex: integration/cpe/123)

keyValues - a map to be converted to a JSON object

runAsUser - the username that will be used to make the request

Returns:

a String with the response entity (or "OK" if none is returned) or "NOT_OK" if an error occurred

put

public String put(String relativeUri,
                  List values)

Transforms the passed List into a JSON object and PUTs it to the given uri.

Parameters:

relativeUri - the relative URI to be appended to the baseurl (ex: integration/cpe/123)

values - a list to be converted to a JSON array

Returns:

a String with the response entity (or "OK" if none is returned) or "NOT_OK" if an error occurred

put

public String put(String relativeUri,
                  List values,
                  String runAsUser)

Transforms the passed List into a JSON object and PUTs it to the given uri.
Same as the standard PUT method, but with an additional arg that allows one to run the operation as a different user.

Parameters:

relativeUri - the relative URI to be appended to the baseurl (ex: integration/cpe/123)

values - a list to be converted to a JSON array

runAsUser - the username that will be used to make the request

Returns:

a String with the response entity (or "OK" if none is returned) or "NOT_OK" if an error occurred

put

public String put(String relativeUri,
                  Map<String,String> keyValues)

Transforms the passed Map into a JSON object and PUTs it to the given uri.

Parameters:

relativeUri - the relative URI to be appended to the baseurl (ex: integration/cpe/123)

keyValues - a map to be converted to a JSON object

Returns:

a String with the response entity (or "OK" if none is returned) or "NOT_OK" if an error occurred

put

public String put(String relativeUri,
                  Map<String,String> keyValues,
                  String runAsUser)

Transforms the passed Map into a JSON object and PUTs it to the given uri.
Same as the standard PUT method, but with an additional arg that allows one to run the operation as a different user.

Parameters:

relativeUri - the relative URI to be appended to the baseurl (ex: integration/cpe/123)

keyValues - a map to be converted to a JSON object

runAsUser - the username that will be used to make the request

Returns:

a String with the response entity (or "OK" if none is returned) or "NOT_OK" if an error occurred