org.mule.transport.servlet
Class AbstractReceiverServlet

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          org.mule.transport.servlet.AbstractReceiverServlet

All Implemented Interfaces:

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

Direct Known Subclasses:

MuleReceiverServlet

public abstract class AbstractReceiverServlet
extends javax.servlet.http.HttpServlet

A base servlet used to receive requests from a servlet container and route them into Mule

See Also:

Serialized Form

Field Summary

static String	DEFAULT_CONTENT_TYPE_PROPERTY
static long	DEFAULT_GET_TIMEOUT
static String	DEFAULT_PAYLOAD_PARAMETER_NAME
protected String	defaultContentType
protected boolean	feedback
static String	FEEDBACK_PROPERTY
protected org.apache.commons.logging.Log	logger logger used by this class
protected org.mule.api.MuleContext	muleContext
static String	PAYLOAD_PARAMETER_NAME
protected String	payloadParameterName
static String	REQUEST_TIMEOUT_PROPERTY
static String	SERVLET_CONNECTOR_NAME_PROPERTY Deprecated. Use MuleServletContextListener.CONNECTOR_NAME instead
protected long	timeout

Constructor Summary

AbstractReceiverServlet()

Method Summary

protected boolean	contentTypeHeaderIsValid(org.apache.commons.httpclient.Header header)
protected HttpResponse	convertToHttpResponse(org.mule.api.MuleMessage message)
protected void	doInit()
protected void	ensureContentTypeHeaderIsSet(javax.servlet.http.HttpServletResponse servletResponse, HttpResponse httpResponse)
protected void	handleException(Throwable exception, String message, javax.servlet.http.HttpServletResponse response)
void	init()
protected javax.servlet.http.HttpServletResponse	setHttpHeadersOnServletResponse(HttpResponse httpResponse, javax.servlet.http.HttpServletResponse servletResponse)
protected org.mule.api.MuleContext	setupMuleContext()
protected void	setupResponseTransformer()
protected void	writeEmptyResponse(javax.servlet.http.HttpServletResponse servletResponse)
protected void	writeErrorResponseFromMessage(javax.servlet.http.HttpServletResponse servletResponse, org.mule.api.MuleMessage message, int errorCode, String errorMessage)
protected void	writeResponse(javax.servlet.http.HttpServletResponse servletResponse, org.mule.api.MuleMessage message)
protected void	writeResponseFromMessage(javax.servlet.http.HttpServletResponse servletResponse, org.mule.api.MuleMessage message)

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected transient org.apache.commons.logging.Log logger

logger used by this class

REQUEST_TIMEOUT_PROPERTY

public static final String REQUEST_TIMEOUT_PROPERTY

See Also:

Constant Field Values

FEEDBACK_PROPERTY

public static final String FEEDBACK_PROPERTY

See Also:

Constant Field Values

DEFAULT_CONTENT_TYPE_PROPERTY

public static final String DEFAULT_CONTENT_TYPE_PROPERTY

See Also:

Constant Field Values

SERVLET_CONNECTOR_NAME_PROPERTY

@Deprecated
public static final String SERVLET_CONNECTOR_NAME_PROPERTY

Deprecated. Use MuleServletContextListener.CONNECTOR_NAME instead

The name of the servlet connector to use with this Servlet

See Also:

Constant Field Values

PAYLOAD_PARAMETER_NAME

public static final String PAYLOAD_PARAMETER_NAME

See Also:

Constant Field Values

DEFAULT_PAYLOAD_PARAMETER_NAME

public static final String DEFAULT_PAYLOAD_PARAMETER_NAME

See Also:

Constant Field Values

DEFAULT_GET_TIMEOUT

public static final long DEFAULT_GET_TIMEOUT

See Also:

Constant Field Values

payloadParameterName

protected String payloadParameterName

timeout

protected long timeout

feedback

protected boolean feedback

defaultContentType

protected String defaultContentType

muleContext

protected org.mule.api.MuleContext muleContext

Constructor Detail

AbstractReceiverServlet

public AbstractReceiverServlet()

Method Detail

init

public final void init()
                throws javax.servlet.ServletException

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

setupMuleContext

protected org.mule.api.MuleContext setupMuleContext()
                                             throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

setupResponseTransformer

protected void setupResponseTransformer()
                                 throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

doInit

protected void doInit()
               throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

writeResponse

protected void writeResponse(javax.servlet.http.HttpServletResponse servletResponse,
                             org.mule.api.MuleMessage message)
                      throws Exception

Throws:

Exception

writeEmptyResponse

protected void writeEmptyResponse(javax.servlet.http.HttpServletResponse servletResponse)
                           throws IOException

Throws:

IOException

writeResponseFromMessage

protected void writeResponseFromMessage(javax.servlet.http.HttpServletResponse servletResponse,
                                        org.mule.api.MuleMessage message)
                                 throws Exception

Throws:

Exception

convertToHttpResponse

protected HttpResponse convertToHttpResponse(org.mule.api.MuleMessage message)
                                      throws org.mule.api.transformer.TransformerException

Throws:

org.mule.api.transformer.TransformerException

setHttpHeadersOnServletResponse

protected javax.servlet.http.HttpServletResponse setHttpHeadersOnServletResponse(HttpResponse httpResponse,
                                                                                 javax.servlet.http.HttpServletResponse servletResponse)

ensureContentTypeHeaderIsSet

protected void ensureContentTypeHeaderIsSet(javax.servlet.http.HttpServletResponse servletResponse,
                                            HttpResponse httpResponse)

contentTypeHeaderIsValid

protected boolean contentTypeHeaderIsValid(org.apache.commons.httpclient.Header header)

handleException

protected void handleException(Throwable exception,
                               String message,
                               javax.servlet.http.HttpServletResponse response)

writeErrorResponseFromMessage

protected void writeErrorResponseFromMessage(javax.servlet.http.HttpServletResponse servletResponse,
                                             org.mule.api.MuleMessage message,
                                             int errorCode,
                                             String errorMessage)
                                      throws Exception

Throws:

Exception