bea.com | products | dev2dev | support | askBEA |
|
e-docs > WebLogic Server > Using Web Server Plug-Ins WithWebLogic Server > Parameters for Web Server Plug-Ins |
Using Web Server Plug-Ins WithWebLogic Server |
Parameters for Web Server Plug-Ins
The following sections describe the parameters that you use to configure the Apache, Netscape, and Microsoft IIS Web server plug-ins:
Entering Parameters in Web Server Plug-In Configuration files
You enter the parameters for each Web server plug-in in special configuration files. Each Web server has a different name for this configuration file and different rules for formatting the file. For details, see the following sections on each plug-in:
General Parameters for Web Server Plug-Ins
Note: Parameters are case sensitive. WebLogic Server host (or virtual host name as defined in WebLogic Server) to which HTTP requests should be forwarded. If you are using a WebLogic cluster, use the WebLogicCluster parameter instead of WebLogicHost. Port at which the WebLogic Server host is listening for connection requests from the plug-in (or from other servers). (If you are using SSL between the plug-in and WebLogic Server, set this parameter to the SSL listen port (see Configuring the SSL Protocol) and set the SecureProxy parameter to ON ). If you are using a WebLogic Cluster, use the WebLogicCluster parameter instead of WebLogicPort. List of WebLogic Servers that can be used in a cluster for load balancing. The cluster list is a comma-delimited list of host:port entries. For example: WebLogicCluster myweblogic.com:7001, If you are using SSL between the plug-in and WebLogic Server, set the port number to the SSL listen port (see Configuring the SSL Protocol) and set the SecureProxy parameter to ON. Use WebLogicCluster instead of the WebLogicHost and WebLogicPort parameters. WebLogic Server looks first for the WebLogicCluster parameter. If not found, it looks for and uses WebLogicHost and WebLogicPort. The plug-in does a simple round-robin between all available cluster members. The cluster list specified in this property is a starting point for the dynamic cluster list that the server and plug-in maintain. WebLogic Server and the plug-in work together to update the cluster list automatically with new, failed, and recovered cluster members. Microsoft Internet Information Server only: You can disable the use of the dynamic cluster list by setting the DynamicServerList parameter to OFF The plug-in directs HTTP requests containing a cookie, URL-encoded session, or a session stored in the POST data to the server in the cluster that originally created the cookie. String trimmed by the plug-in from the beginning of the original URL, before the request is forwarded to WebLogic Server. For example, if the URL http://myWeb.server.com/weblogic/foo is passed to the plug-in for parsing and if PathTrim has been set to strip off /weblogic before handing the URL to WebLogic Server, the URL forwarded to WebLogic Server is: String that the plug-in prepends to the beginning of the original URL, after PathTrim is trimmed and before the request is forwarded to WebLogic Server. Maximum time in seconds that the plug-in should attempt to connect to the WebLogic Server host. Make the value greater than ConnectRetrySecs. If ConnectTimeoutSecs expires without a successful connection, even after the appropriate retries (see ConnectRetrySecs), an HTTP 503/Service Unavailable response is sent to the client. You can customize the error response by using the ErrorPage parameter. Interval in seconds that the plug-in should sleep between attempts to connect to the WebLogic Server host (or all of the servers in a cluster). Make this number less than the ConnectTimeoutSecs. The number of times the plug-in tries to connect before returning an HTTP 503/Service Unavailable response to the client is calculated by dividing ConnectTimeoutSecs by ConnectRetrySecs. To specify no retries, set ConnectRetrySecs equal to ConnectTimeoutSecs. However, the plug-in attempts to connect at least twice. You can customize the error response by using the ErrorPage parameter. Sets the type of logging performed for debugging operations. It is not advisable to switch on these debugging options in production systems. The debugging information is written to the /tmp/wlproxy.log file on UNIX systems and c:\TEMP\wlproxy.log on Windows NT/2000 systems. You can override this location and filename by setting the WLLogFile parameter to a different directory and file. For Debug to work correctly, the system administrator must ensure that the tmp or TEMP directory has write permission assigned to the user who is logged in to the server. You can set any of the following logging options (the HFC,HTW,HFW, and HTC options may be set in combination by entering them separated by commas, for example "HFC,HTW"): See the Debug parameter Specifies path and file name for the log file that is generated when the Debug parameter is set to ON. You must create this directory before setting this parameter. Enables the special query parameter "__WebLogicBridgeConfig". Use it to get details about configuration parameters from the plug-in. For example, if you enable "__WebLogicBridgeConfig" by setting DebugConfigInfo and then send a request that includes the query string ?__WebLogicBridgeConfig, then the plug-in gathers the configuration information and run-time statistics and returns the information to the browser. The plug-in does not connect to WebLogic Server in this case. This parameter is strictly for debugging and the format of the output message can change with releases. For security purposes, keep this parameter turned OFF in production systems. (Not available for the Microsoft Internet Information Server Plug-In) If set to true, the plug-in checks the existence and permissions of the translated path ("Proxy-Path-Translated") of the request before forwarding the request to WebLogic Server. If the file does not exist, an HTTP 404 File Not Found response is returned to the client. If the file exists but is not world-readable, an HTTP 403/Forbidden response is returned to the client. In either case, the default mechanism for the Web server to handle these responses fulfills the body of the response. This option is useful if both the WebLogic Server Web Application and the Web Server have the same document root. You can customize the error response by using the ErrorPage parameter. You can create your own error page that is displayed when your Web server is unable to forward requests to WebLogic Server. Defines the amount of time the plug-in waits for a response to a request from WebLogic Server. The plug-in waits for HungServerRecoverSecs for the server to respond and then declares that server dead, and fails over to the next server. The value should be set to a very large value. If the value is less than the time the servlets take to process, then you may see unexpected results. When set to ON and if the servers do not respond within HungServerRecoverSecs, the plug-ins fail over. If set to "OFF" the plug-ins do not fail over. If you are using the Netscape Enterprise Server Plug-In, or Apache HTTP Server you can set this parameter differently for different URLs or MIME types. If you change the name of the WebLogic Server session cookie in the WebLogic Server Web Application, you need to change the CookieName parameter in the plug-in to the same value. The name of the WebLogic session cookie is set in the WebLogic-specific deployment descriptor, in the <session-descriptor> element. If the URI is "/" then the plug-in performs the following steps: 1. Trims the path specified with the PathTrim parameter. 3. Prepends the value specified with PathPrepend. This procedure prevents redirects from WebLogic Server. Set the DefaultFileName to the default welcome page of the Web Application in WebLogic Server to which requests are being proxied. For example, If the DefaultFileName is set to welcome.html, an HTTP request like "http://somehost/weblogic" becomes "http://somehost/weblogic/welcome.html". For this parameter to function, the same file must be specified as a welcome file in all the Web Applications to which requests are directed. For more information, see "Configuring Welcome Pages". Note for Apache users: If you are using Stronghold or Raven versions, define this parameter inside of a Location block, and not in an IfModule block. Maximum allowable size of POST data, in bytes. If the content-length exceeds MaxPostSize, the plug-in returns an error message. If set to -1, the size of POST data is not checked. This is useful for preventing denial-of-service attacks that attempt to overload the server with POST data. When proxying by MIME type, set the filename pattern inside of an IfModule block using the MatchExpression parameter. Example when proxying by MIME type: <IfModule mod_weblogic.c> Example when proxying by path: <IfModule mod_weblogic.c> When set to ON, and the size of the POST data in a request is greater than 2048 bytes, the POST data is stored on disk in a temporary file and forwarded to WebLogic Server in chunks of 8192 bytes. Setting FileCaching to ON, however, can cause a problem with the progress bar displayed by a browser that indicates the progress of a download. The browser shows that the download has completed even though the file is still being transferred. When set to OFF and size of the POST data in a request is greater than 2048 bytes, the POST data is stored in memory and sent to WebLogic Server in chunks of 8192 bytes. Setting to OFF causes problems if the server goes down while processing the request because the plug-in is not able to fail over. The values for this parameter are 0 (low), 1 (medium), and 2 (high). The default value is 2. This priority should be put in iisforward.ini file. If you do not use virtual host, but choose to set this property, you must use iisforward.ini file. This parameter allows you make exclude certain requests from proxying. If WlForwardPath is set to "/" all requests are proxied. To forward any requests starting with a particular string, set WlForwardPath to the string. For example, setting WlForwardPath to /weblogic forwards all requests starting with /weblogic to Weblogic Server. This parameter is required if you are proxying by path. You can set multiple strings by separating the strings with commas. For example: WlForwardPath=/weblogic,/bea. The length of time after which an inactive connection between the plug-in and WebLogic Server is closed. You must set KeepAliveEnabled to true for this parameter to be effective. The value of this parameter must be less than or equal to the value of the Duration field set in the Administration Console on the Server/HTTP tab, or the value set on the server Mbean with the KeepAliveSecs attribute. Enables pooling of connections between the plug-in and WebLogic Server. When set to ON, specifies that the Apache plug-in use When set to OFF, the Apache plug-in uses Valid only if DynamicServerList is set to OFF. If a WebLogic Server listed in either the WebLogicCluster parameter or a dynamic cluster list returned from WebLogic Server fails, the failed server is marked as "bad" and the plug-in attempts to connect to the next server in the list. MaxSkips sets the number of attempts after which the plug-in will retry the server marked as "bad." The plug-in attempts to connect to a new server in the list each time a unique request is received (that is, a request without a cookie). When set to OFF, the plug-in ignores the dynamic cluster list used for load balancing requests proxied from the plug-in and only uses the static list specified with the WebLogicCluster parameter. Normally this parameter should remain set to ON. There are some implications for setting this parameter to OFF: Set this parameter to ON to maintain SSL communication between the plug-in and WebLogic Server when the following conditions exist: The request is passed through one or more proxy servers (including the WebLogic Server proxy plug-ins) When WLProxySSL is set to ON, the location header returned to the client from WebLogic Server specifies the HTTPS protocol. Defines the IP address to bind to when the plug-in connects to a WebLogic Server instance running on a multihomed machine. If WLLocalIP is not set, a random IP address on the multi-homed machine is used.
yourweblogic.com:7001,theirweblogic.com:7001
MatchExpression *.jsp WebLogicHost=myHost|paramName=value
</IfModule>
MatchExpression /weblogic WebLogicHost=myHost|paramName=value
</IfModule>
(request_rec *)r->the request
to pass the query string to WebLogic Server. (For more information, see your Apache documentation.) This behavior is desirable in the following situations:
(request_rec *)r->args to pass the query string to WebLogic Server.
SSL Parameters for Web Server Plug-Ins
Note: Parameters are case sensitive. Set this parameter to ON to enable the use of the SSL protocol for all communication between the plug-in and WebLogic Server. Remember to configure a port on the corresponding WebLogic Server for the SSL protocol before defining this parameter. This parameter may be set at two levels: in the configuration for the main server and—if you have defined any virtual hosts—in the configuration for the virtual host. The configuration for the virtual host inherits the SSL configuration from the configuration of the main server if the setting is not overridden in the configuration for the virtual host. Name of the file that contains the digital certificates for the trusted certificate authorities for the plug-in. This parameter is required if the SecureProxy parameter is set to ON. The filename must include the full directory path of the file. Determines whether the host name to which the plug-in is connecting must match the Subject Distinguished Name field in the digital certificate of the WebLogic Server to which the proxy plug-in is connecting. The ASN.1 Object ID (OID) that identifies which field in the Subject Distinguished Name of the peer digital certificate is to be used to perform the host match comparison. The default for this parameter corresponds to the CommonName field of the Subject Distinguished Name. Common OID values are: