org.apache.axis2.transport.http

Class AxisServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.apache.axis2.transport.http.AxisServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class AxisServlet
extends javax.servlet.http.HttpServlet

Servlet implementing the HTTP and HTTPS transport. Note that this class doesn't implement TransportListener. There are two reasons for this:

• There must be one instance of TransportListener for each protocol, but this servlet may implement both HTTP and HTTPS.
• There is a collision between TransportListener.destroy() and Servlet.destroy().

The TransportListener implementation is provided by AxisServletListener. An instance of that class must be declared in axis2.xml for each protocol (HTTP/HTTPS) that the servlet should accept.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AxisServlet.RestRequestProcessor Ues in processing REST related Requests.
protected class	AxisServlet.ServletRequestResponseTransport

Field Summary

Fields

Modifier and Type	Field and Description
protected ListingAgent	agent
protected org.apache.axis2.engine.AxisConfiguration	axisConfiguration
protected org.apache.axis2.context.ConfigurationContext	configContext
static String	CONFIGURATION_CONTEXT
protected String	contextRoot
protected boolean	disableREST
protected javax.servlet.ServletConfig	servletConfig
static String	SESSION_ID

Constructor Summary

Constructors

Constructor and Description
AxisServlet()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.axis2.context.MessageContext	createMessageContext(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) This method assumes, that the created MessageContext will be used in only SOAP invocation.
protected org.apache.axis2.context.MessageContext	createMessageContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, boolean invocationType)
void	destroy() distroy the ConfigurationContext
protected void	doDelete(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Implementation of DELETE interface
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Implementation for GET interface
protected void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Implementaion of POST interface
protected void	doPut(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Implementation of PUT interface
protected Map<String,String>	getTransportHeaders(javax.servlet.http.HttpServletRequest req) Get all transport headers.
protected void	handleFault(org.apache.axis2.context.MessageContext msgContext, OutputStream out, org.apache.axis2.AxisFault e)
void	init() Convenient method to re-initialize the ConfigurationContext
void	init(javax.servlet.ServletConfig config) Main init method
protected org.apache.axis2.context.ConfigurationContext	initConfigContext(javax.servlet.ServletConfig config) Initialize the Axis configuration context
void	initContextRoot(javax.servlet.http.HttpServletRequest req) Set the context root if it is not set already.
protected void	initGetRequestProcessors(javax.servlet.ServletConfig config) Initialize HTTP GET request processors
protected void	initParams() Initializes the Axis2 parameters.
protected void	initTransports() Initialize HTTP transports
protected void	showRestDisabledErrorMessage(javax.servlet.http.HttpServletResponse response) Private method that deals with disabling of REST support.

Methods inherited from class javax.servlet.http.HttpServlet

doHead, doOptions, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONFIGURATION_CONTEXT

public static final String CONFIGURATION_CONTEXT

See Also:

Constant Field Values

SESSION_ID

public static final String SESSION_ID

See Also:

Constant Field Values

configContext

protected transient org.apache.axis2.context.ConfigurationContext configContext

axisConfiguration

protected transient org.apache.axis2.engine.AxisConfiguration axisConfiguration

servletConfig

protected transient javax.servlet.ServletConfig servletConfig

agent

protected transient ListingAgent agent

contextRoot

protected transient String contextRoot

disableREST

protected boolean disableREST

Constructor Detail

AxisServlet

public AxisServlet()

Method Detail

doPost

protected void doPost(javax.servlet.http.HttpServletRequest request,
          javax.servlet.http.HttpServletResponse response)
               throws javax.servlet.ServletException,
                      IOException

Implementaion of POST interface

Overrides:

doPost in class javax.servlet.http.HttpServlet

Parameters:

request -

response -

Throws:

javax.servlet.ServletException

IOException

doGet

protected void doGet(javax.servlet.http.HttpServletRequest request,
         javax.servlet.http.HttpServletResponse response)
              throws javax.servlet.ServletException,
                     IOException

Implementation for GET interface

Overrides:

doGet in class javax.servlet.http.HttpServlet

Parameters:

request -

response -

Throws:

javax.servlet.ServletException

IOException

doDelete

protected void doDelete(javax.servlet.http.HttpServletRequest request,
            javax.servlet.http.HttpServletResponse response)
                 throws javax.servlet.ServletException,
                        IOException

Implementation of DELETE interface

Overrides:

doDelete in class javax.servlet.http.HttpServlet

Parameters:

request -

response -

Throws:

javax.servlet.ServletException

IOException

doPut

protected void doPut(javax.servlet.http.HttpServletRequest request,
         javax.servlet.http.HttpServletResponse response)
              throws javax.servlet.ServletException,
                     IOException

Implementation of PUT interface

Overrides:

doPut in class javax.servlet.http.HttpServlet

Parameters:

request -

response -

Throws:

javax.servlet.ServletException

IOException

showRestDisabledErrorMessage

protected void showRestDisabledErrorMessage(javax.servlet.http.HttpServletResponse response)
                                     throws IOException

Private method that deals with disabling of REST support.

Parameters:

response -

Throws:

IOException

handleFault

protected void handleFault(org.apache.axis2.context.MessageContext msgContext,
               OutputStream out,
               org.apache.axis2.AxisFault e)
                    throws org.apache.axis2.AxisFault

Throws:

org.apache.axis2.AxisFault

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Main init method

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Parameters:

config - The ServletConfig

Throws:

javax.servlet.ServletException

initGetRequestProcessors

protected void initGetRequestProcessors(javax.servlet.ServletConfig config)

Initialize HTTP GET request processors

Parameters:

config - The ServletConfig of this Servlet

initTransports

protected void initTransports()
                       throws org.apache.axis2.AxisFault

Initialize HTTP transports

Throws:

org.apache.axis2.AxisFault - If an error occurs while initializing transports

destroy

public void destroy()

distroy the ConfigurationContext

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet

initParams

protected void initParams()

Initializes the Axis2 parameters.

init

public void init()
          throws javax.servlet.ServletException

Convenient method to re-initialize the ConfigurationContext

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

initConfigContext

protected org.apache.axis2.context.ConfigurationContext initConfigContext(javax.servlet.ServletConfig config)
                                                                   throws javax.servlet.ServletException

Initialize the Axis configuration context

Parameters:

config - Servlet configuration

Returns:

ConfigurationContext

Throws:

javax.servlet.ServletException

initContextRoot

public void initContextRoot(javax.servlet.http.HttpServletRequest req)

Set the context root if it is not set already.

Parameters:

req -

getTransportHeaders

protected Map<String,String> getTransportHeaders(javax.servlet.http.HttpServletRequest req)

Get all transport headers.

Parameters:

req -

Returns:

Map

createMessageContext

protected org.apache.axis2.context.MessageContext createMessageContext(javax.servlet.http.HttpServletRequest request,
                                                           javax.servlet.http.HttpServletResponse response,
                                                           boolean invocationType)
                                                                throws IOException

Parameters:

request -

response -

invocationType - : If invocationType=true; then this will be used in SOAP message invocation. If invocationType=false; then this will be used in REST message invocation.

Returns:

MessageContext

Throws:

IOException

createMessageContext

protected org.apache.axis2.context.MessageContext createMessageContext(javax.servlet.http.HttpServletRequest req,
                                                           javax.servlet.http.HttpServletResponse resp)
                                                                throws IOException

This method assumes, that the created MessageContext will be used in only SOAP invocation.

Parameters:

req -

resp -

Returns:

MessageContext

Throws:

IOException