|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.cics.server.HttpClientResponse
Usage:
This class provides the Java implementation of HTTP client response related to the following
CICS API commands:
The setter methods allow instance variables to be set in the HttpClientResponse object. These variables relate to the following options on the CICS API command WEB RECEIVE SESSTOKEN:
By default MAXLENGTH is set to 32K and NOTRUNCATE is not set. These values can be overriden by the setters.
Method getContent() will receive the servers response body. This is equivalent to CICS API command WEB RECEIVE SESSTOKEN INTO.
Depending on the size of the body sent by the server and the MAXLENGTH value the complete body may not be received. Method isBodyComplete() returns boolean true if the whole body was returned by the getContent() method. If the whole body was not returned by getContent() then isBodyTruncated() returns boolean true unless setNoTruncate() was used to specify NOTRUNCATE. If NOTRUNCATE was specified and the complete body was not returned by getContent() then isBodyPartial() returns boolean true and getContent() can be used to obtain the next portion of the body.
Getters getStatusCode(), getStatusText(), getCharacterset() and getMediaType will return the STATUSCODE, STATUSTEXT, CHARACTERSET and MEDIATYPE of the servers response. These getters will only return information if the getContent() method has already been issued to obtain the body or part of the body.
Method getHeader() will return the contents of the required HTTP header, this is equivalent to CICS API command WEB READ SESSTOKEN.
Method startBrowseHeader() will start the browse of the HTTP headers, this is equivalent to CICS API command WEB STARTBROWSE SESSTOKEN.
Method getNextHeader() will return the next HTTP header name-value pair, this is equivalent to CICS API command WEB READNEXT SESSTOKEN.
Method endBrowseHeader() will terminate the browse of the HTTP headers, this is equivalent to CICS API command WEB ENDBROWSE SESSTOKEN.
Field Summary | |
---|---|
static int |
NOTSET
|
Constructor Summary | |
---|---|
HttpClientResponse()
Usage: Public default constructor. |
Method Summary | |
---|---|
void |
endBrowseHeader(HttpSession session)
Usage: Signal the end of the HTTP header browse. |
java.lang.String |
getCharacterset()
Usage: Returns the characterset of the servers response. |
byte[] |
getContent(HttpSession session)
Usage: Returns the body of the servers response. |
java.lang.String |
getHeader(HttpSession session,
java.lang.String header)
Usage: Returns the contents of a HTTP header. |
java.lang.String |
getMediaType()
Usage: Returns the mediatype of the servers response. |
HttpHeader |
getNextHeader(HttpSession session)
Usage: Returns the next HTTP header name-value pair to be browsed. |
int |
getStatusCode()
Usage: Returns the status code of the servers response. |
java.lang.String |
getStatusText()
Usage: Returns the status text of the servers response. |
boolean |
isBodyComplete()
Usage: Returns a boolean which indicates whether the body returned by getContent() was completely returned. |
boolean |
isBodyPartial()
Usage: Returns a boolean which indicates whether body returned by getContent() was a partial body or not. |
boolean |
isBodyTruncated()
Usage: Returns a boolean which indicates whether the body returned by getContent() was truncated or not. |
void |
setClientConvert()
Usage: Sets WEB RECEIVE SESSTOKEN command option CLIENTCONV to CLICONVERT. |
void |
setMaxLength(int maxLength)
Usage: Sets WEB RECEIVE SESSTOKEN command option MAXLENGTH. |
void |
setNoClientConvert()
Usage: Sets WEB RECEIVE SESSTOKEN command option CLIENTCONV to NOCLICONVERT. |
void |
setNoTruncate()
Usage: Sets WEB RECEIVE SESSTOKEN command option NOTRUNCATE. |
void |
setTruncate()
Usage: Resets WEB RECEIVE SESSTOKEN command option NOTRUNCATE. |
void |
startBrowseHeader(HttpSession session)
Usage: Signal the start of a browse of the HTTP headers from the first name-value pair. |
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 HttpClientResponse()
None
Method Detail |
public void setClientConvert()
None
public void setNoClientConvert()
None
public void setNoTruncate()
None
public void setTruncate()
None
public void setMaxLength(int maxLength) throws LengthErrorException
maxLength
- contains the maximum length value
LengthErrorException
- if maxlength is less than 1public byte[] getContent(HttpSession session) throws InvalidRequestException, IOErrorException, NotOpenException, TimedOutException
session
- is the HttpSession object associated with the RECEIVE.
InvalidRequestException
- a INVREQ condition occurred
IOErrorException
- a IOERR condition occurred
NotOpenException
- a NOTOPEN condition occurred
TimedOutException
- a TIMEDOUT condition occurredpublic int getStatusCode() throws InvalidRequestException
InvalidRequestException
- if getContent() not issued before this methodpublic java.lang.String getStatusText() throws InvalidRequestException
InvalidRequestException
- if getContent() not issued before this methodpublic java.lang.String getMediaType() throws InvalidRequestException
InvalidRequestException
- if getContent() not issued before this methodpublic java.lang.String getCharacterset() throws InvalidRequestException
InvalidRequestException
- if getContent() not issued before this methodpublic boolean isBodyComplete()
None
public boolean isBodyTruncated()
None
public boolean isBodyPartial()
None
public java.lang.String getHeader(HttpSession session, java.lang.String header) throws InvalidRequestException, NotOpenException
session
- is the HttpSession object associated with the READheader
- contains the name of the HTTP header
InvalidRequestException
- a INVREQ condition occurred
NotOpenException
- a NOTOPEN condition occurredpublic void startBrowseHeader(HttpSession session) throws InvalidRequestException, NotOpenException, LogicException
session
- is the HttpSession object associated with the BROWSE
InvalidRequestException
- a INVREQ condition occurred
NotOpenException
- a NOTOPEN condition occurred
LogicException
- a ILLOGIC condition occurredpublic HttpHeader getNextHeader(HttpSession session) throws LogicException, NotOpenException, EndOfFileException
session
- is the HttpSession object associated with the BROWSE
LogicException
- a ILLOGIC condition occurred
NotOpenException
- a NOTOPEN condition occurred
EndOfFileException
- a ENDFILE condition occurredpublic void endBrowseHeader(HttpSession session) throws LogicException, NotOpenException
session
- is the HttpSession object associated with the BROWSE
LogicException
- a ILLOGIC condition occurred
NotOpenException
- a NOTOPEN condition occurred
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |