org.jboss.portal.server
Interface PortalResponse

All Superinterfaces:

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

All Known Implementing Classes:

PortalResponseImpl

public interface PortalResponse
extends javax.servlet.http.HttpServletResponse

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

Method Summary

java.lang.String	createURL(ServerURL url)
java.lang.String	createURL(ServerURL url, java.lang.Boolean wantAuthenticated, java.lang.Boolean wantSecure) Creates an URL targetting the specified object.

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

Method Detail

createURL

java.lang.String createURL(ServerURL url)

Parameters:

url - the portal url to encode

Returns:

the url

See Also:

createURL(ServerURL,Boolean,Boolean)

createURL

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

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.

Parameters:

url - the server url to encode

wantAuthenticated -

wantSecure -

Returns:

the url

Throws:

java.lang.IllegalArgumentException - if the url is null