Package rest

Class ZoweRequest

java.lang.Object

rest.ZoweRequest

Direct Known Subclasses:

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

public abstract class ZoweRequest
extends Object

Base abstract class that conforms to Http CRUD operations

Version:

1.0

Author:

Frank Giordano

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.http.client.HttpClient	client
protected ZOSConnection	connection
protected org.apache.http.HttpResponse	httpResponse
protected org.apache.http.protocol.HttpContext	localContext
static String	X_CSRF_ZOSMF_HEADER_KEY
static String	X_CSRF_ZOSMF_HEADER_VALUE

Constructor Summary

Constructors

Constructor	Description
ZoweRequest(ZOSConnection connection, ZoweRequestType.VerbType requestType)	ZoweRequest constructor.

Method Summary

Modifier and Type	Method	Description
abstract Response	executeHttpRequest()	Execute the formulated http request
ZoweRequestType.VerbType	requestType()	Retrieve current request type for http request
abstract void	setAdditionalHeaders(Map<String,String> additionalHeaders)	Set additional headers needed for the http request
abstract void	setRequest(String url)	Set the following incoming url with a new http request
abstract void	setStandardHeaders()	Set the standard headers for the http request
protected void	setup()	Setup to be used first in setting up 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

client

protected org.apache.http.client.HttpClient client

localContext

protected final org.apache.http.protocol.HttpContext localContext

httpResponse

protected org.apache.http.HttpResponse httpResponse

Constructor Detail

ZoweRequest

public ZoweRequest(ZOSConnection connection,
                   ZoweRequestType.VerbType requestType)

ZoweRequest constructor.

Parameters:

connection - connection information, see ZOSConnection object

requestType - request type, see ZoweRequestType.VerbType object

Method Detail

executeHttpRequest

public abstract Response executeHttpRequest()
                                     throws Exception

Execute the formulated http request

Returns:

Response value

Throws:

Exception - error executing request

setStandardHeaders

public abstract void setStandardHeaders()

Set the standard headers for the http request

setAdditionalHeaders

public abstract void setAdditionalHeaders(Map<String,String> additionalHeaders)

Set additional headers needed for the http request

Parameters:

additionalHeaders - additional headers to add to the request

setRequest

public abstract void setRequest(String url)
                         throws Exception

Set the following incoming url with a new http request

Parameters:

url - rest url end point

Throws:

Exception - error setting the http request

setup

protected void setup()

Setup to be used first in setting up the http request

requestType

public ZoweRequestType.VerbType requestType()

Retrieve current request type for http request

Returns:

http request type