net.sf.jportlet.portlet
Interface PortletResponse

All Superinterfaces:

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

All Known Implementing Classes:

PortletResponseImpl

public interface PortletResponse

extends javax.servlet.http.HttpServletResponse

The PortletResponse interface represents the response sent to the client device. It is up to the portlet container to enhance, extend, or modify the response as required before it is actually sent to the client device.

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

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 url) Returns the encoded URI of the resource at the given path.

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

Method Detail

createURI

public net.sf.jportlet.portlet.PortletURI createURI()

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

Returns:

PortletURI

createURI

public net.sf.jportlet.portlet.PortletURI createURI(java.lang.String action)

Create a portlet URI for executing an action

Parameters:

action - action to execute

Returns:

PortletURI

createURI

public 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.

Parameters:

mode - Portlet mode

state - Portlet state

Returns:

PortletURI

encodeNamespace

public java.lang.String encodeNamespace(java.lang.String name)

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

Parameters:

name -

Returns:

String

encodeURL

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

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 javax.servlet.http.HttpServletResponse

See Also:

HttpServletResponse.encodeURL(String)