With the HTTP-DESCRIPTOR statement, a mapping of the path received in an HTTP request to a TAC is defined and additional processing parameters can be specified. The specifications in the HTTP-DESCRIPTOR statement are used by UTM after receiving an HTTP request to determine the TAC to which the message is to be sent and to control the processing of the message.
If no suitable HTTP-DESCRIPTOR statement is defined for the path of an HTTP request, UTM performs a standard conversion of the messages for this request if the path can be mapped directly to a TAC defined for the application.
| Only on BS2000 systems |
http-descriptor-name | The parameter http-descriptor-name has only local application meaning. It assigns a local name to the HTTP-DESCRIPTOR. This is required, for example, at the administration interface. The name can be a maximum of 8 characters long. |
| BCAMAPPL = bcamappl | |
With BCAMAPPL, you can specify the name of a BCAMAPPL statement. If BCAMAPPL is specified, the HTTP-DESCRIPTOR statement is only valid for HTTP connections via this BCAMAPPL. If *ALL is specified, the HTTP-DESCRIPTOR statement applies to all HTTP connections. The BCAMAPPL statement can also be used to specify the schema (HTTP/HTTPS) for which this HTTP-DESCRIPTOR is to be valid. The name can be a maximum of 8 characters long. Default: *ALL | |
CONVERT-TEXT = | The parameter CONVERT-TEXT may only be specified in BS2000 systems. The CONVERT-TEXT parameter specifies whether UTM is to perform a code conversion for text messages or not. UTM evaluates the specifications in the Content-Type header of an HTTP request and and the mapping to a code conversion tables defined with the CHAR-SET statement. A code conversion of an HTTP message is only performed, for example, if a code conversion table is assigned to the character set specified in the Content-Type header using the CHAR-SET statement. |
*YES | UTM should perform a code conversion. |
*NO | UTM should not perform a code conversion. |
HTTP-EXIT = | The HTTP-EXIT parameter can be used to define a user program that is to be called by UTM to reformat the input and output messages. The name of the user program must not exceed 32 characters. |
*NONE | If *NONE is specified for HTTP-EXIT, web-aware programs that can process messages from HTTP clients directly, that is, without reformatting, are identified. *NONE is the default value. |
*SYSTEM | With *SYSTEM you can specify that UTM is to convert output messages into HTML format. |
TAC = tac | The parameter TAC determines the TAC and therefore the part-program that is to be called for requests with the path specified in this statement. The TAC must be defined with a TAC statement. Only one dialog TAC may be specified. The same TAC may be specified in different HTTP-DESCRIPTOR statements. The TAC can be a maximum of 8 characters long. |
PATH = | According to RFC 3986 "Uniform Resource Identifier" a URI is structured as follows:
The path of an HTTP request is used to address a resource. UTM uses the path to determine the part-program to which an HTTP request is to be sent. If no TAC can be determined in any way for an incoming HTTP request, for example, because no standard path (C'/*') has been generated, the HTTP request is rejected with status code 404 Not Found. A "*" as the last character in the parameter PATH has the meaning of a wildcard character, i.e. the prefix of the path is defined via such a declaration. If the beginning of the path of an HTTP request matches a path prefix defined in this way, then this HTTP-DESCRIPTOR is evaluated for the request. |
C'path' | The parameter path must fulfill the following conditions:
KDCDEF stores the path specified here in normalized form. This means that %-coded substitute representations of unreserved characters and spaces are converted to their equivalent one-character representation. For % codes and Unreserved Characters see RFC 3986. |
C'/*' | An HTTP-DESCRIPTOR statement with PATH=C'/*' defines the standard behavior for one or all BCAMAPPLs. Such a declaration is used by UTM if a TAC cannot be determined for an HTTP request in any other way. |
USER-AUTH = | The USER-AUTH parameter specifies which authorization mechanism clients must use for this application. The value set here for this parameter applies to all HTTP messages to which a TAC is assigned using this HTTP-DESCRIPTOR statement. If the UTM application is generated without users, only the value *NONE may be specified for USER-AUTH. |
*BASIC | The Basic Authentication Scheme from RFC 2617 is to be used to transfer authentication data. UserId and password are separated by a colon and Base64 encoded in the authorization header of an HTTP request. If Basic Authorization is defined for an HTTP request, but no Authorization Header is contained in the HTTP request, UTM requests authentication data using a response with status code 401 Unauthorized. |
*NONE | If *NONE is specified, the client does not have to pass any authentication data. UTM uses the connection user for such a request if the client does not send authentication information in the HTTP request itself. Default: *NONE |