Web domain’s specific gates

Table 114 summarizes the Web domain’s specific gates. It shows the level-1 trace point IDs of the modules providing the functions for the gate, the functions provided by the gate, and whether or not the functions are available through the exit programming interface (XPI).

Table 114. Web domain’s specific gates
Gate Trace Function XPI
WBAP
WB 0300
WB 0301
START_BROWSE
READ_NEXT
END_BROWSE
GET_MESSAGE_BODY
GET_HTTP_RESPONSE
SEND_RESPONSE
READ_HEADER
WRITE_HEADER
INQUIRE
NO
NO
NO
NO
NO
NO
NO
NO
NO
Start of changeWBCLEnd of change Start of change
WB 0700
WB 0701
End of change
Start of change
PARSE_URL
OPEN_SESSION
WRITE_HEADER
WRITE_REQUEST
READ_RESPONSE
READ_HEADER
START_BROWSE_HEADERS
READ_NEXT_HEADER
END_BROWSE_HEADERS
INQUIRE_SESSION
CLOSE_SESSION     
End of change
Start of change
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
End of change
Start of changeWBRPEnd of change Start of change
WB 0A00
WB 0A01
End of change
Start of change
CATALOG_URIMAP
DELETE_URIMAP
CATALOG_HOST
DELETE_HOST
RECOVER_DEFINITIONS
End of change
Start of change
NO
NO
NO
NO
NO
End of change
WBSR
WB 0500
WB 0501
SEND
RECEIVE
Start of changeSEND_STATIC_RESPONSEEnd of change
NO
NO
NO
Start of changeWBUREnd of change Start of change
WB 0900
WB 0901
End of change
Start of change
INITIALIZE_URIMAPS
ADD_REPLACE_URIMAP
DELETE_URIMAP
LOCATE_URIMAP
INQUIRE_URIMAP
SET_URIMAP
START_BROWSE_URIMAP
GET_NEXT_URIMAP
END_BROWSE_URIMAP
INQUIRE_HOST
SET_HOST
START_BROWSE_HOST
GET_NEXT_HOST
END_BROWSE_HOST   
End of change
Start of change
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
End of change

WBAP gate, START_BROWSE function

The START_BROWSE function starts a browse of the HTTP headers or the HTML forms data in an HTTP request.

Input parameters

None

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
INVALID_REQUEST_FORMAT
NON_WEB_TRANSACITON
HEADER_BROWSE_ACTIVE
FORMFLD_BROWSE_ACTIVE
CLIENT_CODEPAGE_UNSUPP
SERVER_CODEPAGE_UNSUPP
NO_FORMS_DATA
INVALID_CODEPAGE_COMBIN
DISASTER
FORMFIELD_STRUCT_FORM_ERR
FORMFIELD_CANNOT_GET_BODY
FORMFIELD_STRUCT_CORRUPT
FORMFIELD_CORRUPT_HEADER
FORMFIELD_NO_BOUNDARY_STR
FORMFIELD_NO_CONTENT_HDR
FORMFIELD_UNKNOWN_FORMTYPE
NO_CONVERT_PARM

WBAP gate, READ_NEXT function

The READ_NEXT function returns the next HTTP header in a browse of HTTP headers.

Input parameters

None

Output parameters

HTTP_HEADER_BUFFER_NAME
returns the name of the next HTTP header
HTTP_HEADER_BUFFER_VALUE
returns the value of the next HTTP header
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
BROWSE_END
NON_WEB_TRANSACTION
HEADER_BROWSE_NOT_ACTIVE
FORMFLD_BROWSE_NOT_ACTIVE
HEADER_VALUE_LENGTH_ERROR
HEADER_NAME_LENGTH_ERROR
INVALID_HEADER
FORMFLD_VALUE_LENGTH_ERROR
FORMFLD_NAME_LENGTH_ERROR
NO_FORMS_DATA
INVALID_FORMFLD
DISASTER
FORMFIELD_STRUCT_CORRUPT
FORMFIELD_CORRUPT_HEADER
NO_CONVERT_PARM

