net.sf.jportlet.impl
Class PortletResponseImpl

java.lang.Object
  |
  +--javax.servlet.ServletResponseWrapper
        |
        +--javax.servlet.http.HttpServletResponseWrapper
              |
              +--net.sf.jportlet.impl.PortletResponseImpl
All Implemented Interfaces:
javax.servlet.http.HttpServletResponse, PortletResponse, javax.servlet.ServletResponse

public class PortletResponseImpl
extends javax.servlet.http.HttpServletResponseWrapper
implements PortletResponse

Implementation of PortletResponse

Author:
Herve Tchepannou

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
PortletResponseImpl(net.sf.jportlet.portlet.application.PortletProxy proxy, net.sf.jportlet.impl.PortletRequestImpl portletRequest, javax.servlet.http.HttpServletResponse httpResponse)
           
 
Method Summary
 net.sf.jportlet.portlet.PortletURI createURI()
          Creates a portlet URI pointing to the current portlet mode.
 net.sf.jportlet.portlet.PortletURI createURI(Portlet.Mode mode, PortletWindow.State state)
          Create a portlet URI pointing to the current portlet for a given mode and state.
 net.sf.jportlet.portlet.PortletURI createURI(java.lang.String action)
          Create a portlet URI for executing an action
 java.lang.String encodeNamespace(java.lang.String name)
          Maps the given string value into this portlet's namespace.
 java.lang.String encodeURL(java.lang.String path)
          Returns the encoded URI of the resource at the given path.
 java.lang.StringBuffer getBuffer()
           
 javax.servlet.http.HttpServletResponse getHttpResponse()
           
 net.sf.jportlet.portlet.application.PortletProxy getProxy()
           
 java.io.PrintWriter getWriter()
           
 
Methods inherited from class javax.servlet.http.HttpServletResponseWrapper
addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, sendError, sendError, sendRedirect, setDateHeader, setHeader, setIntHeader, setStatus, setStatus
 
Methods inherited from class javax.servlet.ServletResponseWrapper
flushBuffer, getBufferSize, getCharacterEncoding, getLocale, getOutputStream, getResponse, isCommitted, reset, resetBuffer, setBufferSize, 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 javax.servlet.http.HttpServletResponse
addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, sendError, sendError, sendRedirect, setDateHeader, setHeader, setIntHeader, setStatus, setStatus
 
Methods inherited from interface javax.servlet.ServletResponse
flushBuffer, getBufferSize, getCharacterEncoding, getLocale, getOutputStream, isCommitted, reset, resetBuffer, setBufferSize, setContentLength, setContentType, setLocale
 

Constructor Detail

PortletResponseImpl

public PortletResponseImpl(net.sf.jportlet.portlet.application.PortletProxy proxy,
                           net.sf.jportlet.impl.PortletRequestImpl portletRequest,
                           javax.servlet.http.HttpServletResponse httpResponse)
Method Detail

createURI

public net.sf.jportlet.portlet.PortletURI createURI()
Description copied from interface: PortletResponse
Creates a portlet URI pointing to the current portlet mode. The returned URI can be further extended by adding portlet-specific parameters, action and mode

Specified by:
createURI in interface PortletResponse
Returns:
PortletURI
See Also:
PortletResponse.createURI()

createURI

public net.sf.jportlet.portlet.PortletURI createURI(Portlet.Mode mode,
                                                    PortletWindow.State state)
Description copied from interface: PortletResponse
Create a portlet URI pointing to the current portlet for a given mode and state.

Specified by:
createURI in interface PortletResponse
Parameters:
mode - Portlet mode
state - Portlet state
Returns:
PortletURI
See Also:
PortletResponse.createURI(net.sf.jportlet.portlet.Portlet.Mode, net.sf.jportlet.portlet.PortletWindow.State)

createURI

public net.sf.jportlet.portlet.PortletURI createURI(java.lang.String action)
Description copied from interface: PortletResponse
Create a portlet URI for executing an action

Specified by:
createURI in interface PortletResponse
Parameters:
action - action to execute
Returns:
PortletURI
See Also:
PortletResponse.createURI(java.lang.String)

encodeNamespace

public java.lang.String encodeNamespace(java.lang.String name)
Description copied from interface: PortletResponse
Maps the given string value into this portlet's namespace. Should be applied to every variable or name used in the output stream. For example, a parameter used in a form, or a function name in javascript

Specified by:
encodeNamespace in interface PortletResponse
Parameters:
name -
Returns:
String
See Also:
PortletResponse.encodeNamespace(java.lang.String)

encodeURL

public java.lang.String encodeURL(java.lang.String path)
Description copied from interface: PortletResponse
Returns the encoded URI of the resource at the given path. Encoding may include prefixing, conversion to absolute URL, etc. To generate unprotected URI's like an image use the direct path inside of you portlet (e.g. /myportlet/myimage.gif). Otherwise, to generate protected URI's like a property file use the path inside of your portlet prefixed with /WEB-INF/ (e.g. /WEB-INF/myportlet/myportlet.jsp)

Specified by:
encodeURL in interface PortletResponse
Overrides:
encodeURL in class javax.servlet.http.HttpServletResponseWrapper
See Also:
HttpServletResponse.encodeURL(java.lang.String)

getBuffer

public java.lang.StringBuffer getBuffer()

getHttpResponse

public javax.servlet.http.HttpServletResponse getHttpResponse()
Returns:
HttpServletResponse

getProxy

public net.sf.jportlet.portlet.application.PortletProxy getProxy()
Returns:
PortletProxy

getWriter

public java.io.PrintWriter getWriter()
Specified by:
getWriter in interface javax.servlet.ServletResponse
Overrides:
getWriter in class javax.servlet.ServletResponseWrapper
See Also:
ServletResponse.getWriter()


Copyright © 2002 Herve Tchepannou. All Rights Reserved.