JANUS WEB DEBUG: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:JANUS WEB DEBUG}} | {{DISPLAYTITLE:JANUS WEB DEBUG}} | ||
<span class="pageSubtitle"><section begin="desc" /> | <span class="pageSubtitle"><section begin="desc" />Set debugging options and levels<section end="desc" /></span> | ||
Available as of ''[[Sirius Mods]]'' 6.0, the JANUS WEB DEBUG command indicates that requests for a specified URL (the '''url''' value) are to be debugged, that is, the server is to wait for another user to issue a JANUSDEBUG command () before running the request on the issuing user's thread. | |||
==Syntax== | |||
<p class="syntax"><section begin="syntax" /> JANUS WEB portname DEBUG [method] url - | <p class="syntax"><section begin="syntax" /> JANUS WEB portname DEBUG [method] url - | ||
[IPADDR ipaddr | IPGROUP ipgroup] - | |||
[USER user | USGROUP usgroup] - | |||
[PORTOPEN | NOPORTOPEN] - | |||
[PORTCMD | NOPORTCMD] [PUBLIC] | |||
<section end="syntax" /></p> | <section end="syntax" /></p> | ||
<p class="caption">JANUS WEB DEBUG command syntax | <p class="caption">JANUS WEB DEBUG command syntax | ||
</p> | </p> | ||
'''Portname''', '''method''', and '''url''' are described under the [[JANUS WEB]] command. The remaining parameters for JANUS WEB DEBUG are described below: | |||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>IPADDR ipaddr</th> | <tr><th>IPADDR ipaddr</th> | ||
<td>Indicates that requests from an IP address that matches '''ipaddr''' will be debugged. '''Ipaddr''' can be a simple IP address, or it can be a subnet. Subnets are indicated by an IP address followed by either of these: | |||
<ul> | <ul> | ||
<li>A forward slash (/) followed by a netmask (with no intervening blanks) | |||
<li>A forward slash (/) followed by a netmask (with no intervening | <li>A hyphen (-) followed by a number of bits in the subnet mask (with no intervening blanks) | ||
<li>A hyphen (-) followed by a number of bits in the subnet mask (with | |||
</ul> | </ul> | ||
For example, <tt>198.244.244.97</tt> is a simple IP address that must be matched exactly. <tt>.198.242.244.0/255.255.255.0</tt>, which is equivalent to <code>198.242.244.0-24</code>, indicates that any machine on subnet 198.242.244.0 is to be allowed access to '''url'''. The IPADDR parameter cannot be specified if the IPGROUP parameter is specified. It is valid to specify neither IPADDR nor IPGROUP. If neither is specified, the rule applies to requests from all IP addresses. If IPADDR and USER or USGROUP are specified, a user must satisfy both the IPADDR criterion and the USER or USGROUP criterion for the request to be debugged.</td></tr> | |||
<tr><th>IPGROUP ipgroup</th> | <tr><th>IPGROUP ipgroup</th> | ||
<td>Indicates that requests from an IP address that is in '''ipgroup''' will be debugged. IP address groups are defined with the JANUS DEFINEIPGROUP command (). .do end .el command. The IPGROUP parameter cannot be specified if the IPADDR parameter is specified. It is valid to specify neither IPGROUP nor IPADDR. If neither is specified, the rule applies to requests from all IP addresses. If IPGROUP and USER or USGROUP are specified, a user must satisfy both the IPGROUP criterion and the USER or USGROUP criterion for the request to be debugged.</td></tr> | |||
<tr><th>USER user</th> | <tr><th>USER user</th> | ||
<td>Indicates that requests running under userid '''user''' will be debugged. '''user''' can be a specific userid, or it can contain wildcards. For example, if '''user''' is <tt>FLAN*</tt>, any request run under a userid that begins with the string <tt>FLAN</tt> will be debugged. The USER parameter cannot be specified if the USGROUP parameter is specified. It is valid to specify neither USER nor USGROUP. If neither is specified, the rule applies to requests running under any userid except public requests running under the WEBUSER ID.</td></tr> | |||
<tr><th>USGROUP usgroup</th> | <tr><th>USGROUP usgroup</th> | ||
<td>Indicates that requests running under a userid in '''usgroup''' will be debugged. User groups are defined with the JANUS DEFINEUSGROUP command (). .do end .el command. The USGROUP parameter cannot be specified if the USER parameter is specified. It is valid to specify neither USER nor USGROUP. If neither is specified, the rule applies to requests running under any userid, except public requests running under the WEBUSER ID.</td></tr> | |||
<tr><th>PORTOPEN | NOPORTOPEN</th> | <tr><th>PORTOPEN | NOPORTOPEN</th> | ||
<td>Indicates whether files or groups specified in the OPEN clause in the JANUS DEFINE command for the port are to be opened (PORTOPEN) or not (NOPORTOPEN). By default, these files or groups are not opened unless the port definition has the DEBPORTOPEN keyword. Files or groups in the JANUS DEFINE OPEN clause that are already open on the debugging users thread are not opened and do not have their file privileges adjusted to match the JANUS DEFINE OPEN clause requirements. Files or groups opened by JANUSDEBUG are closed when the request is completed. Use PORTOPEN if the files or groups in the port definition are required for proper application processing.</td></tr> | |||
<tr><th>PORTCMD | NOPORTCMD</th> | <tr><th>PORTCMD | NOPORTCMD</th> | ||
<td>Indicates whether the commands specified in the CMD clause in the JANUS DEFINE command for the port are to be issued (PORTCMD) or not (NOPORTCMD) on the debuging user's thread. By default, these commands are not issued unless the port definition has the DEBPORTCMD keyword. Use PORTCMD if the commands in the port definition are required for proper application processing or the these commands are to be debugged.</td></tr> | |||
<tr><th>PUBLIC</th> | <tr><th>PUBLIC</th> | ||
<td>Indicates that requests for public URLs, that is those that don't require a user login are to be debugged. Since a public URL requires no user login, there is no way for ''[[Janus Web Server]]'' to associate such a request with a particular userid, so '''any''' userid can debug '''any''' public request. In an environment with multiple programmers and/or testers, this is a formula for confusion, though programmers conscientious enough to specify IPADDR, IPGROUP, and/or URL on JANUSDEBUG commands can mitigate some of this confusion. In general, it is recommended that a login be required for any URL to be debugged, even if the non-debugged URL would not require a user login. | <td>Indicates that requests for public URLs, that is those that don't require a user login are to be debugged. Since a public URL requires no user login, there is no way for ''[[Janus Web Server]]'' to associate such a request with a particular userid, so '''any''' userid can debug '''any''' public request. In an environment with multiple programmers and/or testers, this is a formula for confusion, though programmers conscientious enough to specify IPADDR, IPGROUP, and/or URL on JANUSDEBUG commands can mitigate some of this confusion. In general, it is recommended that a login be required for any URL to be debugged, even if the non-debugged URL would not require a user login. | ||
</td></tr></table> | </td></tr></table> | ||
| Line 62: | Line 50: | ||
==References== | ==References== | ||
See: [[List of Janus commands]] | See: [[List of Janus commands]] | [[List of JANUS WEB subcommands]] | [[JANUS WEB NODEBUG]] | ||
[[Category:JANUS WEB subcommands|JANUS WEB DEBUG]] | [[Category:JANUS WEB subcommands|JANUS WEB DEBUG]] | ||
[[Category:Janus commands|JANUS WEB DEBUG]] | [[Category:Janus commands|JANUS WEB DEBUG]] | ||
[[Category: | [[Category:Commands|JANUS WEB DEBUG]] | ||
Revision as of 17:02, 3 March 2011
<section begin="desc" />Set debugging options and levels<section end="desc" />
Available as of Sirius Mods 6.0, the JANUS WEB DEBUG command indicates that requests for a specified URL (the url value) are to be debugged, that is, the server is to wait for another user to issue a JANUSDEBUG command () before running the request on the issuing user's thread.
Syntax
<section begin="syntax" /> JANUS WEB portname DEBUG [method] url - [IPADDR ipaddr | IPGROUP ipgroup] - [USER user | USGROUP usgroup] - [PORTOPEN | NOPORTOPEN] - [PORTCMD | NOPORTCMD] [PUBLIC] <section end="syntax" />
JANUS WEB DEBUG command syntax
Portname, method, and url are described under the JANUS WEB command. The remaining parameters for JANUS WEB DEBUG are described below:
| IPADDR ipaddr | Indicates that requests from an IP address that matches ipaddr will be debugged. Ipaddr can be a simple IP address, or it can be a subnet. Subnets are indicated by an IP address followed by either of these:
198.242.244.0-24, indicates that any machine on subnet 198.242.244.0 is to be allowed access to url. The IPADDR parameter cannot be specified if the IPGROUP parameter is specified. It is valid to specify neither IPADDR nor IPGROUP. If neither is specified, the rule applies to requests from all IP addresses. If IPADDR and USER or USGROUP are specified, a user must satisfy both the IPADDR criterion and the USER or USGROUP criterion for the request to be debugged. |
|---|---|
| IPGROUP ipgroup | Indicates that requests from an IP address that is in ipgroup will be debugged. IP address groups are defined with the JANUS DEFINEIPGROUP command (). .do end .el command. The IPGROUP parameter cannot be specified if the IPADDR parameter is specified. It is valid to specify neither IPGROUP nor IPADDR. If neither is specified, the rule applies to requests from all IP addresses. If IPGROUP and USER or USGROUP are specified, a user must satisfy both the IPGROUP criterion and the USER or USGROUP criterion for the request to be debugged. |
| USER user | Indicates that requests running under userid user will be debugged. user can be a specific userid, or it can contain wildcards. For example, if user is FLAN*, any request run under a userid that begins with the string FLAN will be debugged. The USER parameter cannot be specified if the USGROUP parameter is specified. It is valid to specify neither USER nor USGROUP. If neither is specified, the rule applies to requests running under any userid except public requests running under the WEBUSER ID. |
| USGROUP usgroup | Indicates that requests running under a userid in usgroup will be debugged. User groups are defined with the JANUS DEFINEUSGROUP command (). .do end .el command. The USGROUP parameter cannot be specified if the USER parameter is specified. It is valid to specify neither USER nor USGROUP. If neither is specified, the rule applies to requests running under any userid, except public requests running under the WEBUSER ID. |
| PORTOPEN | NOPORTOPEN | Indicates whether files or groups specified in the OPEN clause in the JANUS DEFINE command for the port are to be opened (PORTOPEN) or not (NOPORTOPEN). By default, these files or groups are not opened unless the port definition has the DEBPORTOPEN keyword. Files or groups in the JANUS DEFINE OPEN clause that are already open on the debugging users thread are not opened and do not have their file privileges adjusted to match the JANUS DEFINE OPEN clause requirements. Files or groups opened by JANUSDEBUG are closed when the request is completed. Use PORTOPEN if the files or groups in the port definition are required for proper application processing. |
| PORTCMD | NOPORTCMD | Indicates whether the commands specified in the CMD clause in the JANUS DEFINE command for the port are to be issued (PORTCMD) or not (NOPORTCMD) on the debuging user's thread. By default, these commands are not issued unless the port definition has the DEBPORTCMD keyword. Use PORTCMD if the commands in the port definition are required for proper application processing or the these commands are to be debugged. |
| PUBLIC | Indicates that requests for public URLs, that is those that don't require a user login are to be debugged. Since a public URL requires no user login, there is no way for Janus Web Server to associate such a request with a particular userid, so any userid can debug any public request. In an environment with multiple programmers and/or testers, this is a formula for confusion, though programmers conscientious enough to specify IPADDR, IPGROUP, and/or URL on JANUSDEBUG commands can mitigate some of this confusion. In general, it is recommended that a login be required for any URL to be debugged, even if the non-debugged URL would not require a user login. |
.pa
References
See: List of Janus commands | List of JANUS WEB subcommands | JANUS WEB NODEBUG