WBAP gate, END_BROWSE function

The END_BROWSE function defines the end of a browse of the HTTP headers received for an HTTP request.

Input parameters

None

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NON_WEB_TRANSACTION
HEADER_BROWSE_NOT_ACTIVE
FORMFLD_BROWSE_NOT_ACTIVE

WBAP gate, GET_MESSAGE_BODY function

The GET_MESSAGE_BODY function retrieves the previously constructed body of an HTTP response.

Input parameters

DATA_BUFFER
Buffer into which the data is to be placed
TRUNCATE
indicates whether or not data is to be truncated if the buffer is too small. It can have the following values:
YES|NO
CLIENT_CODEPAGE
ASCII Codepage into which the data is to be converted before being passed back to the caller
SERVER_CODEPAGE
EBCDIC Codepage of the data to be passed back
CONVERT
indicates whether or not data is to undergo codepage conversion. It can have the following values:
YES|NO

Output parameters

SET_BLOCK
Address of a block of storage containing the message body
REQUEST_TYPE
Indicates whether we are processing an HTTP Request It can have the following values:
HTTP|NON_HTTP
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
CODEPAGE_NOT_FOUND
NON_WEB_TRANSACTION

WBAP gate, GET_HTTP_RESPONSE function

The GET_HTTP_RESPONSE function retrieves the HTTP Response which has been constructed by a Web API application program.

Input parameters

DOCUMENT_TOKEN
is the 8 byte field into which CICS® places the document token identifying the document which contains the body of the HTTP response

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NON_WEB_TRANSACTION
NO_PREVIOUS_WEB_SEND

WBAP gate, SEND_RESPONSE function

The SEND_RESPONSE function identifies a CICS Document which is to be used as the body of a HTTP response, and the HTTP reason code with which that response is to be returned.

Input parameters

DOCUMENT_TOKEN
identifies the CICS document to be used as the body of the HTTP response
CLIENT_CODEPAGE
identifies the ASCII codepage into which the body of the HTTP response is to be converted
STATUS_CODE
HTTP response code with which the HTTP response is returned
STATUS_TEXT
Text to accompany HTTP response code with which the HTTP response is returned.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NON_WEB_TRANSACTION
DOCUMENT_NOT_FOUND
CODEPAGE_NOT_FOUND

WBAP gate, READ_HEADER function

The READ_HEADER function returns the value of a specific HTTP request header.

Input parameters

HTTP_HEADER_BLOCK_VALUE
Buffer containing name of the header for which a value is returned
HTTP_HEADER_BLOCK_VALUE
Buffer containing the value of the requested header

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
HEADER_NOT_FOUND
INVALID_REQUEST_FORMAT
NON_WEB_TRANSACTION

WBAP gate, WRITE_HEADER function

The WRITE_HEADER function causes a HTTP response header to be stored by CICS.

Input parameters

HTTP_HEADER_BLOCK_NAME
Buffer containing name of header
HTTP_HEADER_BLOCK_VALUE
Buffer containing value of header

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION NON_WEB_TRANSACTION

WBAP gate, INQUIRE function

The INQUIRE function passes back information pertaining to an HTTP request.

Input parameters

SERVER_NAME
Buffer to contain TCP/IP name of CICS
CLIENT_NAME
Buffer to contain TCP/IP name of client from which HTTP request was received.
HTTP_METHOD
Buffer to contain HTTP method specified on the HTTP request
HTTP_VERSION
Buffer to contain HTTP version specified on the HTTP request
QUERYSTRING
Buffer to contain HTTP query string specified on the HTTP request
URI
Buffer to contain URI specified on the HTTP request

Output parameters

