com.axway.apim.lib.utils.rest

Class RestAPICall

java.lang.Object

com.axway.apim.lib.utils.rest.RestAPICall

Direct Known Subclasses:

DELRequest, GETRequest, POSTRequest, PUTRequest

public abstract class RestAPICall
extends Object

Encapsulates logic to perform REST-API Calls to the API-Manager REST-API. For instance it's handling the CSRF-Tokens. More important is the implementation of ParseReponse. For every API-Call the implementing class can override the ParseResponse method, which can be used to validate the expected output.

Author:

cwiechmann@axway.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_VERSION
protected String	contentType
protected org.apache.http.HttpEntity	entity
protected org.apache.http.HttpHost	target
protected URI	uri
protected boolean	useAdmin

Constructor Summary

Constructors

Constructor and Description
RestAPICall(org.apache.http.HttpEntity entity, URI uri)
RestAPICall(org.apache.http.HttpEntity entity, URI uri, boolean useAdmin)

Method Summary

Modifier and Type	Method and Description
abstract org.apache.http.HttpResponse	execute()
protected org.apache.http.HttpResponse	sendRequest(org.apache.http.client.methods.HttpUriRequest request)
void	setContentType(String contentType)

Methods inherited from class java.lang.Object

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

Field Detail

API_VERSION

public static final String API_VERSION

See Also:

Constant Field Values

entity

protected org.apache.http.HttpEntity entity

uri

protected URI uri

target

protected org.apache.http.HttpHost target

contentType

protected String contentType

useAdmin

protected boolean useAdmin

Constructor Detail

RestAPICall

public RestAPICall(org.apache.http.HttpEntity entity,
                   URI uri,
                   boolean useAdmin)

RestAPICall

public RestAPICall(org.apache.http.HttpEntity entity,
                   URI uri)

Method Detail

execute

public abstract org.apache.http.HttpResponse execute()
                                              throws AppException

Throws:

AppException

sendRequest

protected org.apache.http.HttpResponse sendRequest(org.apache.http.client.methods.HttpUriRequest request)
                                            throws AppException

Throws:

AppException

setContentType

public void setContentType(String contentType)