org.jboss.portal.server.impl.invocation
Class PortalResponseImpl

java.lang.Object
  javax.servlet.ServletResponseWrapper
      javax.servlet.http.HttpServletResponseWrapper
          org.jboss.portal.server.impl.invocation.PortalResponseImpl

All Implemented Interfaces:

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

public class PortalResponseImpl
extends javax.servlet.http.HttpServletResponseWrapper
implements PortalResponse

Field Summary

protected java.lang.String	contentType The content type.
protected InvocationImpl	invocation The invocation.
protected java.util.List	renderResults The various render results.
protected Result	targetResult The result of the target.

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

PortalResponseImpl(javax.servlet.http.HttpServletResponse resp, InvocationImpl invocation)

Method Summary

void	addRenderResult(Result result) Add the given result to the render result set.
java.lang.String	createURL(ServerURL url, boolean relative)
java.lang.String	createURL(ServerURL url, java.lang.Boolean wantAuthenticated, java.lang.Boolean wantSecure, boolean relative) Creates an URL targetting the specified object.
java.lang.String	getContentType()
java.util.Iterator	getRenderResults() Returns an iterator over the collected results.
Result	getTargetResult() Return the result of the target.
void	setContentType(java.lang.String contentType)
void	setTargetResult(Result targetResult) Set the result of the target.

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, getLocale, getOutputStream, getResponse, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setLocale, setResponse

Methods inherited from class java.lang.Object

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

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, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setLocale

Field Detail

invocation

protected InvocationImpl invocation

The invocation.

contentType

protected java.lang.String contentType

The content type.

targetResult

protected Result targetResult

The result of the target.

renderResults

protected java.util.List renderResults

The various render results.

Constructor Detail

PortalResponseImpl

public PortalResponseImpl(javax.servlet.http.HttpServletResponse resp,
                          InvocationImpl invocation)

Method Detail

createURL

public java.lang.String createURL(ServerURL url,
                                  boolean relative)

Specified by:

createURL in interface PortalResponse

Parameters:

url - the portal url to encode

Returns:

the url

See Also:

PortalResponse.createURL(ServerURL,Boolean,Boolean,boolean)

createURL

public java.lang.String createURL(ServerURL url,
                                  java.lang.Boolean wantAuthenticated,
                                  java.lang.Boolean wantSecure,
                                  boolean relative)
                           throws java.lang.IllegalArgumentException

Description copied from interface: PortalResponse

Creates an URL targetting the specified object. If wantAuthenticated is not null then it imposes wether it is authenticated ot not, otherwise it reuses the value from the request. If wantSecure is not null then it imposes wether it issecure ot not, otherwise it reuses the value from the request. If relative is set to true, then the URL is relative to the server root, otherwise the URL is absolute.

Specified by:

createURL in interface PortalResponse

Parameters:

url - the server url to encode

Returns:

the url

Throws:

java.lang.IllegalArgumentException - if the url is null

setContentType

public void setContentType(java.lang.String contentType)

Specified by:

setContentType in interface javax.servlet.ServletResponse

Overrides:

setContentType in class javax.servlet.ServletResponseWrapper

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface javax.servlet.ServletResponse

Overrides:

getContentType in class javax.servlet.ServletResponseWrapper

getTargetResult

public Result getTargetResult()

Description copied from interface: PortalResponse

Return the result of the target.

Specified by:

getTargetResult in interface PortalResponse

Returns:

the result of the target

setTargetResult

public void setTargetResult(Result targetResult)

Description copied from interface: PortalResponse

Set the result of the target.

Specified by:

setTargetResult in interface PortalResponse

Parameters:

targetResult - the result of the target

addRenderResult

public void addRenderResult(Result result)

Description copied from interface: PortalResponse

Add the given result to the render result set.

Specified by:

addRenderResult in interface PortalResponse

getRenderResults

public java.util.Iterator getRenderResults()

Description copied from interface: PortalResponse

Returns an iterator over the collected results.

Specified by:

getRenderResults in interface PortalResponse

Returns:

an iterator of the results