CLIENT_ADDR
Fullword containing IP address of the client from which the HTTP request was received
SERVER_ADDR
Fullword containing IP address of the TCP/IP stack on which the HTTP request was received
SERVER_PORT
Fullword containing port number on which the HTTP request was received
CERTIFICATE_TOKEN
eight byte token identifying SSL certificate of client issuing this HTTP request
REQUEST_TYPE
Indicates whether CICS recognized the incoming data as a valid HTTP request. Can be set to:
HTTP|NON_HTTP
SSL_TYPE
Indicates what level of SSL support applies to the incoming HTTP request. Can be set to:
YES|NO|CLIENTAUTH
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NON_WEB_TRANSACTION
INVALID_REQUEST_FORMAT
Start of change

WBCL gate, PARSE_URL function

The PARSE_URL function parses a URL into its constituent components.

Input parameters

URL

Output parameters

SCHEME
[SCHEME_NAME]
HOST
PORT
PATH
QUERY_STRING
[IP_ADDRESS]
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of changeStart of change

WBCL gate, OPEN_SESSION function

The OPEN_SESSION function opens a session with the HTTP server.

Input parameters

SCHEME
HOST
PORT
[URIMAP]
[HOST_CODEPAGE]
[CERTIFICATE_LABEL]
[CIPHER_COUNT, CIPHER_SUITES]
[PROXY_URL]

Output parameters

SESSION_TOKEN
[HTTP_VNUM]
[HTTP_RNUM]
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of changeStart of change

WBCL gate, WRITE_HEADER function

The WRITE_HEADER function adds one HTTP header to the HTTP request being composed. It can be called multiple times to add multiple headers.

Input parameters

SESSION_TOKEN
NAME
VALUE

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of changeStart of change

WBCL gate, WRITE_REQUEST function

The WRITE_REQUEST function appends the request body to the HTTP request being composed, and schedules it to be sent. It also handles sending a chunk of data.

Input parameters

SESSION_TOKEN
[CHUNK | BODY | CONTAINER_NAME CONTAINER_POOL]
[DOCUMENT_TOKEN]
[PATH]
[URIMAP]
[QUERY_STRING]
METHOD
[MEDIATYPE]
[ACTION_PARAMETER]
[TRANSLATE]
[CHARSET]
[HOST_CODEPAGE]
[ACTION]
[CLOSE]
[CONVERSE]

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of changeStart of change

WBCL gate, READ_RESPONSE function

The READ_RESPONSE function waits for and then reads the HTTP response that is expected from the HTTP server.

Input parameters

SESSION_TOKEN
[BODY | CONTAINER_NAME CONTAINER_POOL]
[TRANSLATE]
[HOST_CODEPAGE]
[TIME_OUT_VALUE]
[TRUNCATE]
[MAX_DATA_LENGTH]
[STATUS_TEXT]

Output parameters

STATUS_CODE
[SET_BUFFER]
[MEDIATYPE]
[CHARSET]
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of changeStart of change

WBCL gate, READ_HEADER function

The READ_HEADER function reads a specific HTTP header from the HTTP response that has been received.

Input parameters

SESSION_TOKEN
NAME
VALUE_BUFFER

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of changeStart of change

WBCL gate, START_BROWSE_HEADERS function

The START_BROWSE_HEADERS function starts a browse of the HTTP headers for a response that has been received.

Input parameters

SESSION_TOKEN

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of changeStart of change

WBCL gate, READ_NEXT_HEADER function

The READ_NEXT_HEADER function reads the next HTTP header in the browse operation for an HTTP response that has been received.

Input parameters

SESSION_TOKEN
NAME_BUFFER
VALUE_BUFFER

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of changeStart of change

WBCL gate, END_BROWSE_HEADERS function

The END_BROWSE_HEADERS function ends a browse of the HTTP headers for an HTTP response that has been received.

Input parameters

SESSION_TOKEN

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of changeStart of change

WBCL gate, INQUIRE_SESSION function

The INQUIRE_SESSION function returns information about the specified connection to a server, represented by the session token.

Input parameters

SESSION_TOKEN
[HOST_BUFFER]
[PATH_BUFFER]

Output parameters

[SCHEME]
[HTTP_VNUM]
[HTTP_RNUM]
[URIMAP]
[PORT]
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of changeStart of change

