com.ibm.cics.server

Class HttpClientRequest

java.lang.Object

com.ibm.cics.server.API

com.ibm.cics.server.HttpClientRequest

public class HttpClientRequest
extends API

This class provides the Java implementation of HTTP client requests related to the following CICS API commands:

• WEB SEND SESSTOKEN
• WEB WRITE SESSTOKEN.

The constructor accepts METHOD and MEDIATYPE information. These values can be altered by setter methods before the send methods are used to send a client request to the server.

The setter methods allow instance variables to be set in the HttpClientRequest object. These variables relate to the following options on the CICS API command WEB SEND SESSTOKEN:

• METHOD
• MEDIATYPE
• CLOSE
• NOCLOSE
• EXPECT
• PATH
• URIMAP
• CLICONVERET
• NOCLICONVERT
• QUERYSTRING
• DOCDELETE
• NODOCDELETE
• AUTHENTICATE NONE
• AUTHENTICATE BASIC

Various send methods allow a document, an application buffer, data stored in a container or a chunked request to be sent to the server.

Method writeHeader() allows the application to supply HTTP headers that will be sent with the client request.

See Also:

com.ibm.cics.server.API for general restrictions on using the JCICS API.

Since CICS TS version:

3.1

Since package version:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	NOTSET Constant - NOT SET

Constructor Summary

Constructors

Constructor and Description
HttpClientRequest(java.lang.String method) Usage: The METHOD is saved in the HttpClientRequest object for later use by the send methods.
HttpClientRequest(java.lang.String method, java.lang.String mediaType) Usage: The METHOD and MEDIATYPE information is saved in the HttpClientRequest object for later use by the send methods.

Method Summary

Modifier and Type	Method and Description
void	send(HttpSession session) Usage: Send an request without a body to the server.
void	sendChunk(HttpSession session, byte[] from) Usage: Send an application buffer to the server as part of a chunked request.
void	sendChunk(HttpSession session, java.lang.String from) Usage: Send an application buffer to the server as part of a chunked request.
void	sendContainer(HttpSession session, Container container) Usage: Send data stored in a container to the server.
void	sendDocument(HttpSession session, Document doc) Usage: Send a document to the server.
void	sendFrom(HttpSession session, byte[] from) Usage: Send an application buffer to the server.
void	sendFrom(HttpSession session, java.lang.String from) Usage: Send an application buffer to the server.
void	sendLastChunk(HttpSession session) Usage: Indicate that the chunked request is complete.
void	setActionExpect() Usage: Sets WEB SEND SESSTOKEN command option ACTION to EXPECT.
void	setAuthenticationBasic() Usage: Sets WEB SEND SESSTOKEN command option AUTHENTICATE to BASIC.This method also clears any user-name or password information already set by method setAuthenticationBasic(String userName, String password).
void	setAuthenticationBasic(java.lang.String userName, java.lang.String password) Usage: Sets WEB SEND SESSTOKEN command option AUTHENTICATE to BASIC and sets the WEB SEND SESSTOKEN command options USERNAME, USERNAMELEN, PASSWORD and PASSWORDLEN.
void	setAuthenticationNone() Usage: Sets WEB SEND SESSTOKEN command option AUTHENTICATE to NONE.
void	setCharacterset(java.lang.String characterset) Usage: Sets WEB SEND SESSTOKEN command option CHARACTERSET.
void	setClientConvert() Usage: Sets WEB SEND SESSTOKEN command option CLIENTCONV to CLICONVERT.
void	setClose() Usage: Sets WEB SEND SESSTOKEN command option CLOSESTATUS to CLOSE.
void	setDocDelete() Usage: Sets WEB SEND SESSTOKEN command option DOCSTATUS to DOCDELETE.
void	setMediaType(java.lang.String mediaType) Usage: Sets WEB SEND SESSTOKEN command option MEDIATYPE.
void	setMethodDelete() Usage: Sets WEB SEND SESSTOKEN command option METHOD to DELETE.
void	setMethodGet() Usage: Sets WEB SEND SESSTOKEN command option METHOD to GET.
void	setMethodHead() Usage: Sets WEB SEND SESSTOKEN command option METHOD to HEAD.
void	setMethodOptions() Usage: Sets WEB SEND SESSTOKEN command option METHOD to OPTIONS.
void	setMethodPost() Usage: Sets WEB SEND SESSTOKEN command option METHOD to POST.
void	setMethodPut() Usage: Sets WEB SEND SESSTOKEN command option METHOD to PUT.
void	setMethodTrace() Usage: Sets WEB SEND SESSTOKEN command option METHOD to TRACE.
void	setNoClientConvert() Usage: Sets WEB SEND SESSTOKEN command option CLIENTCONV to NOCLICONVERT.
void	setNoClose() Usage: Sets WEB SEND SESSTOKEN command option CLOSESTATUS to NOCLOSE.
void	setNoDocDelete() Usage: Sets WEB SEND SESSTOKEN command option DOCSTATUS to NODOCDELETE.
void	setPath(java.lang.String path) Usage: Sets WEB SEND SESSTOKEN command option PATH.
void	setQueryString(java.lang.String queryString) Usage: Sets WEB SEND SESSTOKEN command option QUERYSTRING.
void	setUrimap(java.lang.String urimap) Usage: Sets WEB SEND SESSTOKEN command option URIMAP.
void	writeHeader(HttpSession session, java.lang.String header, java.lang.String value) Usage: Add HTTP header information to the request This is equivalent to CICS API command WEB WRITE SESSTOKEN.

