org.jboss.portal.web.impl
Class AbstractWebResponse

java.lang.Object
  javax.servlet.ServletResponseWrapper
      javax.servlet.http.HttpServletResponseWrapper
          org.jboss.portal.web.impl.AbstractWebResponse

All Implemented Interfaces:

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

Direct Known Subclasses:

EndPointResponse

public abstract class AbstractWebResponse
extends javax.servlet.http.HttpServletResponseWrapper
implements WebResponse

todo

Version:

$Revision: 1.1 $

Author:

Julien Viet

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

AbstractWebResponse(javax.servlet.http.HttpServletResponse resp)

Method Summary

void

renderURL(java.io.Writer writer, java.lang.String path, java.util.Map<java.lang.String,java.lang.String[]> parameters, org.jboss.portal.common.servlet.URLFormat wantedURLFormat) The implementation renders the URL by delegating to the WebResponse.renderURL(String, java.util.Map, org.jboss.portal.common.servlet.URLFormat) methods and then prints it in the specified writer.

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, sendError, sendError, sendRedirect, setDateHeader, setHeader, setIntHeader, setStatus, setStatus

Methods inherited from class javax.servlet.ServletResponseWrapper

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getResponse, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale, setResponse

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.portal.web.WebResponse

renderURL

Methods inherited from interface javax.servlet.http.HttpServletResponse

addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, sendError, sendError, sendRedirect, setDateHeader, setHeader, setIntHeader, setStatus, setStatus

Methods inherited from interface javax.servlet.ServletResponse

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale

Constructor Detail

AbstractWebResponse

public AbstractWebResponse(javax.servlet.http.HttpServletResponse resp)

Method Detail

renderURL

public void renderURL(java.io.Writer writer,
                      java.lang.String path,
                      java.util.Map<java.lang.String,java.lang.String[]> parameters,
                      org.jboss.portal.common.servlet.URLFormat wantedURLFormat)
               throws java.lang.IllegalArgumentException,
                      java.io.IOException

The implementation renders the URL by delegating to the WebResponse.renderURL(String, java.util.Map, org.jboss.portal.common.servlet.URLFormat) methods and then prints it in the specified writer. The method can be overriden in order to provide a customized implementation.

Specified by:

renderURL in interface WebResponse

Parameters:

writer - the writer

path - the path relative to the web context

parameters - the optional parameter map

wantedURLFormat - the url format needed

Throws:

java.lang.IllegalArgumentException - if the path value is not correct or the write is null or the parameter map is corrupted

java.io.IOException - any IOException thrown by the writer

See Also:

WebResponse.renderURL(String, java.util.Map, org.jboss.portal.common.servlet.URLFormat)