WBCL gate, CLOSE_SESSION function

The CLOSE_SESSION function ends the connection to the server by closing the socket and releasing the session control block.

Input parameters

SESSION_TOKEN

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of changeStart of change

WBRP gate, CATALOG_URIMAP function

The CATALOG_URIMAP function adds a URIMAP resource definition to the catalog.

Input parameters

URIMAP_DEFINITION

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
LOOP
ABEND
CATALOG_WRITE_FAILURE
End of changeStart of change

WBRP gate, DELETE_URIMAP function

The DELETE_URIMAP function deletes a URIMAP resource definition from the catalog.

Input parameters

URIMAP

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
LOOP
ABEND
CATALOG_DELETE_FAILURE
End of changeStart of change

WBRP gate, CATALOG_HOST function

The CATALOG_HOST function adds a virtual host to the catalog.

Input parameters

HOST_DEFINITION

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
LOOP
ABEND
CATALOG_WRITE_FAILURE
End of changeStart of change

WBRP gate, DELETE_HOST function

The DELETE_HOST function removes a virtual host from the catalog.

Input parameters

HOST_DEFINITION

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
LOOP
ABEND
CATALOG_DELETE_FAILURE
End of changeStart of change

WBRP gate, RECOVER_DEFINITIONS function

The RECOVER_DEFINITIONS function recovers previously installed definitions from the global catalog on a CICS warm start. URIMAP definitions and virtual hosts are recovered.

Input parameters

None

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE Possible REASON values
DISASTER
CATALOG_BROWSE_FAILURE
CATALOG_PURGE_FAILURE
LOGIC_ERROR
WAIT_PHASE_FAILURE
ABEND
End of change

WBSR gate, RECEIVE function

The RECEIVE function receives an HTTP Request off a socket, and parses it in order to determine what to do with it.

Input parameters

INITIAL_RECEIVE
Indicates whether this is the first receive issued by the caller, Can be set any of these values:
YES|NO

Output parameters

TOKEN
Token uniquely identifying the WebRequestBlock associated with this HTTP request.
ATTACH_TRANSID
Transaction ID of Web alias transaction to be attached to continue processing the HTTP request.
FAILING_PROGRAM
Name of program which returned an error in the course of receiving the HTTP request.
CONNECTION_PERSIST
Indicates whether the HTTP Request included the HTTP 1.0 Keepalive header. Can be set to any of these values:
YES|NO
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NO_ANALYZER_SPECIFIED
ANALYZER_LINK_ERROR
ANALYZER_ERROR
ANALYZER_DATALENG_ERROR
HDR_LENGTH_ERROR
RECEIVE_ERROR
STORAGE_ERROR
CONNECTION_CLOSED
LOGIC_ERROR

WBSR gate, SEND function

The SEND function returns the response constructed following receipt of an HTTP request.

Input parameters

TOKEN
Token identifying WebRequestBlock with which this SEND is associated

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
STORAGE_ERROR
SEND_ERROR
CONNECTION_CLOSED
LOGIC_ERROR
Start of change

WBSR gate, SEND_STATIC_RESPONSE function

The SEND_STATIC_RESPONSE function returns a static response specified by a URIMAP definition following receipt of an HTTP request.

Input parameters

None

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION

End of changeStart of change

WBUR gate, URIMAP attributes

This list of URIMAP parameters is common to several functions on the WBUR gate.

Parameters

[SCHEME]
[USAGE]
[STATUS]
[ANALYZER]
[TRANSACTION]
[CONVERTER]
[PROGRAM]
[PIPELINE_NAME]
[WEBSERVICE_NAME]
[USERID]
[MEDIATYPE]
[CHARACTERSET]
[HOSTCODEPAGE]
[TEMPLATENAME]
[CERTIFICATE_LABEL]
[CIPHER_COUNT CIPHER_SUITES]
[REDIRECTION_TYPE]
End of changeStart of change

WBUR gate, INITIALIZE_URIMAPS function

The INITIALIZE_URIMAPS function initializes the Web domain state required by the URIMAP support.

