Tag: mod_jk

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.


Configuring mod_jk to connect to JBoss

Hi,

Here is a simple step by step procedure to connect to JBoss instance for load balancing purpose through apache webserver. In most of the production environments this is the most common need.

The prerequisite for this exercise is to have the the Apache WebServer installed already in your Machine and the JBoss should be installed in your environment. The “mod_jk” module can be downloaded later to work on this setup. If you want to download the apache software and the mod_jk then you can refer to the link mentioned in the Step6):

JBoss Cluster Creation/Configuration Part:

Step1). As “all” and “production” profiles which are present inside the “E:jboss-AS6-5.1jboss-asserver” location are by default clustering enabled so you can chose any one of them to create your own clustered node. In this exercise we will use “all” profile to create JBoss Clusters.

So first copy the “all” profile and paste it in the same location “E:jboss-AS6-5.1jboss-asserver” with some different name like “all_node1” and “all_node2”. like this your 2 JBoss Clustered Nodes are ready.

Step2). Now open the “server.xml” file present inside the “E:jboss-AS6-5.1jboss-asserverall_node1deployjbossweb.sar” location and then add the “jvmRoute” attribute of the Engine Tag like following:By default the line which you are going to change will look like following:
=============By default it will look like below==================

<Engine name="jboss.web" defaultHost="localhost">

=============After Change it will look like below==================

<Engine name="jboss.web" defaultHost="localhost" jvmRoute="node1">

Step3). Same changes we need to do for “all_node2” profile as well. So open the “server.xml” file present inside the “E:jboss-AS6-5.1jboss-asserverall_node2deployjbossweb.sar” location and then add the “jvmRoute” attribute of the Engine Tag like following:
=============By default it will look like below==================

<Engine name="jboss.web" defaultHost="localhost">

=============After Change it will look like below==================

<Engine name="jboss.web" defaultHost="localhost" jvmRoute="node2">

Why We need “jvmRoute”?

jvmRoute Identifier must be used in load balancing scenarios to enable session affinity. The identifier, which must be unique across all Tomcat 6 servers which participate in the cluster, will be appended to the generated session identifier, therefore allowing the front end proxy to always forward a particular session to the same Tomcat 6 OR JBoss instance.

More information regarding this attribute can be found in the following link:
http://tomcat.apache.org/tomcat-6.0-doc/config/engine.html#Common_Attributes

Step4). Also please make sure that the AJP Connector Tag is uncommented in “E:jboss-AS6-5.1jboss-asserverall_node2deployjbossweb.sarserver.xml” file for both “all_node1” & “all_node2” profiles, Because the communication between Apache and JBoss will happen through this AJP connector port. Like following:

      <!-- A AJP 1.3 Connector on port 8009 -->
      <Connector protocol="AJP/1.3" port="8009" address="${jboss.bind.address}"
         redirectPort="8443" />

Step5). Now start Both the JBoss Instances by running the following command from the following dir “E:jboss-AS6-5.1jboss-asbin”:

run.bat -c all_node1 -b 0.0.0.0 -g ClusterA -Djboss.service.binding.set=ports-01 -Djboss.messaging.ServerPeerID=1
run.bat -c all_node2 -b 0.0.0.0 -g ClusterA -Djboss.service.binding.set=ports-02 -Djboss.messaging.ServerPeerID=2

Here following are the meaning of the flags which we have used :
-c = The jboss profile which we want to start

-g = The name of the cluster. The same name of the cluster should be used by the profiles which want to join the same cluster formation.

-Djboss.service.binding.set = The advantage of this way is you don’t have to take (and maintain) a separate copy of the all folder if you want to, say, start up multiple instances of JBoss running as a cluster. For more information on this system property please refer to the following : http://community.jboss.org/wiki/ConfigurePorts

-Djboss.messaging.ServerPeerID = Each node must have a unique ServerPeerID for clustering to work!. It can be any unique integer value among all the cluster members. Means every cluster node should have a unique peer ID.

