Package zowe.client.sdk.rest

Class ZosmfRequest

java.lang.Object

zowe.client.sdk.rest.ZosmfRequest

Direct Known Subclasses:

DeleteJsonZosmfRequest, GetJsonZosmfRequest, GetStreamZosmfRequest, GetTextZosmfRequest, PostJsonZosmfRequest, PutJsonZosmfRequest, PutStreamZosmfRequest, PutTextZosmfRequest

public abstract class ZosmfRequest
extends Object

Base abstract class that conforms to http CRUD operations

Version:

4.0

Author:

Frank Giordano

Field Summary

Fields

Modifier and Type	Field	Description
protected ZosConnection	connection	ZosConnection object
protected Map<String,String>	headers	Map of HTTP headers
protected kong.unirest.core.Cookie	token	Cookie object representing a TOKEN
protected String	url	URL string
static String	X_CSRF_ZOSMF_HEADER_KEY	X_CSRF_ZOSMF_HEADER_KEY header info
static String	X_CSRF_ZOSMF_HEADER_VALUE	X_CSRF_ZOSMF_HEADER_VALUE header info

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ZosmfRequest(ZosConnection connection)	ZosmfRequest constructor

Method Summary

Modifier and Type	Method	Description
<T> Response	buildResponse(kong.unirest.core.HttpResponse<T> reply)	Build a Response object from a given HttpResponse reply
abstract Response	executeRequest()	Perform the http rest request
Map<String,String>	getHeaders()	Get current http header value(s) for request
String	getUrl()	Retrieve the url string value
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	setupRequest()	Initialize the unirest http request object based on an authentication type
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_KEY header info

X_CSRF_ZOSMF_HEADER_VALUE

public static final String X_CSRF_ZOSMF_HEADER_VALUE

X_CSRF_ZOSMF_HEADER_VALUE header info

connection

protected final ZosConnection connection

ZosConnection object

headers

protected final Map<String,String> headers

Map of HTTP headers

url

protected String url

URL string

token

protected kong.unirest.core.Cookie token

Cookie object representing a TOKEN

Constructor Detail

ZosmfRequest

protected ZosmfRequest(ZosConnection connection)

ZosmfRequest constructor

Parameters:

connection - for connection information, see ZosConnection object

Method Detail

setupRequest

public void setupRequest()

Initialize the unirest http request object based on an authentication type

buildResponse

public <T> Response buildResponse(kong.unirest.core.HttpResponse<T> reply)
                           throws ZosmfRequestException

Build a Response object from a given HttpResponse reply

Type Parameters:

T - either JsonNode, String or byte[] type

Parameters:

reply - HttpResponse object

Returns:

Response object

Throws:

ZosmfRequestException - request error state

executeRequest

public abstract Response executeRequest()
                                 throws ZosmfRequestException

Perform the http rest request

Returns:

Response object

Throws:

ZosmfRequestException - request error state

setBody

public abstract void setBody(Object body)

Set the body information for the http request

Parameters:

body - object value

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

getUrl

public String getUrl()

Retrieve the url string value

Returns:

string value

getHeaders

public Map<String,String> getHeaders()

Get current http header value(s) for request

Returns:

map of header value(s)