Methods inherited from class java.lang.Object

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

Field Detail

NOTSET

public static final int NOTSET

Constant - NOT SET

See Also:

Constant Field Values

Since CICS TS version:

3.1

Since package version:

1.0

Constructor Detail

HttpClientRequest

public HttpClientRequest(java.lang.String method)

Usage:
The METHOD is saved in the HttpClientRequest object for later use by the send methods. Valid methods are "POST", "GET", "HEAD", "PUT", "TRACE", "OPTIONS" and "DELETE". If the method is not one of these or the mediaType is invalid the error is not detected until one of the send methods is used to send the client request to the server.

Parameters:

method - is the METHOD to be used by the WEB SEND SESSTOKEN command

Since CICS TS version:

4.1

Since package version:

1.200

HttpClientRequest

public HttpClientRequest(java.lang.String method,
                         java.lang.String mediaType)

Usage:
The METHOD and MEDIATYPE information is saved in the HttpClientRequest object for later use by the send methods. Valid methods are "POST", "GET", "HEAD", "PUT", "TRACE", "OPTIONS" and "DELETE". If the method is not one of these or the mediaType is invalid the error is not detected until one of the send methods is used to send the client request to the server.

Parameters:

method - is the METHOD to be used by the WEB SEND SESSTOKEN command

mediaType - is the MEDIATYPE value to be used by the WEB SEND SESSTOKEN command

Since CICS TS version:

3.1

Since package version:

1.0

Method Detail

setMethodPost

public void setMethodPost()

Usage:
Sets WEB SEND SESSTOKEN command option METHOD to POST.

Since CICS TS version:

3.1

Since package version:

1.0

setMethodGet

public void setMethodGet()

Usage:
Sets WEB SEND SESSTOKEN command option METHOD to GET.

Since CICS TS version:

3.1

Since package version:

1.0

setMethodHead

public void setMethodHead()

Usage:
Sets WEB SEND SESSTOKEN command option METHOD to HEAD.

Since CICS TS version:

3.1

Since package version:

1.0

setMethodPut

public void setMethodPut()

Usage:
Sets WEB SEND SESSTOKEN command option METHOD to PUT.

Since CICS TS version:

3.1

Since package version:

1.0

setMethodTrace

public void setMethodTrace()

Usage:
Sets WEB SEND SESSTOKEN command option METHOD to TRACE.

Since CICS TS version:

3.1

Since package version:

1.0

setMethodOptions

public void setMethodOptions()

Usage:
Sets WEB SEND SESSTOKEN command option METHOD to OPTIONS.

Since CICS TS version:

3.1

Since package version:

1.0

setMethodDelete

public void setMethodDelete()

Usage:
Sets WEB SEND SESSTOKEN command option METHOD to DELETE.

Since CICS TS version:

3.1

Since package version:

1.0

setCharacterset

public void setCharacterset(java.lang.String characterset)

Usage:
Sets WEB SEND SESSTOKEN command option CHARACTERSET. This method also sets CLIENTCONV to CLICONVERT.

Parameters:

characterset - is the CHARACTERSET value to be used by the WEB SEND SESSTOKEN command

Since CICS TS version:

3.1

Since package version:

1.0

setClose

public void setClose()

Usage:
Sets WEB SEND SESSTOKEN command option CLOSESTATUS to CLOSE.

Since CICS TS version:

3.1

Since package version:

1.0

setNoClose

public void setNoClose()

Usage:
Sets WEB SEND SESSTOKEN command option CLOSESTATUS to NOCLOSE.

Since CICS TS version:

3.1

Since package version:

1.0

setActionExpect

public void setActionExpect()

