atg.portal.servlet
Interface PortalServletResponse

All Superinterfaces:

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

All Known Subinterfaces:

GearServletResponse

public interface PortalServletResponse
extends javax.servlet.http.HttpServletResponse

The portal response object encapsulates all information destined to a portal client

Field Summary

static java.lang.String

CLASS_VERSION Class version string

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

Method Summary

java.lang.String	encodePortalURL(java.lang.String pURL) Encodes a return portal url, encoding session id and portal specific parameters
java.lang.String	encodePortalURL(java.lang.String pURL, PortalContext pPortalContext) Encodes a portal url with specified portal context
PortalServletRequest	getPortalServletRequest() Access the portal servlet request

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

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

getPortalServletRequest

PortalServletRequest getPortalServletRequest()

Access the portal servlet request

Returns:

a portal servlet request

See Also:

PortalServletRequest

encodePortalURL

java.lang.String encodePortalURL(java.lang.String pURL,
                                 PortalContext pPortalContext)

Encodes a portal url with specified portal context

Parameters:

pURL - a url

pPortalContext - the portal context

Returns:

the encoded URL if encoding is needed; the unchanged URL otherwise.

encodePortalURL

java.lang.String encodePortalURL(java.lang.String pURL)

Encodes a return portal url, encoding session id and portal specific parameters

Parameters:

pURL - a url

Returns:

the encoded URL if encoding is needed; the unchanged URL otherwise.