Input parameters

None

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of changeStart of change

WBUR gate, ADD_REPLACE_URIMAP function

The ADD_REPLACE_URIMAP function adds or replaces a URIMAP definition into the Web domain.

Input parameters

URIMAP
HOST
PATH
[HFSFILE]
[REDIRECTION_LOCATION]
URIMAP attributes
see WBUR gate, URIMAP attributes
[TCPIPSERVICE]

Output parameters

[DUPLICATE_URIMAP]
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of changeStart of change

WBUR gate, DELETE_URIMAP function

The DELETE_URIMAP function deletes a URIMAP definition from the Web domain.

Input parameters

URIMAP

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of changeStart of change

WBUR gate, LOCATE_URIMAP function

The LOCATE_URIMAP function is used to locate a URIMAP definition associated with a specified HOST and PATH.

Input parameters

HOST
PATH
[HFSFILE]
[REDIRECTION_LOCATION]
[TCPIPSERVICE]

Output parameters

URIMAP
URIMAP attributes
see WBUR gate, URIMAP attributes
[UME_TOKEN]
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of changeStart of change

WBUR gate, INQUIRE_URIMAP function

The INQUIRE_URIMAP function is used to inquire on the attributes of a URIMAP resource.

Input parameters

URIMAP
[HOST]
[PATH]
[HFSFILE]
[REDIRECTION_LOCATION]

Output parameters

URIMAP attributes
see WBUR gate, URIMAP attributes
[TCPIPSERVICE]
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of changeStart of change

WBUR gate, SET_URIMAP function

The SET_URIMAP function is used to set the attributes of a URIMAP resource.

Input parameters

URIMAP
[HOST]
[PATH]
[HFSFILE]
[REDIRECTION_LOCATION]
[TCPIPSERVICE]
URIMAP attributes
see WBUR gate, URIMAP attributes

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of changeStart of change

WBUR gate, START_BROWSE_URIMAP function

The START_BROWSE_URIMAP function is used to begin a browse through the URIMAP resources in the Web domain.

Input parameters

None

Output parameters

BROWSE_TOKEN
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of changeStart of change

WBUR gate, GET_NEXT_URIMAP function

The GET_NEXT_URIMAP function is used to continue a browse through the URIMAP resources in the Web domain.

Input parameters

BROWSE_TOKEN
[HOST]
[PATH]
[HFSFILE]
[REDIRECTION_LOCATION]

Output parameters

URIMAP
[TCPIPSERVICE]
URIMAP attributes
see WBUR gate, URIMAP attributes
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of changeStart of change

WBUR gate, END_BROWSE_URIMAP function

The END_BROWSE_URIMAP function is used to end a browse through the URIMAP resources in the Web domain.

Input parameters

BROWSE_TOKEN

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of changeStart of change

WBUR gate, INQUIRE_HOST function

The INQUIRE_HOST function is used to inquire on the attributes of a virtual host.

Input parameters

HOST
[TCPIPSERVICE]

Output parameters

STATUS
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of changeStart of change

WBUR gate, SET_HOST function

The SET_HOST function is used to set the attributes of a virtual host.

Input parameters

HOST
[TCPIPSERVICE]
STATUS

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of changeStart of change

WBUR gate, START_BROWSE_HOST function

The START_BROWSE_HOST function is used to begin a browse through the virtual host names in the Web domain.

Input parameters

None

Output parameters

BROWSE_TOKEN
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of changeStart of change

WBUR gate, GET_NEXT_HOST function

The GET_NEXT_HOST function is used to continue a browse through the virtual host names in the Web domain.

Input parameters

BROWSE_TOKEN
HOST

Output parameters

TCPIPSERVICE
STATUS
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of changeStart of change

WBUR gate, END_BROWSE_HOST function

The END_BROWSE_HOST function is used to end a browse of the virtual host names in the Web domain.

Input parameters

BROWSE_TOKEN

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION.
End of change [[ Contents Previous Page | Next Page Index ]]