Usage:
Sets WEB SEND SESSTOKEN command option ACTION to EXPECT.

Since CICS TS version:

3.1

Since package version:

1.0

setMediaType

public void setMediaType(java.lang.String mediaType)

Usage:
Sets WEB SEND SESSTOKEN command option MEDIATYPE.

Parameters:

mediaType - contains MEDIATYPE information to be used by the WEB SEND SESSTOKEN command

Since CICS TS version:

3.1

Since package version:

1.0

setPath

public void setPath(java.lang.String path)

Usage:
Sets WEB SEND SESSTOKEN command option PATH.

Parameters:

path - contains PATH information to be used by the WEB SEND SESSTOKEN command

Since CICS TS version:

3.1

Since package version:

1.0

setUrimap

public void setUrimap(java.lang.String urimap)

Usage:
Sets WEB SEND SESSTOKEN command option URIMAP.

Parameters:

urimap - contains the URIMAP name to be used by the WEB SEND SESSTOKEN command

Since CICS TS version:

3.1

Since package version:

1.0

setClientConvert

public void setClientConvert()

Usage:
Sets WEB SEND SESSTOKEN command option CLIENTCONV to CLICONVERT.

Since CICS TS version:

3.1

Since package version:

1.0

setNoClientConvert

public void setNoClientConvert()

Usage:
Sets WEB SEND SESSTOKEN command option CLIENTCONV to NOCLICONVERT. This method also clears CHARACTERSET information set by method setCharacterset().

Since CICS TS version:

3.1

Since package version:

1.0

setQueryString

public void setQueryString(java.lang.String queryString)

Usage:
Sets WEB SEND SESSTOKEN command option QUERYSTRING.

Parameters:

queryString - contains QUERYSTRING information to be used by the WEB SEND SESSTOKEN command

Since CICS TS version:

3.1

Since package version:

1.0

setDocDelete

public void setDocDelete()

Usage:
Sets WEB SEND SESSTOKEN command option DOCSTATUS to DOCDELETE.

Since CICS TS version:

3.2

Since package version:

1.100

setNoDocDelete

public void setNoDocDelete()

Usage:
Sets WEB SEND SESSTOKEN command option DOCSTATUS to NODOCDELETE.

Since CICS TS version:

3.2

Since package version:

1.100

setAuthenticationNone

public void setAuthenticationNone()

Usage:
Sets WEB SEND SESSTOKEN command option AUTHENTICATE to NONE. This method also clears any user-name or password information already set by method setAuthenticationBasic(String userName, String password).

Since CICS TS version:

3.2

Since package version:

1.100

setAuthenticationBasic

public void setAuthenticationBasic()

Usage:
Sets WEB SEND SESSTOKEN command option AUTHENTICATE to BASIC.This method also clears any user-name or password information already set by method setAuthenticationBasic(String userName, String password). This causes CICS global exit XWBAUTH to be driven to provide the user-name and password information when the WEB SEND SESSTOKEN command is issued by one of the send methods.

Since CICS TS version:

3.2

Since package version:

1.100

setAuthenticationBasic

public void setAuthenticationBasic(java.lang.String userName,
                                   java.lang.String password)

Usage:
Sets WEB SEND SESSTOKEN command option AUTHENTICATE to BASIC and sets the WEB SEND SESSTOKEN command options USERNAME, USERNAMELEN, PASSWORD and PASSWORDLEN.

Parameters:

userName - contains the basic authentication user-name.

password - contains the basic authentication password.

Since CICS TS version:

3.2

Since package version:

1.100

sendDocument

public void sendDocument(HttpSession session,
                         Document doc)
                  throws InvalidRequestException,
                         RecordNotFoundException,
                         IOErrorException,
                         NotAuthorisedException,
                         LengthErrorException,
                         NotOpenException,
                         TokenErrorException,
                         ContainerErrorException,
                         ChannelErrorException

Usage:
Send a document to the server. This is equivalent to CICS API command WEB SEND SESSTOKEN DOCUMENT. The required command options should have been saved in the HttpClientRequest object before this method is used to send the client request to the server.

Parameters:

session - is the HttpSession object associated with the request to be sent

doc - is the Document object to be sent to the server

Throws:

InvalidRequestException - a INVREQ condition occurred

RecordNotFoundException - a NOTFND condition occurred

IOErrorException - a IOERR condition occurred

NotAuthorisedException - a NOTAUTH condition occurred

LengthErrorException - a LENGERR condition occurred

NotOpenException - a NOTOPEN condition occurred

TokenErrorException - a TOKENERR condition occurred

ContainerErrorException - a CONTAINERERR condition occurred

