Define web port characteristics
The JANUS WEB command defines the rules for a Janus Web Server running on a WEBSERV port. Web rules control access and routing of URL requests, and they can cause a request for a URL to initiate a complex database process.
Syntax
JANUS WEB portname rule_type [method] url [optional parameters]
The JANUS WEB command differs from most Janus commands in that it usually takes a set of commands to fully specify the rules that give a web server its characteristics. For instance, it may take a number of commands to specify user ID access, to restrict the range of IP addresses that may connect, and then to specify the server's routing and behavior based on different types of requested URLs. The order in which JANUS WEB commands are specified also affects how they are processed.
The first four parameters are positional, and all parameters are required but the method:
| portname |
The 1- to 30-character name of the port for which the access and URL processing rules are being defined. |
|---|
| rule_type |
The type of web rule that is being specified for the port. Valid values are:
| NOREDIRECT |
indicates no redirection |
|---|
| REDIRECT |
indicates redirection |
|---|
| DISALLOW |
removes access permission |
|---|
| ALLOW |
assigns access permission |
|---|
| TYPE |
defines content type |
|---|
| NODEBUG |
prevents JANUSDEBUG debugging |
|---|
| DEBUG |
enables JANUSDEBUG debugging |
|---|
| ON |
defines processing |
|---|
| SCREEN |
defines mapping of 3270 screen to HTML
|
|---|
The order in which the JANUS WEB rule types are shown above is the order in which they are processed. Within each rule_type, rules are processed from most recent to oldest:
- REDIRECT and NOREDIRECT rules are processed; if a redirection is specified, it is executed.
Otherwise:
- Privileges are processed (ALLOW and DISALLOW rules).
If access to the URL is allowed:
- A TYPE specification is obtained.
- If a DEBUG is indicated, the request waits for a user to debug the request via the JANUSDEBUG command.
- ON processing is invoked.
- A SCREEN mapping is established.
|
|---|
| method |
The HTTP method(s) that applies to the rule. The method value can be any of the following:
| ANY |
Any of the JANUS WEB supported HTTP methods (subject to the restriction that the length of the method name must not exceed 16 characters). |
|---|
| CONNECT |
A request to a proxy to establish an HTTP tunnel. This method is supported as of version 7.7 of Model 204. |
|---|
| COPY |
A request to create a duplicate of the specified source resource. This method is supported as of version 7.7 of Model 204. |
|---|
| DELETE |
A request to delete the resource identified by the specified network address. This method is supported as of version 7.7 of Model 204. |
|---|
| GET |
A simple request for a URL based on the URL name (includes HTTP GET and HTTP HEAD). |
|---|
| GET+POST |
The GET or POST method; the JANUS WEB default. |
|---|
| HEAD |
This method is based on GET rules and is not used frequently (if at all) by most browsers. |
|---|
| LOCK |
A request to take out a lock on the specified resource. This method is supported as of version 7.7 of Model 204. |
|---|
| MKCOL |
A request to create a WebDAV collection at the specified location on the server. This method is supported as of version 7.7 of Model 204. |
|---|
| OPTIONS |
A request for information about the communication options available.
This method is supported as of version 7.7 of Model 204. |
|---|
| OTHER |
All methods other than PUT, GET, POST, and HEAD (subject to the restriction that the length of the method name must not exceed 16 characters). |
|---|
| PATCH |
A request to apply changes to the specified resource. This method is supported as of version 7.7 of Model 204. |
|---|
| POST |
A request for a URL that is accompanied by data from an HTML form. |
|---|
| PROPFIND |
A request to retrieve properties, stored as XML, from the specified resource. This method is supported as of version 7.7 of Model 204. |
|---|
| PROPPATCH |
A request to alter properties defined on the specified resource. This method is supported as of version 7.7 of Model 204. |
|---|
| PUT |
A request to replace the contents of a URL, that is, a file upload. Note that while other methods have default ALLOW rules, which depend on the port type, PUT never has default ALLOW rules. That is, PUT is never permitted except by an explicit JANUS WEB ALLOW rule. |
|---|
| TRACE |
A request to return the entire request message, as data for testing or diagnostic information. This method is supported as of version 7.7 of Model 204. |
|---|
| UNLOCK |
A request to remove a lock on the specified resource. This method is supported as of version 7.7 of Model 204. |
|---|
By specifying a method on a JANUS WEB command, you indicate the rule is only to apply to that method. If no method is specified, GET+POST is assumed. |
|---|
| url |
Universal Resource Locator (URL). Every web request contains a URL, which can be considered to specify the "name" or "identity" of the "object" being requested. For example, the URL may specify the name of a file or the name (and some parameters) of an application. The url specified in the JANUS WEB command is a case-sensitive pattern, which is compared to the requested URL; the last rule that matches the URL is the rule that applies. The pattern can include an asterisk (*) as a "wildcard" indicator (*.jpg thus specifies any URL with a .jpg suffix).
Note: Janus port definitions include the UPCASE specification by default. If you define a web rule using a lowercase URL, the rule may fail in the default case where the incoming URL is converted to uppercase. For example, a TYPE rule that uses the pattern *.pdf may not recognize a request for a file of type PDF.
The url value can also be the name of an exception condition. |
|---|
| optional parameters |
The optional parameters allowed for the JANUS WEB command depend on the rule_type that was specified; see the List of JANUS WEB subcommands.
|
|---|
The JANUS CLSOCK and JANUS SRVSOCK commands are used by Janus Sockets to establish rules for CLSOCK ports and SRVSOCK ports, respectively. Note that the JANUS WEB command differs from the corresponding rules available with the JANUS CLSOCK and JANUS SRVSOCK commands in the following ways:
- JANUS WEB does not allow any optional parameters (for example, USGROUP) on the DISALLOW rule.
- The default access for WEBSERV non-SSL ports and SRVSOCK ports is ALLOW. The default access for WEBSERV SSL ports and CLSOCK ports is DISALLOW.
- ALLOW and DISALLOW are the only rule types for JANUS CLSOCK and JANUS SRVSOCK; there are a number of other rule types for JANUS WEB.
See also