Package zowe.client.sdk.rest

Class JsonGetRequest

java.lang.Object

zowe.client.sdk.rest.ZoweRequest

zowe.client.sdk.rest.JsonGetRequest

public class JsonGetRequest
extends ZoweRequest

Http get operation with Json content type

Version:

1.0

Author:

Frank Giordano

Field Summary

Fields inherited from class zowe.client.sdk.rest.ZoweRequest

client, connection, httpResponse, localContext, X_CSRF_ZOSMF_HEADER_KEY, X_CSRF_ZOSMF_HEADER_VALUE

Constructor Summary

Constructors

Constructor	Description
JsonGetRequest(ZOSConnection connection)	JsonGetRequest constructor.

Method Summary

Modifier and Type	Method	Description
Response	executeRequest()	Execute the formulated http request
void	setHeaders(Map<String,String> headers)	Set any headers needed for the http request
void	setRequest(String url)	Initialize the http request object with an url value
void	setRequest(String url, String body)	Initialize the http request object with an url and body values
void	setStandardHeaders()	Set the standard headers for the http request

Methods inherited from class zowe.client.sdk.rest.ZoweRequest

executeJsonRequest, executeStreamRequest, executeTextRequest, requestType, setup

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonGetRequest

public JsonGetRequest(ZOSConnection connection)

JsonGetRequest constructor.

Parameters:

connection - connection information, see ZOSConnection object

Method Detail

executeRequest

public Response executeRequest()
                        throws Exception

Execute the formulated http request

Specified by:

executeRequest in class ZoweRequest

Returns:

Response value

Throws:

Exception - error executing request

setStandardHeaders

public void setStandardHeaders()

Set the standard headers for the http request

Specified by:

setStandardHeaders in class ZoweRequest

setHeaders

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

Set any headers needed for the http request

Specified by:

setHeaders in class ZoweRequest

Parameters:

headers - headers to add to the request

setRequest

public void setRequest(String url)
                throws Exception

Initialize the http request object with an url value

Specified by:

setRequest in class ZoweRequest

Parameters:

url - rest url end point

Throws:

Exception - error setting the http request

setRequest

public void setRequest(String url,
                       String body)
                throws Exception

Initialize the http request object with an url and body values

This method isn't valid for this request. Method returns exception error if used with message "request requires url only".

Specified by:

setRequest in class ZoweRequest

Parameters:

url - rest url end point

body - data to be sent with request

Throws:

Exception - error setting the http request