-b = The bind address in which you want to run your profile. o.o.o.o represents it will listen to all the IP Addresses associated with that box. better if we can specify a particular “IP Address” or “localhost” there rather than using “0.0.0.0”

So suppose if you are running your JBoss on two separate physical boxes which has different IP Addresses like 10.10.10.10 and 20.20.20.20 then please run the servers like following

run.bat -c all_node1 -b 10.10.10.10 -g ClusterA -Djboss.service.binding.set=ports-01 -Djboss.messaging.ServerPeerID=1
run.bat -c all_node2 -b 20.20.20.20 -g ClusterA -Djboss.service.binding.set=ports-02 -Djboss.messaging.ServerPeerID=2

Apache WebServer Configuration Part:

Step6). Download & Install the apache webserver from the following link along with the “mod_jk” file:
http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Web_Platform/5/html/Administration_And_Configuration_Guide/clustering-http.html#clustering-http-modjk

Step7). Now paste the “mod_jk.so” file inside the modules directory of your apache which may be “C:Program FilesApache GroupApache2modules”

Step8). Now add the following line of configuration somewhere at the bottom inside your “C:Program FilesApache GroupApache2confhttpd.conf” file to include the mod_jk configuration file:

##### JBOSS #############
LoadModule jk_module modules/mod_jk.so

# Include mod_jk's specific configuration file
Include conf/mod_jk.conf
###########################

Step9). Now create a file with name “mod_jk.conf” inside the directory “C:Program FilesApache GroupApache2conf” as following:

##### JBOSS #############
# Load mod_jk module
# Specify the filename of the mod_jk lib
LoadModule jk_module modules/mod_jk.so

# Where to find workers.properties
JkWorkersFile conf/workers.properties

# Where to put jk logs
JkLogFile logs/mod_jk.log

# Set the jk log level [debug/error/info]
JkLogLevel info

# Select the log format
JkLogStampFormat  "[%a %b %d %H:%M:%S %Y]"

# JkOptions indicates to send SSK KEY SIZE
JkOptions +ForwardKeySize +ForwardURICompat -ForwardDirectories

# JkRequestLogFormat
JkRequestLogFormat "%w %V %T"

# Mount your applications
JkMount /* failover

# You can use external file for mount points.
# It will be checked for updates each 60 seconds.
# The format of the file is: /url=worker
# /examples/*=loadbalancer
#JkMountFile conf/uriworkermap.properties

# Add shared memory.
# This directive is present with 1.2.10 and
# later versions of mod_jk, and is needed for
# for load balancing to work properly
JkShmFile logs/jk.shm

# Add jkstatus for managing runtime data
<Location /jkstatus/>
    JkMount status
    Order deny,allow
    Deny from all
    Allow from 127.0.0.1
</Location>
###########################

Step10). Now create another most important file “worker.properties” inside “C:Program FilesApache GroupApache2conf” to tell apache to load balance between what all nodes of the JBoss clusters:

##### JBOSS #############
# Define list of workers that will be used
# for mapping requests
worker.list=failover
#,status

# Define Node2
# modify the host as your host IP or DNS name.
worker.node2.port=8209
worker.node2.host=20.20.20.20
worker.node2.type=ajp13
worker.node2.ping_mode=A
worker.node2.lbfactor=1

# Define Node1
# modify the host as your host IP or DNS name.
worker.node1.port=8109
worker.node1.host=10.10.10.10
worker.node1.type=ajp13
worker.node1.ping_mode=A
worker.node1.lbfactor=1

# Load-balancing behaviour
worker.loadbalancer.type=lb
worker.loadbalancer.balance_workers=node2,node1
worker.loadbalancer.sticky_session=False
worker.list=loadbalancer

# Status worker for managing load balancer
#worker.status.type=status
###########################

NOTE: Make sure that you are setting the correct “Hostname” and “AJP Port” for your JBoss in the above file.

Step 11). Now restart your apache server and then hit the following URL to access the JBoss:

http://localhost/jmx-console
OR
http://localhost/admin-console

.
.
Thanks
Middleware Magic


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