HTTP and TCP/IP services
Getters in classes HttpHeader, NameValueData,
and FormField return HTTP headers, name and value
pairs, and form field values for the appropriate API commands.
| Methods | JCICS class | EXEC CICS Commands |
|---|---|---|
| get*() | CertificateInfo | EXTRACT CERTIFICATE / EXTRACT TCPIP |
| get*() | HttpRequest | EXTRACT WEB |
| getHeader() | HttpRequest | WEB READ HTTPHEADER |
| getFormField() | HttpRequest | WEB READ FORMFIELD |
| getContent() | HttpRequest | WEB RECEIVE |
| getQueryParm() | HttpRequest | WEB READ QUERYPARM |
| startBrowseHeader() | HttpRequest | WEB STARTBROWSE HTTPHEADER |
| getNextHeader() | HttpRequest | WEB READNEXT HTTPHEADER |
| endBrowseHeader() | HttpRequest | WEB ENDBROWSE HTTPHEADER |
| startBrowseFormField() | HttpRequest | WEB STARTBROWSE FORMFIELD |
| getNextFormField() | HttpRequest | WEB READNEXT FORMFIELD |
| endBrowseFormField() | HttpRequest | WEB ENDBROWSE FORMFIELD |
| startBrowseQueryParm() | HttpRequest | WEB STARTBROWSE QUERYPARM |
| getNextQueryParm() | HttpRequest | WEB READNEXT QUERYPARM |
| endBrowseQueryParm() | HttpRequest | WEB ENDBROWSE QUERYPARM |
| writeHeader() | HttpResponse | WEB WRITE |
| getDocument() | HttpResponse | WEB RETRIEVE |
| getCurrentDocument() | HttpResponse | WEB RETRIEVE |
| sendDocument() | HttpResponse | WEB SEND |
Each incoming HTTP request processed by CICS Web support includes an HTTP header. If the request uses the POST HTTP verb it also includes document data. Each response HTTP request generated by CICS Web support includes an HTTP header and document data.
- HTTP Header
- You can examine the HTTP header using the HttpRequest class. With HTTP in GET mode, if a client has filled in an HTTP form and selected the submit button, the query string is submitted.
- SSL
- CICS Web support provides the TcpipRequest class, which is extended by HttpRequest to obtain more information about which client submitted the request as well as basic information on the SSL support. If an SSL certificate is provided, you can use the CertificateInfo class to examine it in detail.
- Documents
- If a document is published to the server (HTTP POST), it is provided
as a CICS document. You can access it by calling the getDocument() method
on the HttpRequest class. See Document services for more information about processing
existing documents.
To serve the HTTP client web content resulting from a request, the server programmer needs to create a CICS document using the Document Services API and call the sendDocument() method.
For more information on CICS Web support see Internet, TCP/IP, and HTTP concepts. For more information on the JCICS Web classes see the JCICS Class Reference.