ChannelErrorException - a CHANNELERR condition occurred

Since CICS TS version:

3.1

Since package version:

1.0

sendFrom

public void sendFrom(HttpSession session,
                     java.lang.String from)
              throws InvalidRequestException,
                     RecordNotFoundException,
                     IOErrorException,
                     NotAuthorisedException,
                     LengthErrorException,
                     NotOpenException,
                     TokenErrorException,
                     ContainerErrorException,
                     ChannelErrorException

Usage:
Send an application buffer to the server. This is equivalent to CICS API command WEB SEND SESSTOKEN FROM. The required command options should have been saved in the HttpClientRequest object before this method is used to send the client request to the server.

Parameters:

session - is the HttpSession object associated with the request to be sent

from - is the data to be sent to the server

Throws:

InvalidRequestException - a INVREQ condition occurred

RecordNotFoundException - a NOTFND condition occurred

IOErrorException - a IOERR condition occurred

NotAuthorisedException - a NOTAUTH condition occurred

LengthErrorException - a LENGERR condition occurred

NotOpenException - a NOTOPEN condition occurred

TokenErrorException - a TOKENERR condition occurred

ContainerErrorException - a CONTAINERERR condition occurred

ChannelErrorException - a CHANNELERR condition occurred

Since CICS TS version:

3.1

Since package version:

1.0

sendFrom

public void sendFrom(HttpSession session,
                     byte[] from)
              throws InvalidRequestException,
                     RecordNotFoundException,
                     IOErrorException,
                     NotAuthorisedException,
                     LengthErrorException,
                     NotOpenException,
                     TokenErrorException,
                     ContainerErrorException,
                     ChannelErrorException

Usage:
Send an application buffer to the server. This is equivalent to CICS API command WEB SEND SESSTOKEN FROM. The required command options should have been saved in the HttpClientRequest object before this method is used to send the client request to the server.

Parameters:

session - is the HttpSession object associated with the request to be sent

from - is the data to be sent to the server

Throws:

InvalidRequestException - a INVREQ condition occurred

RecordNotFoundException - a NOTFND condition occurred

IOErrorException - a IOERR condition occurred

NotAuthorisedException - a NOTAUTH condition occurred

LengthErrorException - a LENGERR condition occurred

NotOpenException - a NOTOPEN condition occurred

TokenErrorException - a TOKENERR condition occurred

ContainerErrorException - a CONTAINERERR condition occurred

ChannelErrorException - a CHANNELERR condition occurred

Since CICS TS version:

3.1

Since package version:

1.0

sendContainer

public void sendContainer(HttpSession session,
                          Container container)
                   throws InvalidRequestException,
                          RecordNotFoundException,
                          IOErrorException,
                          NotAuthorisedException,
                          LengthErrorException,
                          NotOpenException,
                          TokenErrorException,
                          ContainerErrorException,
                          ChannelErrorException

Usage:
Send data stored in a container to the server. This is equivalent to CICS API command WEB SEND SESSTOKEN CONTAINER. The required command options should have been saved in the HttpClientRequest object before this method is used to send the client request to the server.

Parameters:

session - is the HttpSession object associated with the request to be sent

container - is the container that holds the data to be sent to the server

Throws:

InvalidRequestException - a INVREQ condition occurred

RecordNotFoundException - a NOTFND condition occurred

IOErrorException - a IOERR condition occurred

NotAuthorisedException - a NOTAUTH condition occurred

LengthErrorException - a LENGERR condition occurred

NotOpenException - a NOTOPEN condition occurred

TokenErrorException - a TOKENERR condition occurred

ContainerErrorException - a CONTAINERERR condition occurred

ChannelErrorException - a CHANNELERR condition occurred

Since CICS TS version:

3.2

Since package version:

1.100

send

public void send(HttpSession session)
          throws InvalidRequestException,
                 RecordNotFoundException,
                 IOErrorException,
                 NotAuthorisedException,
                 LengthErrorException,
                 NotOpenException,
                 TokenErrorException,
                 ContainerErrorException,
                 ChannelErrorException

Usage:
Send an request without a body to the server. This is equivalent to CICS API command WEB SEND SESSTOKEN. The required command options should have been saved in the HttpClientRequest object before this method is used to send the client request to the server.

Parameters:

session - is the HttpSession object associated with the request to be sent

Throws:

InvalidRequestException - a INVREQ condition occurred

RecordNotFoundException - a NOTFND condition occurred

IOErrorException - a IOERR condition occurred

NotAuthorisedException - a NOTAUTH condition occurred

LengthErrorException - a LENGERR condition occurred

NotOpenException - a NOTOPEN condition occurred

