URM - Urimap Table

 Top  Previous  Next

This table contains the information about the URIMAPs.

To define an URIMAP the directive define urimap is used. 

define urimap

Defines an URIMAP entry in the XCICS/TS URIMAP table (URM). URIMAP options are strictly dependant on its usage.

define urimapname=<value>,
[enabled=(yes|no)],
[usage=(server|client|pipeline)],
[scheme=(http|https)],
[host="<string>"],
[path="<string>"],
[tcpipservice=<value>],
[type=(application|static|redirect)],
[analyzer=(yes|no)],
[converter=<value>],
[transaction=<value>],
[program=<value>],
[userid=<value>],
[file="<string>"],
[media_type="<string>"],
[characterset="<string>"],
[port=<value>],
[certificate="<string>"],
[ciphers=="<string>"],
[redirect_type=(temporary|permanent)],
[url="<string>"];

 

name

It is the name of the URIMAP.

enabled

Defines whether the URIMAP is enabled or not.

usage

defines the usage of teh URIMAP.

server

the URIMAP is used by XCICS acting as an HTTP server, to map the incoming requests

client

the URIMAP is used by XCICS acting as an HTTP client, to route the outgoing requests

pipeline

not yet supported

Options for server usage

host

The virtual host name for which the URIMAP applies. If the value is the wildcard "*", the URIMAP applies to all the virtual hosts.

path

The resource path for which the URIMAP applies. The wildcard "*" may be used to complete the path.

scheme

The URIMAP matches only request on the scheme specified. If it is not specified, the URIMAP matches both HTTP and HTTPS schemes.

tcpipservice

Restricts the URIMAP only to the requests caught by the specified tcpipservice. If omitted of if the value is the wildcard "*", the URIMAP applies to all the tcpip services.

type

Defines how the request is managed.

application

the request will be  handled by user application programs, which will dynamically generate the response

static

the request is mapped to a static resource (file) and will be handled by XCICS, which replies with the content of the file.

redirect

the response will redirect the client to the defined location

analyzer

Defines whether the analyzer will be activated or not. This option is valid for application type URIMAPs only.

converter

If specified, defines the name of the converter program to be invoked to encode/decode the request/response. This option is valid for application type URIMAPs only.

transaction

If specified, overrides the name of the default alias transaction. This option is valid for application type URIMAPs only.

program

The name of the application program to handle the request. This option is valid for application type URIMAPs only.

userid

If specified, the USERID used to run the alias transaction. This option is valid for application type URIMAPs only.

file

The absolute path of the file bind the request. The "*" wild-card may be used to complete the path name. This option is valid for static type URIMAPs only.

media_type

The media type of the file bind the request. If the "*" wild-card is specified, XCICS tries to identify the file media_type according to its extension. This option is valid for static type URIMAPs only.

characterset

Defines the character set of the file. This option is valid for static type URIMAPs only.

redirect_type

Specifies if the redirect is of temporary of permanent type. This option is valid for redirect type URIMAPs only.

url

Specifies URL where to redirect the client. This option is valid for redirect type URIMAPs only.

Options for client usage

host

The host name to address the request.

port

The prot number where to address the request on the remote host. If omitted the value is set to the default according to scheme required.

path

The resource path of the request.

scheme

The scheme used to address the request.

certificate

The name of the client certificate to use for HTTPS requests.

certificate

The name of the client certificate to use for HTTPS requests.

ciphers

The label of the ciphers suite to use for HTTPS requests.

Example

#
# server static urimaps
#
define urimap name=URI1, usage=server, type=static, host="*", path="/home/*", file="$HOME/regtest/web/*";
define urimap name=URI2, usage=server, type=static, scheme=https, host="*", path="/static";
define urimap name=URI3, usage=server, type=static, tcpipservice=*, scheme=http, host="*",
               path="/documents/*",
              file="/home/galletti/prova_sito_cwi/*",
               media_type="text/html";
#
# server application urimaps
#
define urimap name=URIA,
               usage=server, 
               type=application,
               analyzer=yes,
               host="*",
               program=PMACAURI,
               path="/prova/ana";
define urimap name=URIB,
               usage=server,
               type=application,
               scheme=http,
               analyzer=no,
               tcpipservice=HTTPD,
               host="*",
               transaction=CWBA,
               program=PMACAURI,
               path="/prova/anb";
#
# server redirect urimaps
#
define urimap name=RED0,
               usage=server,
               type=redirect,
               scheme=http,
               host="*",
               path="/gg",
               url="http://www.google.com";
#
# client urimaps
#
define urimap name=LX02, usage=client, host="linux02.ht.net", port=80,   path="/home";
define urimap name=LXIL, usage=client, host="linux02.ht.net", port=80,   path="/netserver";
define urimap name=LXXX, usage=client, host="linux02.ht.net", port=8080, path="/netserver";