|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.cics.server.HttpClientRequest
Usage:
This class provides the Java implementation of HTTP client requests related to the following
CICS API commands:
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:
Various send methods allow a document, an application buffer 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.
Field Summary | |
---|---|
static int |
NOTSET
|
Constructor Summary | |
---|---|
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 | |
---|---|
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 |
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 |
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 |
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 |
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 |
public static final int NOTSET
Constructor Detail |
public HttpClientRequest(java.lang.String method, java.lang.String mediaType)
method
- is the METHOD to be used by the WEB SEND SESSTOKEN commandmediaType
- is the MEDIATYPE value to be used by the WEB SEND SESSTOKEN command
None
Method Detail |
public void setMethodPost()
None
public void setMethodGet()
None
public void setMethodHead()
None
public void setMethodPut()
None
public void setMethodTrace()
None
public void setMethodOptions()
None
public void setMethodDelete()
None
public void setCharacterset(java.lang.String characterset)
characterset
- is the CHARACTERSET value to be used by the WEB SEND SESSTOKEN command
None
public void setClose()
None
public void setNoClose()
None
public void setActionExpect()
None
public void setMediaType(java.lang.String mediaType)
mediaType
- contains MEDIATYPE information to be used by the WEB SEND SESSTOKEN command
None
public void setPath(java.lang.String path)
path
- contains PATH information to be used by the WEB SEND SESSTOKEN command
None
public void setUrimap(java.lang.String urimap)
urimap
- contains the URIMAP name to be used by the WEB SEND SESSTOKEN command
None
public void setClientConvert()
None
public void setNoClientConvert()
None
public void setQueryString(java.lang.String queryString)
queryString
- contains QUERYSTRING information to be used by the WEB SEND SESSTOKEN command
None
public void sendDocument(HttpSession session, Document doc) throws InvalidRequestException, RecordNotFoundException, IOErrorException, NotAuthorisedException, LengthErrorException, NotOpenException, TokenErrorException
session
- is the HttpSession object associated with the request to be sentdoc
- is the Document object to be sent to the server
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 occurredpublic void sendFrom(HttpSession session, java.lang.String from) throws InvalidRequestException, RecordNotFoundException, IOErrorException, NotAuthorisedException, LengthErrorException, NotOpenException, TokenErrorException
session
- is the HttpSession object associated with the request to be sentfrom
- is the data to be sent to the server
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 occurredpublic void sendFrom(HttpSession session, byte[] from) throws InvalidRequestException, RecordNotFoundException, IOErrorException, NotAuthorisedException, LengthErrorException, NotOpenException, TokenErrorException
session
- is the HttpSession object associated with the request to be sentfrom
- is the data to be sent to the server
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 occurredpublic void send(HttpSession session) throws InvalidRequestException, RecordNotFoundException, IOErrorException, NotAuthorisedException, LengthErrorException, NotOpenException, TokenErrorException
session
- is the HttpSession object associated with the request to be sent
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 occurredpublic void sendChunk(HttpSession session, java.lang.String from) throws InvalidRequestException, RecordNotFoundException, IOErrorException, NotAuthorisedException, LengthErrorException, NotOpenException, TokenErrorException
session
- is the HttpSession object associated with the request to be sentfrom
- is the data to be sent to the server
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 occurredpublic void sendChunk(HttpSession session, byte[] from) throws InvalidRequestException, RecordNotFoundException, IOErrorException, NotAuthorisedException, LengthErrorException, NotOpenException, TokenErrorException
session
- is the HttpSession object associated with the request to be sentfrom
- is the data to be sent to the server
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 occurredpublic void sendLastChunk(HttpSession session) throws InvalidRequestException, RecordNotFoundException, IOErrorException, NotAuthorisedException, LengthErrorException, NotOpenException, TokenErrorException
session
- is the HttpSession object associated with the request to be sent
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 occurredpublic void writeHeader(HttpSession session, java.lang.String header, java.lang.String value) throws InvalidRequestException, NotOpenException
session
- is the HttpSession object associated with the request to be sentheader
- contains the name of the HTTP headervalue
- contains the value of the named header
InvalidRequestException
- a INVREQ condition occurred
NotOpenException
- a NOTOPEN condition occurred
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |