okapi.tools
Class ToolResponse

java.lang.Object
  javax.servlet.ServletResponseWrapper
      javax.servlet.http.HttpServletResponseWrapper
          okapi.tools.ToolResponse

All Implemented Interfaces:

javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse

public class ToolResponse
extends javax.servlet.http.HttpServletResponseWrapper

Class ToolResponse. Response Wrapper used by the Aggregator to collect the output from any servlet.

Version:

$Revision: 863 $, $Date: 2006-05-07 17:24:27 -0400 (Sun, 07 May 2006) $

Author:

MIT Stellar team

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_FOUND, 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

ToolResponse(javax.servlet.http.HttpServletResponse response)
Constructor ToolResponse.

Method Summary

void	addCookie(javax.servlet.http.Cookie cookie) Method addCookie.
void	addDateHeader(java.lang.String name, long date) Method addDateHeader..
void	addHeader(java.lang.String name, java.lang.String value) Method addHeader.
void	addIntHeader(java.lang.String name, int value) Method addIntHeader.
boolean	containsHeader(java.lang.String name) Method containsHeader.
java.lang.String	encodeRedirectURL(java.lang.String url) Method encodeRedirectURL.
java.lang.String	encodeURL(java.lang.String url) Method encodeURL.
void	flushBuffer() Method flushBuffer.
int	getBufferSize() Method getBufferSize.
java.lang.String	getCharacterEncoding() Method getCharacterEncoding.
java.lang.String	getContentType() Method getContentType.
java.util.Locale	getLocale() Method getLocale.
javax.servlet.ServletOutputStream	getOutputStream() Method getOutputStream.
java.lang.String	getRedirectLocation() getRedirectLocation() Returns any redirect location set by sendRedirect(String location)
javax.servlet.ServletResponse	getResponse() Method getResponse.
java.io.PrintWriter	getWriter() Method getWriter.
boolean	isCommitted() Method isCommitted.
void	reset() Method reset.
void	resetBuffer() Method resetBuffer.
void	sendError(int sc) Method sendError.
void	sendError(int sc, java.lang.String msg) Method sendError.
void	sendRedirect(java.lang.String location) Method sendRedirect.
void	setBufferSize(int size) Method setBufferSize.
void	setCharacterEncoding(java.lang.String charset) Method setCharacterEncoding.
void	setContentLength(int len) Method setContentLength.
void	setContentType(java.lang.String type) Method setContentType.
void	setDateHeader(java.lang.String name, long date) Method setDateHeader.
void	setHeader(java.lang.String name, java.lang.String value) Method setHeader.
void	setIntHeader(java.lang.String name, int value) Method setIntHeader.
void	setLocale(java.util.Locale loc) Method setLocale.
void	setResponse(javax.servlet.ServletResponse response) Method setResponse.
void	setStatus(int sc) Method setStatus.
void	setStatus(int sc, java.lang.String sm) Method setStatus.
byte[]	toByteArray() Method toByteArray.
java.lang.String	toString() Method toString.

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

encodeRedirectUrl, encodeUrl

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolResponse

public ToolResponse(javax.servlet.http.HttpServletResponse response)

Constructor ToolResponse.

Parameters:

response -

Method Detail

addCookie

public void addCookie(javax.servlet.http.Cookie cookie)

Method addCookie.

Specified by:

addCookie in interface javax.servlet.http.HttpServletResponse

Overrides:

addCookie in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

cookie -

See Also:

HttpServletResponse.addCookie(javax.servlet.http.Cookie)

addDateHeader

public void addDateHeader(java.lang.String name,
                          long date)

Method addDateHeader..

Specified by:

addDateHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

addDateHeader in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

name -

date -

See Also:

HttpServletResponse.addDateHeader(java.lang.String, long)

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)

Method addHeader.

Specified by:

addHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

addHeader in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

name -

value -

See Also:

HttpServletResponse.addHeader(java.lang.String, java.lang.String)

addIntHeader

public void addIntHeader(java.lang.String name,
                         int value)

Method addIntHeader.

Specified by:

addIntHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

addIntHeader in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

name -

value -

See Also:

HttpServletResponse.addIntHeader(java.lang.String, int)

containsHeader

public boolean containsHeader(java.lang.String name)

Method containsHeader.

Specified by:

containsHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

containsHeader in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

name -

Returns:

boolean

See Also:

HttpServletResponse.containsHeader(java.lang.String)

encodeRedirectURL

public java.lang.String encodeRedirectURL(java.lang.String url)

Method encodeRedirectURL.

Specified by:

encodeRedirectURL in interface javax.servlet.http.HttpServletResponse

Overrides:

encodeRedirectURL in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

url -

Returns:

String

See Also:

HttpServletResponse.encodeRedirectURL(java.lang.String)

encodeURL

public java.lang.String encodeURL(java.lang.String url)

Method encodeURL.

Specified by:

encodeURL in interface javax.servlet.http.HttpServletResponse

Overrides:

encodeURL in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

url -

Returns:

String

See Also:

HttpServletResponse.encodeURL(java.lang.String)

sendError

public void sendError(int sc,
                      java.lang.String msg)
               throws java.io.IOException

Method sendError.

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Overrides:

sendError in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

sc -

msg -

Throws:

java.io.IOException

See Also:

HttpServletResponse.sendError(int, java.lang.String)

sendError

public void sendError(int sc)
               throws java.io.IOException

Method sendError.

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Overrides:

sendError in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

sc -

Throws:

java.io.IOException

See Also:

HttpServletResponse.sendError(int)

sendRedirect

public void sendRedirect(java.lang.String location)
                  throws java.io.IOException

Method sendRedirect.

Specified by:

sendRedirect in interface javax.servlet.http.HttpServletResponse

Overrides:

sendRedirect in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

location -

Throws:

java.io.IOException

See Also:

HttpServletResponse.sendRedirect(java.lang.String)

getRedirectLocation

public java.lang.String getRedirectLocation()

getRedirectLocation() Returns any redirect location set by sendRedirect(String location)

setDateHeader

public void setDateHeader(java.lang.String name,
                          long date)

Method setDateHeader.

Specified by:

setDateHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setDateHeader in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

name -

date -

See Also:

HttpServletResponse.setDateHeader(java.lang.String, long)

setHeader

public void setHeader(java.lang.String name,
                      java.lang.String value)

Method setHeader.

Specified by:

setHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setHeader in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

name -

value -

See Also:

HttpServletResponse.setHeader(java.lang.String, java.lang.String)

setIntHeader

public void setIntHeader(java.lang.String name,
                         int value)

Method setIntHeader.

Specified by:

setIntHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setIntHeader in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

name -

value -

See Also:

HttpServletResponse.setIntHeader(java.lang.String, int)

setStatus

public void setStatus(int sc,
                      java.lang.String sm)

Method setStatus.

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

Overrides:

setStatus in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

sc -

sm -

See Also:

HttpServletResponse.setStatus(int, java.lang.String)

setStatus

public void setStatus(int sc)

Method setStatus.

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

Overrides:

setStatus in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

sc -

See Also:

HttpServletResponse.setStatus(int)

getResponse

public javax.servlet.ServletResponse getResponse()

Method getResponse.

Overrides:

getResponse in class javax.servlet.ServletResponseWrapper

Returns:

ServletResponse

See Also:

ServletResponseWrapper.getResponse()

setResponse

public void setResponse(javax.servlet.ServletResponse response)

Method setResponse.

Overrides:

setResponse in class javax.servlet.ServletResponseWrapper

Parameters:

response -

See Also:

ServletResponseWrapper.setResponse(javax.servlet.ServletResponse)

setCharacterEncoding

public void setCharacterEncoding(java.lang.String charset)

Method setCharacterEncoding.

Specified by:

setCharacterEncoding in interface javax.servlet.ServletResponse

Overrides:

setCharacterEncoding in class javax.servlet.ServletResponseWrapper

Parameters:

charset -

See Also:

ServletResponse.setCharacterEncoding(java.lang.String)

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Method getCharacterEncoding.

Specified by:

getCharacterEncoding in interface javax.servlet.ServletResponse

Overrides:

getCharacterEncoding in class javax.servlet.ServletResponseWrapper

