The following sections describe how to install and configure the Apache HTTP Server Plug-In:
Overview of the Apache HTTP Server Plug-In
The Apache HTTP Server Plug-In allows requests to be proxied from an Apache HTTP Server to WebLogic Server. The plug-in enhances an Apache installation by allowing WebLogic Server to handle requests that require the dynamic functionality of WebLogic Server.
The plug-in is intended for use in an environment where an Apache Server serves static pages, and another part of the document tree (dynamic pages best generated by HTTP Servlets or JavaServer Pages) is delegated to WebLogic Server, which may be operating in a different process, possibly on a different host. To the end user—the browser—the HTTP requests delegated to WebLogic Server still appear to be coming from the same source.
- Historical releases, including the 1.3, 2.0 and 2.2 families of releases. A FastCGI implementation for Apache HTTP Server versions 2.2 and 2.4. This version of.
- Apache httpd 2.2 End-of-Life 2018-01-01 ¶ As previously announced, the Apache HTTP Server Project has discontinued all development and patch review of the 2.2.x series of releases. The Apache HTTP Server Project had long committed to provide maintenance releases.
- The primary Windows platform for running Apache 2.0 is Windows NT. The binary installer only works with the x86 family of processors, such as Intel and AMD processors. Running Apache on Windows 9x is not thoroughly tested, and it is never recommended on production systems. On all operating systems, TCP/IP networking must be installed and working.
- Additional notes. Note that the versions of Apache HTTP Server included in the above products are in most cases vastly different from the upstream community releases of the same version. This is explained by Red Hat's Security Backporting Policy and is the most common cause of admins/auditors trying to get a newer version of Apache; For example: EWS 2.1.0 & EAP 6.4.0 include Apache httpd.
Apache HTTP Server 2.4.46 (httpd): 2.4.46 is the latest available version 2020-08-07 ¶ Source: httpd-2.4.46.tar.bz2 PGP SHA256 Source: httpd-2.4.46.tar.gz PGP SHA256 Binaries Security and official patches Other files Files for Microsoft Windows.
HTTP-tunneling, a technique which allows HTTP requests and responses access through a company’s firewall, can also operate through the plug-in, providing non-browser clients access to WebLogic Server services.
The Apache HTTP Server Plug-In operates as an Apache module within an Apache HTTP Server. An Apache module is loaded by Apache Server at startup, and then certain HTTP requests are delegated to it. Apache modules are similar to HTTP servlets, except that an Apache module is written in code native to the platform.
For information on configurations on which the Apache HTTP Server Plug-In is supported, see http://download.oracle.com/docs/cd/E13196_01/platform/suppconfigs/configs100/100_over/add-ons.html.
|Note:||Apache 2.0 Plug-In has been deprecated in WebLogic Server 10.0 release.|
Keep-Alive Connections in Apache Version 2.0
Version 2.0 of the Apache HTTP Server Plug-In improves performance by using a reusable pool of connections from the plug-in to WebLogic Server. The plug-in implements HTTP 1.1 keep-alive connections between the plug-in and WebLogic Server by reusing the same connection in the pool for subsequent requests from the same client. If the connection is inactive for more than 30 seconds, (or a user-defined amount of time) the connection is closed and returned to the pool. You can disable this feature if desired. For more information, see KeepAliveEnabled.
The plug-in proxies requests to WebLogic Server based on a configuration that you specify. You can proxy requests based on the URL of the request (or a portion of the URL). This is called proxying by path. You can also proxy requests based on the MIME type of the requested file. Or you can use a combination of the two methods. If a request matches both criteria, the request is proxied by path. You can also specify additional parameters for each type of request that define additional behavior of the plug-in. For more information, see Configuring the Apache HTTP Server Plug-In.
Although this document refers to Apache 2.0, you can apply the same instructions to use Apache 2.2 with the libraries shown in Table 3-2.
The Apache HTTP Server Plug-In is supported on Linux, Solaris, Windows, and HPUX11 platforms. For information on support for specific versions of Apache, see http://download.oracle.com/docs/cd/E13196_01/platform/suppconfigs/configs100/100_over/add-ons.html.
Installing the Apache HTTP Server Plug-In
You can install the Apache HTTP Server Plug-In as an Apache module in your Apache HTTP Server installation and link it as a Dynamic Shared Object (DSO).
A DSO is compiled as a library that is dynamically loaded by the server at run time, and can be installed without recompiling Apache.
Installing the Apache HTTP Server Plug-In as a Dynamic Shared Object
The Apache plug-in is distributed as a shared object (
.so) for Solaris, Linux, Windows, and HPUX11 platforms. BEA WebLogic supplies versions of shared object files that vary according to platform, whether or not SSL is to be used between the client and Apache, and the SSL encryption strength (regular or 128 bit—128 bit versions are only installed if you install the 128 bit version of WebLogic Server).
Table 3-1 shows the directories of your WebLogic Server installation that contain shared object files for various platforms (where WL_HOME is the top-level installation directory for the WebLogic platform).
Table 3-2 identifies the WebLogic Server Apache Plug-In modules for different versions of Apache HTTP Server and different encryption strengths.
Shared Object Location
1See Support for Large Files in Apache 2.0.
Choose the appropriate version of the plug-in shared object from the following table:
Regular Strength Encryption
Standard Apache Version 2.0.x
To install the Apache HTTP Server Plug-In as a dynamic shared object:
- Locate the shared object directory for your platform using Table 3-1.
- Identify the plug-in shared object file for your version of Apache in Table 3-2.
- Verify that the WebLogic Server Apache HTTP Server Plug-In
mod_so.cmodule is enabled.
- Install the Apache HTTP Server Plug-In module for Apache 2.0.x by copying the
mod_wl_20.sofile to the
modulesdirectory and adding the following line to your
APACHE_HOME/conf/httpd.conf file manually:
- Define any additional parameters for the Apache HTTP Server Plug-In.
- In a
Locationblock, for parameters that apply to proxying by path, or
- In an
IfModuleblock, for parameters that apply to proxying by MIME type.
- Verify the syntax of the
APACHE_HOMEconfhttpd.conf file with the following command:
- Restart Weblogic Server.
- Start (or restart if you have changed the configuration) Apache HTTP Server.
- Test the plug-in by opening a browser and setting the URL to the Apache Server + “
/weblogic/”, which should bring up the default WebLogic Server HTML page, welcome file, or default servlet, as defined for the default Web Application on WebLogic Server. For example:
The Apache HTTP Server Plug-In will be installed in your Apache HTTP Server installation as a Dynamic Shared Object (DSO). DSO support in Apache is based on a module
mod_so.c, which must be enabled before mod_wl_20.so is loaded. If you installed Apache HTTP Server using the script supplied by Apache,
mod_so.c is already enabled. Verify that
mod_so.c is enabled by executing the following command:
APACHE_HOME is the directory containing your Apache HTTP Server installation.)
This command lists all enabled modules. If
mod_so.c is not listed, you must rebuild your Apache HTTP Server, making sure that the following options are configured:
The Apache HTTP Server Plug-In recognizes the parameters listed in General Parameters for Web Server Plug-Ins. To modify the behavior of your Apache HTTP Server Plug-In, define these parameters:
The output of this command reports any errors in your
httpd.conf file or returns:
Support for Large Files in Apache 2.0
The version of Apache 2.0 that ships with some operating systems, including some versions of Solaris and Linux, is compiled with the following flags:
These compilation flags enable support for files larger than 2 GB. If you want to use a WebLogic Server Web server plug-in on such an Apache 2.0 Web server, you must use plug-ins compiled with the same compilation flags, which are available in the
largefile subdirectory for your operating system. For example:
|Note:||Apache 2.2 does not require special compilation flags to support files larger than 2 GB. Therefore, you do not need to use a specially compiled Web server plug-in if you are running Apache 2.2.|
Configuring the Apache HTTP Server Plug-In
After installing the plug-in in the Apache HTTP Server, configure the WebLogic Server Apache Plug-In and configure the server to use the plug-in. This section explains how to edit the Apache
httpd.conf file to instruct the Apache server to load the WebLogic Server library for the plug-in as an Apache module, and to specify the application requests that should be handled by the module.
Editing the httpd.conf File
httpd.conf file in your Apache HTTP server installation to configure the Apache HTTP Server Plug-In.
This section explains how to locate and edit the
httpd.conf file, to configure the server to use the WebLogic Server Apache Plug-In, to proxy requests by path or by MIME type, to enable HTTP tunneling, and to use other WebLogic Server plug-in parameters.
- Open the
- Ensure that the WebLogic Server modules are included for Apache 2.0.x, manually add the following line to the
- Add an
IfModuleblock that defines one of the following:
- To proxy requests by MIME type, add a
MatchExpressionline to the
IfModuleblock. Note that if both MIME type and proxying by path are enabled, proxying by path takes precedence over proxying by MIME type.
- To proxy requests by path, use the
Locationblock and the
SetHandlerspecifies the handler for the Apache HTTP Server Plug-In module. For example the following Location block proxies all requests containing
/weblogicin the URL:
- Optionally, enable HTTP tunneling for t3 or IIOP.
- To enable HTTP tunneling if you are using the t3 protocol and
weblogic.jar, add the following Location block to the
- To enable HTTP tunneling if you are using the IIOP, the only protocol used by the WebLogic Server thin client,
wlclient.jar, add the following Location block to the
- Define any additional parameters for the Apache HTTP Server Plug-In.
- In a
Locationblock, for parameters that apply to proxying by path, or
- In an
IfModuleblock, for parameters that apply to proxying by MIME type.
The file is located at APACHE_
confhttpd.conf (where APACHE_
HOMEis the root directory of your Apache HTTP server installation). See a sample
httpd.conf file at Setting Up Perimeter Authentication.
For a non-clustered WebLogic Server:
The WebLogicHost and WebLogicPort parameters.
For a cluster of WebLogic Servers:
The WebLogicCluster parameter.
For example, the following
IfModule block for a non-clustered WebLogic Server specifies that all files with MIME type
.jsp are proxied:
You can also use multiple
MatchExpressions, for example:
If you are proxying requests by MIME type to a cluster of WebLogic Servers, use the
WebLogicCluster parameter instead of the
WebLogicPort parameters. For example:
The PathTrim parameter specifies a string trimmed from the beginning of the URL before the request is passed to the WebLogic Server instance (see General Parameters for Web Server Plug-Ins).
The Apache HTTP Server Plug-In recognizes the parameters listed in General Parameters for Web Server Plug-Ins . To modify the behavior of your Apache HTTP Server Plug-In, define these parameters either:
Including a weblogic.conf File in the httpd.conf File
If you want to keep several separate configuration files, you can define parameters in a separate configuration file called
weblogic.conf file, by using the Apache Include directive in an
IfModule block in the
The syntax of
weblogic.conf files is the same as that for the
This section describes how to create
weblogic.conf files, and includes sample
Creating weblogic.conf Files
Be aware of the following when constructing a
- If you are using SSL between the Apache HTTP Server Plug-In and WebLogic Server, you cannot define parameters in a file accessed, as the
weblogic.conffile is, via the Apache
- Enter each parameter on a new line. Do not put ‘=’ between a parameter and its value. For example:
- If a request matches both a MIME type specified in a
IfModuleblock and a path specified in a
Locationblock, the behavior specified by the
Locationblock takes precedence.
- If you define the
CookieNameparameter , you must define it in an
- If you use an Apache HTTP Server
<VirtualHost>block, you must include all configuration parameters (
MatchExpression, for example) for the virtual host within the
<VirtualHost>block (see Apache Virtual Host documentation).
- If you want to have only one log file for all the virtual hosts configured in your environment, you can achieve it using global properties. Instead of specifying the same Debug, WLLogFile and WLTempDir properties in each virtual host you can specify them just once in the <IfModule> tag
- Sample httpd.conf file:
- All the requests which match /jurl/* will have Debug Level set to ALL and log messages will be logged to c:/tmp/global_proxy.log file. All the requests which match /web/* will have Debug Level set to OFF and no log messages will be logged. All the requests which match /foo/* will have Debug Level set to ERR and log messages will be logged to c:/tmp/foo_proxy.log file
- BEA recommends that you use the
MatchExpressionstatement instead of the
Sample weblogic.conf Configuration Files
The following examples of
weblogic.conf files may be used as templates that you can modify to suit your environment and server. Lines beginning with # are comments.
Example Using WebLogic Clusters
Example Using Multiple WebLogic Clusters
In this example, the
MatchExpression parameter syntax for expressing the filename pattern, the WebLogic Server host to which HTTP requests should be forwarded, and various other parameters is as follows:
MatchExpression parameter below specifies the filename pattern
*.jsp, and then names the single
paramName=value combinations following the pipe symbol specify the port at which WebLogic Server is listening for connection requests, and also activate the Debug option. The second
MatchExpression specifies the filename pattern
*.http and identifies the
WebLogicCluster hosts and their ports. The
paramName=value combination following the pipe symbol specifies the error page for the cluster.
Example Without WebLogic Clusters
Example Configuring Multiple Name-Based Virtual Hosts
You must define a unique value for 'ServerName'or some Plug-In parameters will not work as expected.
Template for the Apache HTTP Server httpd.conf File
This section contains a sample
httpd.conf file for Apache 2.0. You can use this sample as a template and modify it to suit your environment and server. Lines beginning with # are comments.
Note that Apache HTTP Server is not case sensitive.
Setting Up Perimeter Authentication
Apache Http Server 2.0.63 Download
Use perimeter authentication to secure WebLogic Server applications that are accessed via the Apache Plug-In.
A WebLogic Identity Assertion Provider authenticates tokens from outside systems that access your WebLogic Server application, including users who access your WebLogic Server application through the Apache HTTP Server Plug-In. Create an Identity Assertion Provider that will safely secure your Plug-In as follows:
- Create a custom Identity Assertion Provider on your WebLogic Server application. See How to Develop a Custom Identity Assertion Provider in Developing Security Providers for WebLogic Server.
- Configure the custom Identity Assertion Provider to support the Cert token type and make Cert the active token type. See How to Create New Token Types in Developing Security Providers for WebLogic Server.
clientCertProxyto True in the
web.xmldeployment descriptor file for the Web application (or, if using a cluster, optionally set the
Client Cert Proxy Enabledattribute to true for the whole cluster on the Administration Console Cluster-->Configuration-->General tab). The
clientCertProxyattribute can be used with a third party proxy server, such as a load balancer or an SSL accelerator, to enable 2-way SSL authentication. For more information about the
clientCertProxyattribute, see context-param in Developing Web Applications, Servlets and JSPs for WebLogic Server.
- Once you have set
clientCertProxy, be sure to use a connection filter to ensure that WebLogic Server accepts connections only from the machine on which the Apache Plug-In is running. See Using Network Connection Filters in Programming WebLogic Security.
- Web server plug-ins require a trusted Certificate Authority file in order to use SSL between the plug-in and WebLogic Server. Use Sun Microsystems' keytool utility to export a trusted Certificate Authority file from the DemoTrust.jks keystore file that resides in BEA_HOME/wlserver_10.0/server/lib.
- To extract the wlsdemoca file, for example, use the command:
keytool -export -file trustedcafile.der -keystore DemoTrust.jks -alias wlsdemoca
- To convert the Certificate Authority file to pem format: java utils.der2pem trustedcafile.der
Change the alias name to obtain a different trusted CA file from the keystore.
To look at all of the keystore's trusted CA files, use:
keytool -list -keystore DemoTrust.jks
Press enter if prompted for password.
See Identity Assertion Providers in Developing Security Providers for WebLogic Server.
Using SSL with the Apache Plug-In
You can use the Secure Sockets Layer (SSL) protocol to protect the connection between the Apache HTTP Server Plug-In and WebLogic Server. The SSL protocol provides confidentiality and integrity to the data passed between the Apache HTTP Server Plug-In and WebLogic Server.
The Apache HTTP Server Plug-In does not use the transport protocol (
https) specified in the HTTP request (usually by the browser) to determine whether or not the SSL protocol is used to protect the connection between the Apache HTTP Server Plug-In and WebLogic Server.
Although two-way SSL can be used between the HTTP client and Apache HTTP server, note that one-way SSL is used between Apache HTTP Server and WebLogic Server.
Configuring SSL Between the Apache HTTP Server Plug-In and WebLogic Server
To use the SSL protocol between Apache HTTP Server Plug-In and WebLogic Server:
Apache Http Server 2.0 End Of Support
- Configure WebLogic Server for SSL. For more information, see Configuring SSL.
- Configure the WebLogic Server SSL listen port. For more information, see Configuring SSL.
- In the Apache Server, set the
WebLogicPortparameter in the
httpd.conffile to the WebLogic Server SSL listen port configured in Step 2.
- In the Apache Server, set the
SecureProxyparameter in the
- Set any additional parameters in the
httpd.conffile that define information about the SSL connection. For a complete list of the SSL parameters that you can configure for the plug-in, see SSL Parameters for Web Server Plug-Ins .
Issues with SSL-Apache Configuration
These known issues arise when you configure the Apache plug-in to use SSL:
- To prepare the plugin configuration, double click the lock and go to the certificates path:
- The PathTrim parameter (see General Parameters for Web Server Plug-Ins) must be configured inside the
Includedirective does not work with Apache SSL. You must configure all parameters directly in the
httpd.conffile. Do not use the following configuration when using SSL:
- The current implementation of the WebLogic Server Apache Plug-In does not support the use of multiple certificate files with Apache SSL.
* Select the root CA (at the top)
* Display it
* Detail and then copy this certificate to a file using the Coded 'Base
64 X509' option
* Save the file, for example, to
ýMyWeblogicCAToTrust.cerý (which is also a
The following configuration is incorrect:
The following configuration is the correct setup:
Connection Errors and Clustering Failover
When the Apache HTTP Server Plug-In attempts to connect to WebLogic Server, the plug-in uses several configuration parameters to determine how long to wait for connections to the WebLogic Server host and, after a connection is established, how long the plug-in waits for a response. If the plug-in cannot connect or does not receive a response, the plug-in attempts to connect and send the request to other WebLogic Server instances in the cluster. If the connection fails or there is no response from any WebLogic Server in the cluster, an error message is sent.
Figure 3-1 demonstrates how the plug-in handles failover.
Possible Causes of Connection Failures
Failure of the WebLogic Server host to respond to a connection request could indicate the following problems:
- Physical problems with the host machine
- Network problems
- Other server failures
Failure of all WebLogic Server instances to respond could indicate the following problems:
- WebLogic Server is not running or is unavailable
- A hung server
- A database problem
- An application-specific failure
Tuning to Reduce Connection_Refused Errors
Under load, an Apache plug-in may receive CONNECTION_REFUSED errors from a back-end WebLogic Server instance. Follow these tuning tips to reduce CONNECTION_REFUSED errors:
- Increase the
AcceptBackLogsetting in the configuration of your WebLogic Server domain.
- On Apache 2.0.x, set the
KeepAlivedirective in the
httpd.conffile to On. For example:
- Decrease the time wait interval. This setting varies according to the operating system you are using. For example:
- On Windows NT, set the
TcpTimedWaitDelayon the proxy and WebLogic Server servers to a lower value. Set the TIME_WAIT interval in Windows NT by editing the registry key under
- On Windows 2000, lower the value of the
TcpTimedWaitDelayby editing the registry key under
- On Solaris, reduce the setting
tcp_time_wait_intervalto one second (for both the WebLogic Server machine and the Apache machine, if possible):
- Increase the open file descriptor limit on your machine. This limit varies by operating system. Using the
.sh) directives, you can make a script to increase the limit. For example:
- On Solaris, increase the values of the following tunables on the WebLogic Server machine:
See Apache HTTP Server 2.0 documentation at http://httpd.apache.org/docs-project/.
If this key does not exist you can create it as a DWORD value. The numeric value is the number of seconds to wait and may be set to any value between 30 and 240. If not set, Windows NT defaults to 240 seconds for
Failover with a Single, Non-Clustered WebLogic Server
If you are running only a single WebLogic Server instance the plug-in only attempts to connect to the server defined with the WebLogicHost parameter. If the attempt fails, an
HTTP 503 error message is returned. The plug-in continues trying to connect to that same WebLogic Server instance until ConnectTimeoutSecs is exceeded.
The Dynamic Server List
When you use the
WebLogicCluster parameter in your
weblogic.conf file to specify a list of WebLogic Servers, the plug-in uses that list as a starting point for load balancing among the members of the cluster. After the first request is routed to one of these servers, a dynamic server list is returned containing an updated list of servers in the cluster. The updated list adds any new servers in the cluster and deletes any that are no longer part of the cluster or that have failed to respond to requests. This list is updated automatically with the HTTP response when a change in the cluster occurs.
Failover, Cookies, and HTTP Sessions
When a request contains session information stored in a cookie or in the POST data, or encoded in a URL, the session ID contains a reference to the specific server instance in which the session was originally established (called the primary server) and a reference to an additional server where the original session is replicated (called the secondary server). A request containing a cookie attempts to connect to the primary server. If that attempt fails, the request is routed to the secondary server. If both the primary and secondary servers fail, the session is lost and the plug-in attempts to make a fresh connection to another server in the dynamic cluster list. See Figure 3-1 Connection Failover.
|Note:||If the POST data is larger than 64K, the plug-in will not parse the POST data to obtain the session ID. Therefore, if you store the session ID in the POST data, the plug-in cannot route the request to the correct primary or secondary server, resulting in possible loss of session data.|
In the preceding figure, the Maximum number of retries allowed in the red loop is equal to
ConnectTimeoutSecs ÷ ConnectRetrySecs.
Apache Http Server Download
Apache Http Server Version 2.0 Download
|© BEA Systems|