TokenErrorException - a TOKENERR condition occurred

ContainerErrorException - a CONTAINERERR condition occurred

ChannelErrorException - a CHANNELERR condition occurred

Since CICS TS version:

3.1

Since package version:

1.0

sendChunk

public void sendChunk(HttpSession session,
                      java.lang.String from)
               throws InvalidRequestException,
                      RecordNotFoundException,
                      IOErrorException,
                      NotAuthorisedException,
                      LengthErrorException,
                      NotOpenException,
                      TokenErrorException,
                      ContainerErrorException,
                      ChannelErrorException

Usage:
Send an application buffer to the server as part of a chunked request. This is equivalent to CICS API command WEB SEND SESSTOKEN FROM CHUNKYES. The required command options should have been saved in the HttpClientRequest object before this method is used to send the client request to the server. Once the first chunk has been sent the instance variables set in the HttpClientRequest object by the setter methods are reset

Parameters:

session - is the HttpSession object associated with the request to be sent

from - is the data to be sent to the server

Throws:

InvalidRequestException - a INVREQ condition occurred

RecordNotFoundException - a NOTFND condition occurred

IOErrorException - a IOERR condition occurred

NotAuthorisedException - a NOTAUTH condition occurred

LengthErrorException - a LENGERR condition occurred

NotOpenException - a NOTOPEN condition occurred

TokenErrorException - a TOKENERR condition occurred

ContainerErrorException - a CONTAINERERR condition occurred

ChannelErrorException - a CHANNELERR condition occurred

Since CICS TS version:

3.1

Since package version:

1.0

sendChunk

public void sendChunk(HttpSession session,
                      byte[] from)
               throws InvalidRequestException,
                      RecordNotFoundException,
                      IOErrorException,
                      NotAuthorisedException,
                      LengthErrorException,
                      NotOpenException,
                      TokenErrorException,
                      ContainerErrorException,
                      ChannelErrorException

Usage:
Send an application buffer to the server as part of a chunked request. This is equivalent to CICS API command WEB SEND SESSTOKEN FROM CHUNKYES. The required command options should have been saved in the HttpClientRequest object before this method is used to send the client request to the server. Once the first chunk has been sent the instance variables set in the HttpClientRequest object by the setter methods are reset.

Parameters:

session - is the HttpSession object associated with the request to be sent

from - is the data to be sent to the server

Throws:

InvalidRequestException - a INVREQ condition occurred

RecordNotFoundException - a NOTFND condition occurred

IOErrorException - a IOERR condition occurred

NotAuthorisedException - a NOTAUTH condition occurred

LengthErrorException - a LENGERR condition occurred

NotOpenException - a NOTOPEN condition occurred

TokenErrorException - a TOKENERR condition occurred

ContainerErrorException - a CONTAINERERR condition occurred

ChannelErrorException - a CHANNELERR condition occurred

Since CICS TS version:

3.1

Since package version:

1.0

sendLastChunk

public void sendLastChunk(HttpSession session)
                   throws InvalidRequestException,
                          RecordNotFoundException,
                          IOErrorException,
                          NotAuthorisedException,
                          LengthErrorException,
                          NotOpenException,
                          TokenErrorException,
                          ContainerErrorException,
                          ChannelErrorException

Usage:
Indicate that the chunked request is complete. This is equivalent to CICS API command WEB SEND SESSTOKEN CHUNKEND.

Parameters:

session - is the HttpSession object associated with the request to be sent

Throws:

InvalidRequestException - a INVREQ condition occurred

RecordNotFoundException - a NOTFND condition occurred

IOErrorException - a IOERR condition occurred

NotAuthorisedException - a NOTAUTH condition occurred

LengthErrorException - a LENGERR condition occurred

NotOpenException - a NOTOPEN condition occurred

TokenErrorException - a TOKENERR condition occurred

ContainerErrorException - a CONTAINERERR condition occurred

ChannelErrorException - a CHANNELERR condition occurred

Since CICS TS version:

3.1

Since package version:

1.0

writeHeader

public void writeHeader(HttpSession session,
                        java.lang.String header,
                        java.lang.String value)
                 throws InvalidRequestException,
                        NotOpenException

Usage:
Add HTTP header information to the request This is equivalent to CICS API command WEB WRITE SESSTOKEN.

Parameters:

session - is the HttpSession object associated with the request to be sent

header - contains the name of the HTTP header

value - contains the value of the named header

Throws:

InvalidRequestException - a INVREQ condition occurred

NotOpenException - a NOTOPEN condition occurred

Since CICS TS version:

3.1

Since package version:

1.0