4.10.4 Parameters used for setting up a reverse proxy
The following table describes the parameters that can be used to set up a reverse proxy. In the table below, Default value means the value that is assumed when the parameter is not specified. VR is the version of Application Server on which parameters are introduced or changed.
- Note:
-
The parameters used for setting up a reverse proxy are effective only if reverseproxy is specified for the manager.web.send_request_method parameter and item is specified for the SetBy parameter.
Table 4‒10: Parameters used for setting up a reverse proxy Value of param-name
Value of param-value
Specifiable value
Default value
VR
manager.web.reverseproxy.mapping
Specifies an entry that maps the request transfer source and destination for the reverse proxy.
Specify the source and destination with an intervening space as follows:
source-path destination-protocol destination-J2EE-server [communications-timeout-setting]
- source-path:
-
Specify the path of the request to be transferred to the J2EE server by using a URL that begins with a forward slash (/).
Do not specify multiple instances of the same path. If you do so, the system outputs the KEOS24506-W message and ignores the specification.
- destination-protocol:
-
Specify the protocol that will be used when the request is transferred to the J2EE server. You can specify http or ws.
- destination-J2EE-server:
-
Specify the name of the logical server for the J2EE server to which the request is to be forwarded. If you specify a name of a logical server for a J2EE server that does not exist, the message KEOS24507-W is output and the specified value is ignored.
If you specify multiple values, the correct values take effect, even when KEOS24507-W is output.
If no names of logical servers for a J2EE server are specified at all, the omission value is specified.
- communications-timeout-setting:
-
Specify, in the following format, the time (in seconds) to wait when sending or receiving communications with respect to the J2EE server.
timeout=communications-timeout
You can omit this setting.
The settings specified for this parameter are passed to the following directives on the web server:
ProxyPass path-name URL communications-timeout-setting
HWSProxyPassReverseCookie path
- path:
-
The value specified for source-path
- URL:
-
protocol://host:portpath
The details of each element in URL are as follows:
- protocol:
Value specified for destination-protocol
- host:
Host of the J2EE server in the same service unit as this web server
- port:
Port number of the NIO HTTP server for the J2EE server in the same service unit as this web server
- path:
The value specified for source-path
- communications-timeout-setting:
-
timeout=value-specified-for-communications-timeout-setting
If the setting for communications-timeout-setting has been omitted, the timeout key will not be output.
When building the system, the reverse proxy configuration file (httpsd_reverseproxy.conf) is generated in the same directory that contains httpsd.conf, and the settings related to reverse proxy are written. In httpsd.conf, a setting for including httpsd_reverseproxy.conf via the Include directive is added.
The following are details about the directives that are output to the reverse proxy configuration file (httpsd_reverseproxy.conf).
LoadModule proxy_module modules/mod_proxy.so (in Windows)
LoadModule proxy_http_module modules/mod_proxy_http.so (in Windows)
LoadModule proxy_wstunnel_module modules/mod_proxy_wstunnel.so (in Windows)
LoadModule proxy_module libexec/mod_proxy.so (in UNIX)
LoadModule proxy_http_module libexec/mod_proxy_http.so (in UNIX)
LoadModule proxy_wstunnel_module libexec/mod_proxy_wstunnel.so (in UNIX)
HWSPrfId PRFID
ProxyErrorOverride On|Off
ProxyPreserveHost On
ProxyPass path-name URL communications-timeout-setting
HWSProxyPassReverseCookie path-name
The preceding directives are output in the order in which they appear in the definition file. If you define multiple request mapping entries, note that the definition order is meaningful. For details, see the manual HTTP Server.
The following strings can be specified:
-
source-path
Character string beginning with a forward slash (/)
-
destination-protocol
http or ws
-
destination-J2EE-server
The name of a logical server of a J2EE server
-
communications-timeout-setting
Specify an integer from 1 to 65535.
/ http name-of-logical-server-of-J2EE-server-for-same-service-unit-as-Web-server
11-00
ProxyErrorOverride
Specifies whether to override the response header and response body from the J2EE server. For details, see the Cosminexus HTTP Server.
The following strings can be specified:
-
On
-
Off
None
11-00