Returns:

String

See Also:

ServletResponse.getCharacterEncoding()

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws java.io.IOException

Method getOutputStream.

Specified by:

getOutputStream in interface javax.servlet.ServletResponse

Overrides:

getOutputStream in class javax.servlet.ServletResponseWrapper

Returns:

ServletOutputStream

Throws:

java.io.IOException

See Also:

ServletResponse.getOutputStream()

getWriter

public java.io.PrintWriter getWriter()
                              throws java.io.IOException

Method getWriter.

Specified by:

getWriter in interface javax.servlet.ServletResponse

Overrides:

getWriter in class javax.servlet.ServletResponseWrapper

Returns:

PrintWriter

Throws:

java.io.IOException

See Also:

ServletResponse.getWriter()

setContentLength

public void setContentLength(int len)

Method setContentLength.

Specified by:

setContentLength in interface javax.servlet.ServletResponse

Overrides:

setContentLength in class javax.servlet.ServletResponseWrapper

Parameters:

len -

See Also:

ServletResponse.setContentLength(int)

setContentType

public void setContentType(java.lang.String type)

Method setContentType.

Specified by:

setContentType in interface javax.servlet.ServletResponse

Overrides:

setContentType in class javax.servlet.ServletResponseWrapper

Parameters:

type -

See Also:

ServletResponse.setContentType(java.lang.String)

getContentType

public java.lang.String getContentType()

Method getContentType.

Specified by:

getContentType in interface javax.servlet.ServletResponse

Overrides:

getContentType in class javax.servlet.ServletResponseWrapper

Returns:

String

See Also:

ServletResponse.getContentType()

setBufferSize

public void setBufferSize(int size)

Method setBufferSize.

Specified by:

setBufferSize in interface javax.servlet.ServletResponse

Overrides:

setBufferSize in class javax.servlet.ServletResponseWrapper

Parameters:

size -

See Also:

ServletResponse.setBufferSize(int)

getBufferSize

public int getBufferSize()

Method getBufferSize.

Specified by:

getBufferSize in interface javax.servlet.ServletResponse

Overrides:

getBufferSize in class javax.servlet.ServletResponseWrapper

Returns:

int

See Also:

ServletResponse.getBufferSize()

flushBuffer

public void flushBuffer()
                 throws java.io.IOException

Method flushBuffer.

Specified by:

flushBuffer in interface javax.servlet.ServletResponse

Overrides:

flushBuffer in class javax.servlet.ServletResponseWrapper

Throws:

java.io.IOException

See Also:

ServletResponse.flushBuffer()

isCommitted

public boolean isCommitted()

Method isCommitted.

Specified by:

isCommitted in interface javax.servlet.ServletResponse

Overrides:

isCommitted in class javax.servlet.ServletResponseWrapper

Returns:

boolean

See Also:

ServletResponse.isCommitted()

reset

public void reset()

Method reset.

Specified by:

reset in interface javax.servlet.ServletResponse

Overrides:

reset in class javax.servlet.ServletResponseWrapper

See Also:

ServletResponse.reset()

resetBuffer

public void resetBuffer()

Method resetBuffer.

Specified by:

resetBuffer in interface javax.servlet.ServletResponse

Overrides:

resetBuffer in class javax.servlet.ServletResponseWrapper

See Also:

ServletResponse.resetBuffer()

setLocale

public void setLocale(java.util.Locale loc)

Method setLocale.

Specified by:

setLocale in interface javax.servlet.ServletResponse

Overrides:

setLocale in class javax.servlet.ServletResponseWrapper

Parameters:

loc -

See Also:

ServletResponse.setLocale(java.util.Locale)

getLocale

public java.util.Locale getLocale()

Method getLocale.

Specified by:

getLocale in interface javax.servlet.ServletResponse

Overrides:

getLocale in class javax.servlet.ServletResponseWrapper

Returns:

Locale

See Also:

ServletResponse.getLocale()

toString

public java.lang.String toString()

Method toString.

Overrides:

toString in class java.lang.Object

Returns:

String

toByteArray

public byte[] toByteArray()

Method toByteArray.

Returns:

byte[]