Package zowe.client.sdk.rest

Class ZoweRequest

java.lang.Object

zowe.client.sdk.rest.ZoweRequest

Direct Known Subclasses:

JsonDeleteRequest, JsonGetRequest, JsonPostRequest, JsonPutRequest, StreamGetRequest, StreamPutRequest, TextGetRequest, TextPutRequest

public abstract class ZoweRequest
extends Object

Base abstract class that conforms to Http CRUD operations

Version:

2.0

Author:

Frank Giordano

Field Summary

Fields

Modifier and Type	Field	Description
protected ZosConnection	connection
protected Map<String,String>	headers
protected String	url
static String	X_CSRF_ZOSMF_HEADER_KEY
static String	X_CSRF_ZOSMF_HEADER_VALUE

Constructor Summary

Constructors

Constructor	Description
ZoweRequest(ZosConnection connection)	ZoweRequest constructor

Method Summary

Modifier and Type	Method	Description
abstract Response	executeRequest()	Perform the http rest request
protected static Response	getJsonResponse(kong.unirest.HttpResponse<kong.unirest.JsonNode> reply)	Retrieve the http response information
abstract void	setBody(Object body)	Set the body information for the http request
void	setHeaders(Map<String,String> headers)	Set any headers needed for the http request
abstract void	setStandardHeaders()	Set the standard headers for the http request
void	setUrl(String url)	Set the url needed for the http request

Methods inherited from class java.lang.Object

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

Field Detail

X_CSRF_ZOSMF_HEADER_KEY

public static final String X_CSRF_ZOSMF_HEADER_KEY

X_CSRF_ZOSMF_HEADER_VALUE

public static final String X_CSRF_ZOSMF_HEADER_VALUE

connection

protected final ZosConnection connection

headers

protected final Map<String,String> headers

url

protected String url

Constructor Detail

ZoweRequest

public ZoweRequest(ZosConnection connection)

ZoweRequest constructor

Parameters:

connection - connection information, see ZosConnection object

Method Detail

getJsonResponse

protected static Response getJsonResponse(kong.unirest.HttpResponse<kong.unirest.JsonNode> reply)

Retrieve the http response information

Parameters:

reply - json http response object

Returns:

Response object

executeRequest

public abstract Response executeRequest()
                                 throws kong.unirest.UnirestException

Perform the http rest request

Returns:

Response object

Throws:

kong.unirest.UnirestException - processing request error

setBody

public abstract void setBody(Object body)
                      throws kong.unirest.UnirestException

Set the body information for the http request

Parameters:

body - object value

Throws:

kong.unirest.UnirestException - error setting body

setHeaders

public void setHeaders(Map<String,String> headers)

Set any headers needed for the http request

Parameters:

headers - headers to add to the request

setStandardHeaders

public abstract void setStandardHeaders()

Set the standard headers for the http request

setUrl

public void setUrl(String url)
            throws IllegalArgumentException

Set the url needed for the http request

Parameters:

url - rest url end point

Throws:

IllegalArgumentException - error setting valid url string