org.xins.common.servlet.container

Class XINSServletResponse

java.lang.Object

org.xins.common.servlet.container.XINSServletResponse

All Implemented Interfaces:

HttpServletResponse, ServletResponse

public class XINSServletResponse
extends Object
implements HttpServletResponse

This class is an implementation of the HttpServletResponse that can be invoked locally.

Version:

$Revision: 1.25 $ $Date: 2010/10/25 20:36:52 $

Author:

Anthony Goubard

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletResponse

SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY

Constructor Summary

Constructors

Constructor and Description
XINSServletResponse() Creates a new instance of XINSServletResponse.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCookie(Cookie cookie)
void	addDateHeader(String str, long param)
void	addHeader(String str, String str1)
void	addIntHeader(String str, int param)
boolean	containsHeader(String str)
String	encodeRedirectUrl(String str)
String	encodeRedirectURL(String str)
String	encodeUrl(String url)
String	encodeURL(String url)
void	flushBuffer()
int	getBufferSize()
String	getCharacterEncoding()
String	getContentType() Gets the type of the returned content.
Map<String,String>	getHeaders() Gets the headers to return to the client.
Locale	getLocale()
ServletOutputStream	getOutputStream()
String	getResult() Gets the returned message from the servlet.
int	getStatus() Gets the status of the returned message.
PrintWriter	getWriter()
boolean	isCommitted()
void	reset()
void	resetBuffer()
void	sendError(int sc)
void	sendError(int sc, String msg)
void	sendRedirect(String location)
void	setBufferSize(int param)
void	setContentLength(int param)
void	setContentType(String type) Sets the content type.
void	setDateHeader(String str, long param)
void	setHeader(String str, String str1)
void	setIntHeader(String str, int param)
void	setLocale(Locale locale)
void	setStatus(int sc)
void	setStatus(int param, String str)

Methods inherited from class java.lang.Object

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

Constructor Detail

XINSServletResponse

public XINSServletResponse()

Creates a new instance of XINSServletResponse.

Method Detail

addDateHeader

public void addDateHeader(String str,
                 long param)

Specified by:

addDateHeader in interface HttpServletResponse

setDateHeader

public void setDateHeader(String str,
                 long param)

Specified by:

setDateHeader in interface HttpServletResponse

encodeUrl

public String encodeUrl(String url)

Specified by:

encodeUrl in interface HttpServletResponse

encodeURL

public String encodeURL(String url)

Specified by:

encodeURL in interface HttpServletResponse

encodeRedirectUrl

public String encodeRedirectUrl(String str)

Specified by:

encodeRedirectUrl in interface HttpServletResponse

encodeRedirectURL

public String encodeRedirectURL(String str)

Specified by:

encodeRedirectURL in interface HttpServletResponse

containsHeader

public boolean containsHeader(String str)

Specified by:

containsHeader in interface HttpServletResponse

sendRedirect

public void sendRedirect(String location)

Specified by:

sendRedirect in interface HttpServletResponse

setContentType

public void setContentType(String type)
                    throws IllegalArgumentException

Sets the content type.

Specified by:

setContentType in interface ServletResponse

Parameters:

type - the content type, cannot be null.

Throws:

IllegalArgumentException - if type == null.

setStatus

public void setStatus(int sc)

Specified by:

setStatus in interface HttpServletResponse

sendError

public void sendError(int sc)

Specified by:

sendError in interface HttpServletResponse

setBufferSize

public void setBufferSize(int param)

Specified by:

setBufferSize in interface ServletResponse

setContentLength

public void setContentLength(int param)

Specified by:

setContentLength in interface ServletResponse

addCookie

public void addCookie(Cookie cookie)

Specified by:

addCookie in interface HttpServletResponse

setLocale

public void setLocale(Locale locale)

Specified by:

setLocale in interface ServletResponse

setStatus

public void setStatus(int param,
             String str)

Specified by:

setStatus in interface HttpServletResponse

setIntHeader

public void setIntHeader(String str,
                int param)

Specified by:

setIntHeader in interface HttpServletResponse

addIntHeader

public void addIntHeader(String str,
                int param)

Specified by:

addIntHeader in interface HttpServletResponse

sendError

public void sendError(int sc,
             String msg)

Specified by:

sendError in interface HttpServletResponse

setHeader

public void setHeader(String str,
             String str1)

Specified by:

setHeader in interface HttpServletResponse

getLocale

public Locale getLocale()

Specified by:

getLocale in interface ServletResponse

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface ServletResponse

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface ServletResponse

flushBuffer

public void flushBuffer()

Specified by:

flushBuffer in interface ServletResponse

addHeader

public void addHeader(String str,
             String str1)

Specified by:

addHeader in interface HttpServletResponse

getOutputStream

public ServletOutputStream getOutputStream()

Specified by:

getOutputStream in interface ServletResponse

getWriter

public PrintWriter getWriter()

Specified by:

getWriter in interface ServletResponse

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface ServletResponse

reset

public void reset()

Specified by:

reset in interface ServletResponse

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface ServletResponse

getResult

public String getResult()

Gets the returned message from the servlet.

Returns:

the returned message or null if no message is returned.

getStatus

public int getStatus()

Gets the status of the returned message.

Returns:

the HTTP status returned.

getContentType

public String getContentType()

Gets the type of the returned content.

Returns:

the content type, can be null.

See Also:

setContentType(String)

getHeaders

public Map<String,String> getHeaders()

Gets the headers to return to the client.

Returns:

the headers, cannot be null.

Since:

XINS 1.3.0