org.mule.transport.servlet

Class ServletResponseWriter

java.lang.Object

org.mule.transport.servlet.ServletResponseWriter

public class ServletResponseWriter
extends Object

Writes a servlet response based on a mule message or basic attributes of a response.

Constructor Summary

Constructors

Constructor and Description
ServletResponseWriter()

Method Summary

Methods

Modifier and Type	Method and Description
ServletResponseWriter	setFeedbackOnEmptyResponse(boolean feedbackOnEmptyResponse)
void	writeEmptyResponse(javax.servlet.http.HttpServletResponse servletResponse, Map<String,String> httpHeaders) Writes an empty HttpServletResponse.
void	writeErrorResponse(javax.servlet.http.HttpServletResponse servletResponse, int errorCode, String errorMessage, Map<String,String> httpHeaders) Writes a servlet response with an error code with html code wrapping the error message.
void	writeErrorResponse(javax.servlet.http.HttpServletResponse servletResponse, org.mule.api.MuleMessage message, int errorCode, String errorMessage, Map<String,String> httpHeaders) Writes a servlet response with an error code based on a mule message.
void	writeNonHtmlErrorResponse(javax.servlet.http.HttpServletResponse servletResponse, int errorCode, String errorMessage, Map<String,String> httpHeaders) Writes a servlet response with an error code without html code wrapping the error message.
void	writeResponse(javax.servlet.http.HttpServletResponse servletResponse, org.mule.api.MuleMessage message, Map<String,String> httpHeaders) Writes a servlet response based on a mule message.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletResponseWriter

public ServletResponseWriter()

Method Detail

writeResponse

public void writeResponse(javax.servlet.http.HttpServletResponse servletResponse,
                 org.mule.api.MuleMessage message,
                 Map<String,String> httpHeaders)
                   throws Exception

Writes a servlet response based on a mule message.

Parameters:

servletResponse - response object

message - must be a not null message which content will be sent as response

httpHeaders - headers to be set in the response object. Can be null.

Throws:

Exception

writeEmptyResponse

public void writeEmptyResponse(javax.servlet.http.HttpServletResponse servletResponse,
                      Map<String,String> httpHeaders)
                        throws IOException

Writes an empty HttpServletResponse.

Parameters:

servletResponse - response object

httpHeaders - headers to be set in the response object. Can be null.

Throws:

IOException

writeErrorResponse

public void writeErrorResponse(javax.servlet.http.HttpServletResponse servletResponse,
                      org.mule.api.MuleMessage message,
                      int errorCode,
                      String errorMessage,
                      Map<String,String> httpHeaders)
                        throws Exception

Writes a servlet response with an error code based on a mule message.

Parameters:

servletResponse - response object

message - message with the content of the response

errorCode - http error code to be sent back to the client

errorMessage - http error message

httpHeaders - headers to be set in the response object. Can be null.

Throws:

Exception

writeErrorResponse

public void writeErrorResponse(javax.servlet.http.HttpServletResponse servletResponse,
                      int errorCode,
                      String errorMessage,
                      Map<String,String> httpHeaders)
                        throws Exception

Writes a servlet response with an error code with html code wrapping the error message.

Parameters:

servletResponse - response object

errorCode - http error code to be sent back to the client

errorMessage - http error message

httpHeaders - headers to be set in the response object. Can be null.

Throws:

Exception

writeNonHtmlErrorResponse

public void writeNonHtmlErrorResponse(javax.servlet.http.HttpServletResponse servletResponse,
                             int errorCode,
                             String errorMessage,
                             Map<String,String> httpHeaders)
                               throws Exception

Writes a servlet response with an error code without html code wrapping the error message.

Parameters:

servletResponse - response object

errorCode - http error code to be sent back to the client

errorMessage - http error message

httpHeaders - headers to be set in the response object. Can be null.

Throws:

Exception

setFeedbackOnEmptyResponse

public ServletResponseWriter setFeedbackOnEmptyResponse(boolean feedbackOnEmptyResponse)

Parameters:

feedbackOnEmptyResponse - if set to true, when an empty response is sent back to the client a message will be add to the response body.