Tag: Proxy

Custom error pages in Apache for JBoss AS7

In this article we would show a simple demonstration of using our own custom error pages which would be severed from Apache side with the static contents like image/HTML/etc files, however here we would using images and HTML pages as a repository. Custom error pages are been required by everyone in there production environments, becasue one would not like there clients to see the default error pages when some issue comes from the server side or by mistake your clients tries to access a non-existing page in your application, hence with this article you can show your own custom error pages using Apache for JBoss AS 7

We would be using the standalone mode for this article and in JBoss AS 7.1.0.CR1b version we have a different xml file called standalone-full.xml which would be used with Apache mod_jk.

Now there are few things which has to be noted here to achieve this configuration

  1. Add system-properties to give the jvmRoute
  2. Enable AJP protocol and add AJP port

Custom error pages in Apache for JBoss AS7

For this we would have to modify from both side Apache as well as JBoss AS7 side, hence lets see the configuration one at a time

Apache side configuration

Lets see what all configuration has to be made from Apache side

  1. You can configure mod_jk from the below article
  2. Configuring mod_jk to connect to JBoss
    In the following section of the above link: “Apache WebServer Configuration Part”

  3. In the above article you just have to replace the Step-8 by the following content
  4. ##### JBOSS #############
    LoadModule jk_module modules/mod_jk.so
     
    # Include mod_jk's specific configuration file
    Include conf/mod_jk.conf
    
    Listen 10.10.10.10:80
    
    # (1) Setting up the Alias for the "error" directory
    Alias /error/ "/etc/httpd/www/error/"
    
    # (2) Mapping the error codes with custom error pages
    ErrorDocument 404 /error/404_ErrorPage.html
    ErrorDocument 503 /error/MaintenancePage.html
    
    <VirtualHost 10.10.10.10:80>
    
      # (3) All the application context would go to "nodeA"
      JkMount /* nodeA
       
      # (4) Setting error code 404 for "MyApp" application
      JkMount /MyApp/* nodeA;use_server_errors=404
    
      # Static files in the examples webapp are served by Apache
      Alias /images /etc/httpd/www/html/MyApp/images
     
      # All requests go to nodeA
      JkMount /* nodeA
     
      # Serve html, jpg, png etc using httpd
      JkUnMount /*.html  nodeA
      JkUnMount /*.png  nodeA
      JkUnMount /*.jpg  nodeA
      JkUnMount /*.gif  nodeA
    
    </VirtualHost>
    ###########################
    

    Where: 10.10.10.10:80 is the “IP_ADDRESS:PORT” of your Apache box

  5. And in the Step-10 of above article replace it by the following content
  6. ##### JBOSS #############
    # Define list of workers that will be used for mapping requests
    worker.list=nodeA,status
    
    # Status worker for managing load balancer
    worker.status.type=status
    
    # Define nodeA modify the host as your host IP or DNS name.
    worker.nodeA.port=8009
    worker.nodeA.host=20.20.20.20
    worker.nodeA.type=ajp13
    worker.nodeA.ping_mode=A
    ###########################
    

    Where: 20.20.20.20 is the “binding address” of your JBoss AS7 on which it is running and “8009” is the AJP port

So with the above configuration you can see that

  1. In the path “/etc/httpd/www/error/” would have all custom error pages with an alias “error”
  2. Mapping the custom error pages with the respective error codes
  3. All the application would be severed by “nodeA”
  4. If someone tires to access some page which is not present in the application would get our 404 custom error page.

Following are the custom error pages which we have created. Hope you like them.

MaintenancePage.html

<html>
  <head>
     <title>Middleware Magic - 503 Custom Error Page</title>
  </head>
  <body>
	<center><font color=maroon>
		<h1>Custom Maintenance Page</h1>
		<h2>Oops...You caught us down !!!.<br><br>
		<img src="/images/down.jpg"/><br><br>
		Please try after sometime...</h2><br>
		<img src="/images/MiddlewareMagic.png" width="150" height="150" />
		<h1>Middleware Magic</h1>
	        </font>
	</center>
   </body>
</html>

404_ErrorPage.html

<html>
  <head>
     <title>Middleware Magic - 404 Custom Error Page</title>
  </head>
  <body>
	<center><font color=maroon>
		<h1>404 Error - Page Not Found</h1>
		<h2>Look's like your yesterday's HANGOVER has not gone...<br><br>
		<img src="/images/hangover.jpg" width="200" height="200"/><br><br>
		Try accessing the correct page !!!</h2><br>
		<img src="/images/MiddlewareMagic.png" width="150" height="150"/>
		<h1>Middleware Magic</h1>
		</font>
	</center>
  </body>
</html>

JBoss AS7 side configuration

Lets see what all configuration has to be made from JBoss AS7 side

  1. As described earlier we would have to add the system-properties to give the jvmRoute which can be done by adding the “system-propertie” tag just after the extensions gets over, as shown below
  2. <extensions>
    .
    .
    </extensions>
    
    <!-- Below system properties tag has been added -->
    <system-properties>
    	<property name="jvmRoute" value="nodeA"/>
    </system-properties>
    
  3. By default in JBoss AS7 AJP protocol and port are not their, hence we would have to enable and add them as shown below
  4. Enabling AJP protocol

    <subsystem xmlns="urn:jboss:domain:web:1.1" default-virtual-server="default-host">
    	<connector name="http" protocol="HTTP/1.1" scheme="http" socket-binding="http"/>
     <!-- We have to enable the AJP protocol by adding below line -->
    	<connector name="ajp" protocol="AJP/1.3" socket-binding="ajp" enabled="true"/>  
    

    Adding AJP port

    <socket-binding-group name="standard-sockets" default-interface="public" port-offset="${jboss.socket.binding.port-offset:0}">
    	<socket-binding name="http" port="8080"/>
    <!-- We have to add the AJP port by adding below line -->
    	<socket-binding name="ajp" port="8009"/>  
    

The configuration has been done from both the ends, now comes the application which would be used to test the above configuration which have done.

Steps to create a test application

  1. Create a folder called MyApp
  2. In “MyApp” folder create index.jsp file and WEB-INF folder which has web.xml inside it and copy the below code in “web.xml”
  3. <web-app>
       <welcome-file-list>
           <welcome-file>index.jsp</welcome-file>
       </welcome-file-list>
    </web-app>
    
  4. In “index.jsp” file copy the below code in it
  5. <html>
    	<head>
    		<title>Middleware Magic - MyApp Static Page Test</title>
    	</head>
    	<body>
    		<center><h3><font color=maroon>This page coming from JBoss AS7....</font></h3>
    		<h1><font color=maroon>but image is coming from Apache!!! </font></h1>
    		<img src="/images/MiddlewareMagic.png"/>
    		<h1><font color=maroon>Middleware Magic </font></h1></center>
    	</body>
    </html>
    

    NOTE: You would have to give the image name with the extension which is present in the path “/etc/httpd/www/html/MyApp/images” from Apache side.

  6. Once you have done with all this you now just have to create an WAR file out of this, for that you need to be in the MyApp folder and run the below command (make sure you have setted the java/bin in your PATH). Note: you would have to give the (.) dot at last as well
  7. MyApp] jar -cvf MyApp.war .
    

Testing

Now just start your Apache and JBoss AS7 by keeping the “MyApp.war” in “/standalone/deployments” folder and hit the Apache URL with the context root of the application.

http://10.10.10.10:80/MyApp

You will notice that the JSP file is been picked up from JBoss AS7 but the image is been picked up from Apache which is getting displaced on the page, this means that the static content is been served from Apache.

Good our application is working fine, now lets try if your custom error pages work. Hence try hitting the below URL to check the custom 404 error page

http://10.10.10.10:80/MyApp/a.jsp

That’s working, let try the custom maintenance page, for that we would have to shut-down the JBoss AS7 server which would give us 503 error which means that the backend server is down, which we do sometime if we need to do a maintenance on the JBoss sever side. Thus bring down your running JBoss AS 7 server and hit the below link

http://10.10.10.10:80/MyApp


Apache as static content repository for JBoss AS7

In this article we would show a simple demonstration of using Apache as a repository for caching static contents like image/HTML/etc files, however here we would use image as a repository.This helps us in improving the performance of the backend servers as all the static contents would be served by Apache itself and all the dynamic contents can be served backend server JBoss AS7.

We would be using the standalone mode for this article and in JBoss AS 7.1.0.CR1b version we have a different xml file called standalone-full.xml which would be used with Apache mod_jk.

Now there are few things which has to be noted here to achieve this configuration

  1. Add system-properties to give the jvmRoute
  2. Enable AJP protocol and add AJP port

Configuring Apache as a static content repository

For this we would have to modify from both side Apache as well as JBoss AS7 side, hence lets see the configuration one at a time

Apache side configuration

Lets see what all configuration has to be made from Apache side

  1. You can configure mod_jk from the below article
  2. Configuring mod_jk to connect to JBoss
    In the following section of the above link: “Apache WebServer Configuration Part”

  3. In the above article you just have to replace the Step-8 by the following content
  4. ##### JBOSS #############
    LoadModule jk_module modules/mod_jk.so
     
    # Include mod_jk's specific configuration file
    Include conf/mod_jk.conf
    
    Listen	10.10.10.10:80
    NameVirtualHost	10.10.10.10:80
    
    <VirtualHost 10.10.10.10:80>
    
      # Static files in the examples webapp are served by Apache
      Alias /images /etc/httpd/www/html/MyApp/images
    
      # All requests go to nodeA
      JkMount /* nodeA
    
      # Serve html, jpg, png etc using httpd
      JkUnMount /*.png  nodeA
      JkUnMount /*.html  nodeA
      JkUnMount /*.jpg  nodeA
      JkUnMount /*.gif  nodeA
    
    </VirtualHost>
    ###########################
    

    Where: 10.10.10.10:80 is the “IP_ADDRESS:PORT” of your Apache box

  5. And in the Step-10 of above article replace it by the following content
  6. ##### JBOSS #############
    # Define list of workers that will be used for mapping requests
    worker.list=nodeA,status
    
    # Status worker for managing load balancer
    worker.status.type=status
    
    # Define nodeA modify the host as your host IP or DNS name.
    worker.nodeA.port=8009
    worker.nodeA.host=20.20.20.20
    worker.nodeA.type=ajp13
    worker.nodeA.ping_mode=A
    ###########################
    

    Where: 20.20.20.20 is the “binding address” of your JBoss AS7 on which it is running and “8009” is the AJP port

So here you can see that in the path “/etc/httpd/www/html/MyApp/images” would have all the images for an application called “MyApp” and the paths alias is been giving as “/images” which would used in application.

JBoss AS7 side configuration

Lets see what all configuration has to be made from JBoss AS7 side

  1. As described earlier we would have to add the system-properties to give the jvmRoute which can be done by adding the “system-propertie” tag just after the extensions gets over, as shown below
  2. <extensions>
    .
    .
    </extensions>
    
    <!-- Below system properties tag has been added -->
    <system-properties>
    	<property name="jvmRoute" value="nodeA"/>
    </system-properties>
    
  3. By default in JBoss AS7 AJP protocol and port are not their, hence we would have to enable and add them as shown below
  4. Enabling AJP protocol

    <subsystem xmlns="urn:jboss:domain:web:1.1" default-virtual-server="default-host">
    	<connector name="http" protocol="HTTP/1.1" scheme="http" socket-binding="http"/>
     <!-- We have to enable the AJP protocol by adding below line -->
    	<connector name="ajp" protocol="AJP/1.3" socket-binding="ajp" enabled="true"/>  
    

    Adding AJP port

    <socket-binding-group name="standard-sockets" default-interface="public" port-offset="${jboss.socket.binding.port-offset:0}">
    	<socket-binding name="http" port="8080"/>
    <!-- We have to add the AJP port by adding below line -->
    	<socket-binding name="ajp" port="8009"/>  
    

The configuration has been done from both the ends, now comes the application which would be used to test the above configuration which have done.

Steps to create a test application

  1. Create a folder called MyApp
  2. In “MyApp” folder create index.jsp file and WEB-INF folder which has web.xml inside it and copy the below code in “web.xml”
  3. <web-app>
       <welcome-file-list>
           <welcome-file>index.jsp</welcome-file>
       </welcome-file-list>
    </web-app>
    
  4. In “index.jsp” file copy the below code in it
  5. <html>
    	<head>
    		<title>Middleware Magic - MyApp Static Page Test</title>
    	</head>
    	<body>
    		<center><h3><font color=maroon>This page coming from JBoss AS7....</font></h3>
    		<h1><font color=maroon>but image is coming from Apache!!! </font></h1>
    		<img src="/images/MiddlewareMagic.png"/>
    		<h1><font color=maroon>Middleware Magic </font></h1></center>
    	</body>
    </html>
    

    NOTE: You would have to give the image name with the extension which is present in the path “/etc/httpd/www/html/MyApp/images” from Apache side.

  6. Once you have done with all this you now just have to create an WAR file out of this, for that you need to be in the MyApp folder and run the below command (make sure you have setted the java/bin in your PATH). Note: you would have to give the (.) dot at last as well
  7. MyApp] jar -cvf MyApp.war .
    

Testing

Now just start your Apache and JBoss AS7 by keeping the “MyApp.war” in “/standalone/deployments” folder and hit the Apache URL with the context root of the application.

http://10.10.10.10:80/MyApp

You will notice that the JSP file is been picked up from JBoss AS7 but the image is been picked up from Apache which is getting displaced on the page, this means that the static content is been served from Apache.


How to configure mod_cluster with JBoss ?


Like mod_jk, mod_cluster is also a httpd based load balancer which uses a communication channel to forward requests from the httpd to one of a set of application server nodes. So the question comes Why mod_cluster ? To answer this question we will let you know few advantages of mod_cluster over mod_jk and other httpd-based load balancers.

Hence in this article we would share you why should one use mod_cluster ? and how to configure mod_cluster with JBoss ? Hopping all our subscribers would take the advantage of this article and would help them to choose which is the best option for httpd based load balancer for there requirement.

Why should one use mod_cluster ?

  • Dynamic configuration:
  • Server side load balance:
  • AJP is optional:
  • Web application lifecycle control:

To know all the Advantages and Great features of mod_cluster refer to :

Steps to configure mod_cluster with JBoss

I have divided this configuration into two parts to, so that it would be much more easier to understand follow the steps. Here the following are the two parts

  1. Apache side configuration
  2. JBoss side configuration

Apache side configuration

  1. Download the required binaries for your OS from below link, example for RHEL x64 bit its [dynamic libraries linux2-x64]
  2. http://www.jboss.org/mod_cluster/downloads/1-1-0.html

  3. Copy following .so files to your “<Apache_Home>/modules” folder.
  4. mod_proxy.so
    mod_proxy_ajp.so
    mod_slotmem.so
    mod_manager.so
    mod_proxy_cluster.so
    mod_advertise.so

  5. Edit your httpd.conf (i.e. /conf/http.conf) and add following lines at the bottom of the file. However this virtualhost setting is a sample, you might have to make some changes as per your own environment.
  6. ############### mod_cluster Setting - STARTED ###############
    LoadModule slotmem_module modules/mod_slotmem.so
    LoadModule manager_module modules/mod_manager.so
    LoadModule proxy_cluster_module modules/mod_proxy_cluster.so
    LoadModule advertise_module modules/mod_advertise.so
    <VirtualHost *:80>
    	<Directory />
    		Order deny,allow
    		Allow from all
    	</Directory>
    	<Location /mod_cluster_manager>
    		SetHandler mod_cluster-manager
    		Order deny,allow
    		Allow from all
    	</Location>
    	KeepAliveTimeout 60
    	MaxKeepAliveRequests 0
    	ManagerBalancerName testcluster
    	AdvertiseFrequency 5
    </VirtualHost>
    ############### mod_cluster Setting - ENDED ###############
    

    NOTE:

    You have to COMMENT the follwoing module (i.e. mod_proxy_balancer.so) in “httpd.conf” file, or else you would get error while starting your Apache, this is been done because we are now using mod_proxy_cluster.so instead of mod_proxy_balancer.so

    #LoadModule proxy_balancer_module modules/mod_proxy_balancer.so
    
  7. Restart Apache.
  8. NOTE:

    You have to do the following things before starting the APACHE

    Command:

    setenforce 0
    

    The above command will disable SE Linux for your current running session. However if you want to disable it permanently then follow the below steps

    vi /etc/selinux/config
    
    #SELINUX=enforcing (comment this line and add the below line)
    SELINUX=disabled
    
    

    May be this would need to restart your system, this way you will be sure that the changes have taken place.

JBoss side configuration

  1. Copy “mod-cluster.sar” from “/home/testusr/AS6/mod_cluster” to “/server/cluster_node1/deploy”
  2. Edit “mod-cluster-jboss-beans.xml” from “<JBOSS_HOME>/server/cluster_node1/deploy/mod-cluster.sar/META-INF/mod-cluster-jboss-beans.xml” so that it has following.
  3. BELOW

    <bean name="HAModClusterConfig" class="org.jboss.modcluster.config.ha.HAModClusterConfig" mode="On Demand">
    
    <!-- START Comma separated list of address:port listing the httpd servers where mod_cluster is running. -->
        <property name="proxyList">${jboss.modcluster.proxyList:localhost:80}</property>
        <property name="domain">${jboss.Domain:DefaultDomain}</property>
    <!-- END Comma separated list of address:port listing the httpd servers where mod_cluster is running. -->
    
  4. Edit “server.xml” from “/server/all/deploy/jbossweb.sar/server.xml” so that it has following lines.
  5. <!-- START mod_cluster setting -->
         <Listener  className="org.jboss.web.tomcat.service.deployers.MicrocontainerIntegrationLifecycleListener" delegateBeanName="HAModClusterService"/>
    <!-- END mod_cluster setting -->
    

    NOTE:
    Make sure you add above line BEFORE/ABOVE

       <Service name="jboss.web">
    

    and

    <!-- START mod_cluster setting -->
         <Engine name="jboss.web" defaultHost="localhost" jvmRoute="${jboss.jvmRoute}">
    <!-- END mod_cluster setting -->
    

    NOTE:
    Make sure you replace above line instead of this line

          <Engine name="jboss.web" defaultHost="localhost">
    
  6. Edit “jboss-beans.xml” (/server/all/deploy/jbossweb.sar/META-INF/jboss-beans.xml) and add the below line in “bean” element
  7. <depends>HAModClusterService</depends>
    

Command to start the servers

Below is the command to start the serves in a cluster which are on the same Box/Physical Machine

NODE-1:

./run.sh -c cluster_node1 -g ClusterA -u 239.255.100.101 -b localhost -Djboss.Domain=test -Djboss.messaging.ServerPeerID=1 -Djboss.service.binding.set=ports-01 -Djboss.jvmRoute="node1"

NODE-2:

./run.sh -c cluster_node2 -g ClusterA -u 239.255.100.101 -b localhost -Djboss.Domain=test -Djboss.messaging.ServerPeerID=2 -Djboss.service.binding.set=ports-02 -Djboss.jvmRoute="node2"

URL to hit

http://localhost/mod_cluster_manager

Regards,

Middleware Magic


Copyright © 2010-2012 Middleware Magic. All rights reserved. |