• Home
• org.xmlactions
• axelframework
• 3.1.13.RELEASE
• source code
• package-info-web-config.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.xmlactions.web.package-info-web-config Maven / Gradle / Ivy

package org.xmlactions.web;

/**
 
 \page org_xmlactons_web_xml_configuration Web Server XML Configuration
 
 \tableofcontents

 \section axel_web_server_xml_configuration AXEL Web Server web.xml Configuration
 
 See \ref org_xmlactons_web_server_spring_configuration to configure spring for loading static data.

 \subsection axel_web_xml_configuration AXEL Web XML Configuration
 
 These instructions show how to configure the web.xml and have the web server process axel requests.
  
 \ref setting_up_servlet_in_web_xml - how to setup the axel HttpPager servlet to service axel requests. 
 
 \ref setting_up_filter_in_web_xml - how to setup a filter to process jsp and axel requests.
 
 \ref setting_up_spring_framework_in_web_xml - how to setup the main spring configuration.
 
 \subsubsection setting_up_servlet_in_web_xml Setting up the servlet
 
 \code{.xml}
 
		
			AXEL Servlet
			axel
			org.xmlactions.web.PagerServlet
			
				pager.namespace
				pager
			
			1
		
		
			axel
			*.axel
		
		
			axel
			*.soap
		
		
			axel
			*.ajax
		
		
			axel
			*.bin
		

 \endcode
	
	Explanation of Setting up the servlet:
 	

 		

 			
xml element
 			
element description
 		
 		

 			

 		
 		

 			
servlet
 			
The java class that will process the HttpRequest's.  The associated servlet-mapping's define the page types that will be processed by the servlet
 		
 		

 			

 		
 		

 			
servlet-mapping
 			
These are the page types that will be serviced as HttpRequests.  The page type refers to the file extension such as .axel etc.


 				The type of files that are processed in this configuration are

 				

 					
.axel - web page extensions similar to html pages.
 					
.soap - soap requests, these are processed the same as axel pages but the response type is "text/xml;charset=UTF-8"
 					
.ajax - ajax requests, these are processed the same as axel pages but can return errors in the response.  The response can have
	 					

	 						
OK: - request processed successfully
	 						
ER: - request processed with an error. The error content follows the ER: in the response.  Generally an alert is shown on the requesting browser with the error details.
	 						
EX: - request processed with an exception. The exception content follows the EX: in the response.  Generally an alert is shown on the requesting browser with the exception details.
	 					
 					
 					
.bin - binary requests, these are processed the same as axel pages but the response is returned with an appropriate contentType.  The default content type is "image/png" but this can get
 						set differently by the servicing code.
 					
 				
 			
 		
 	
 	
 \subsubsection setting_up_filter_in_web_xml  Setting up a servlet filter
 
 A servlet filter will firstly service it's associated file types (such as .jsp's) then service the file through the axel servlet, combining JSPs with AXEL.  
 
 \code{.xml}
 
   
      PagerFilter
      org.xmlactions.web.PagerFilter
      
         pager.realPath
         
      
      
         pager.namespace
         pager
      
   
   
      PagerFilter
      *.jsp
   
 	
 \endcode
 
	Explanation of Setting up a servlet filter:
 	

 		

 			
xml element
 			
element description
 		
 		

 			

 		
 		

 			
filter
 			
The java class that will process the filter HttpRequest's.  The associated filter-mapping's define the page types that will be processed by the servlet filter
 		
 		

 			

 		
 		

 			
filter-mapping
 			
These are the page types that will be serviced as filter HttpRequests.  The page type refers to the file extension such as .jsp etc.


 				The type of files that are processed in this configuration are

 				

 					
.jsp - Java Server Pages
 				
 			
 		
 	
 
 \subsubsection setting_up_spring_framework_in_web_xml Setting up the Spring Framework Configuration
 
 The Spring Framework is used by AXEL to configure the system.  The configuration includes the Application Context, Themes, Database Connections, Static Data,
  Language files generally any property or xml configurations that are required by the system being developed.  
 
 \code{.xml}
 
    
        org.springframework.web.context.ContextLoaderListener
    
    
        org.springframework.web.context.request.RequestContextListener
    

	
		contextConfigLocation
		
			classpath:/config/spring/axel-spring-pager-web-startup.xml
		
	
 	
 \endcode
 
	Explanation of Setting up the Spring Framework Configuration:
 	

 		

 			

 		
 		

 			
listener-class
 			
org.springframework.web.context.ContextLoaderListener - Bootstrap listener to start up and shut down Spring's root WebApplicationContext.
 		
 		

 			

 		
 		

 			
listener-class
 			
org.springframework.web.context.request.RequestContextListener - Enables bean scope of request, session and application.
 		
 		

 			

 		
 		

 			
context-param
 			
classpath:/config/spring/spring-pager-web-startup.xml - location of the main spring configuration.
 		
 		

 			

 		
 	
 
*/