lumis.portal.servicecontainer

Class ServiceContainerActionResponse

java.lang.Object

javax.servlet.ServletResponseWrapper

javax.servlet.http.HttpServletResponseWrapper

lumis.portal.servicecontainer.ServiceContainerResponse

lumis.portal.servicecontainer.ServiceContainerActionResponse

All Implemented Interfaces:

ActionResponse, PortletResponse, StateAwareResponse, HttpServletResponse, ServletResponse, IServiceInterfaceActionResponse, IServiceInterfaceActionResponseSPI, IServiceInterfaceResponse, IURLFactory

public class ServiceContainerActionResponse
extends ServiceContainerResponse
implements IServiceInterfaceActionResponseSPI, ActionResponse

Since:

4.0.0

Version:

$Revision: 17047 $ $Date: 2015-03-03 14:22:22 +0000 (Tue, 03 Mar 2015) $

Field Summary

Fields inherited from class lumis.portal.servicecontainer.ServiceContainerResponse

pageConfig, serviceContainerHttpServletResponse, serviceContainerRequest, serviceInterfaceInstanceId

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

Constructors

Constructor and Description
ServiceContainerActionResponse(ServiceContainerRequest request, HttpServletResponse httpServletResponse)

Method Summary

Modifier and Type	Method and Description
PortletMode	getPortletMode()
String	getRedirectDestination()
String[]	getRenderParameter(String key) Deprecated.
Map<String,String[]>	getRenderParameterMap()
Map<String,String[]>	getRenderParameters() Deprecated.
int	getStatusCode() Returns the status code
String	getStatusMessage() Returns the status message
WindowState	getWindowState()
boolean	isRedirectSet()
void	removePublicRenderParameter(String arg0)
void	sendRedirect(String location)
void	sendRedirect(String arg0, String arg1)
void	setEvent(QName arg0, Serializable arg1)
void	setEvent(String arg0, Serializable arg1)
void	setPortletMode(PortletMode portletMode)
void	setRenderParameter(String key, String value)
void	setRenderParameter(String key, String[] value)
void	setRenderParameters(Map<String,String[]> parameters)
void	setStatusInternal(int statusCode, String message) Sets the status code and message for this action response.
void	setWindowState(WindowState windowState)

Methods inherited from class lumis.portal.servicecontainer.ServiceContainerResponse

addProperty, addProperty, addProperty, createActionURL, createElement, createPortalURL, createRenderURL, createServiceInterfaceURL, deleteCookie, encodeURL, getNamespace, getServiceContainerHttpServletResponse, setNamespace, setPageWebResource, setProperty, setServiceInterfaceInstanceId

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, getHeader, getHeaderNames, getHeaders, getStatus, sendError, sendError, setDateHeader, setHeader, setIntHeader, setStatus, setStatus

Methods inherited from class javax.servlet.ServletResponseWrapper

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getResponse, getWriter, isCommitted, isWrapperFor, isWrapperFor, reset, resetBuffer, setBufferSize, setCharacterEncoding, 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 lumis.portal.serviceinterface.IServiceInterfaceResponse

addCookie, deleteCookie

Methods inherited from interface lumis.portal.url.IURLFactory

createActionURL, createPortalURL, createRenderURL

Methods inherited from interface javax.portlet.PortletResponse

addProperty, addProperty, addProperty, createElement, encodeURL, getNamespace, setProperty

Methods inherited from interface javax.servlet.ServletResponse

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale

Constructor Detail

ServiceContainerActionResponse

public ServiceContainerActionResponse(ServiceContainerRequest request,
                                      HttpServletResponse httpServletResponse)

Parameters:

httpServletResponse -

Method Detail

sendRedirect

public void sendRedirect(String location)
                  throws IOException

Specified by:

sendRedirect in interface ActionResponse

Specified by:

sendRedirect in interface HttpServletResponse

Overrides:

sendRedirect in class HttpServletResponseWrapper

Throws:

IOException

isRedirectSet

public boolean isRedirectSet()

getRedirectDestination

public String getRedirectDestination()

setRenderParameter

public void setRenderParameter(String key,
                               String value)

Specified by:

setRenderParameter in interface StateAwareResponse

setRenderParameter

public void setRenderParameter(String key,
                               String[] value)

Specified by:

setRenderParameter in interface StateAwareResponse

setRenderParameters

public void setRenderParameters(Map<String,String[]> parameters)

Specified by:

setRenderParameters in interface StateAwareResponse

getRenderParameter

@Deprecated
public String[] getRenderParameter(String key)

Deprecated.

Description copied from interface: IServiceInterfaceActionResponse

Returns the parameter previously set by the setRenderParameter methods. This method is usually used by chained process actions that need to read previously set render parameters.

Specified by:

getRenderParameter in interface IServiceInterfaceActionResponse

Returns:

getRenderParameters

@Deprecated
public Map<String,String[]> getRenderParameters()

Deprecated.

Description copied from interface: IServiceInterfaceActionResponse

Returns all the parameters previously set by the setRenderParameter methods. This method is usually used by chained process actions that need to read previously set render parameters.

Specified by:

getRenderParameters in interface IServiceInterfaceActionResponse

Returns:

setPortletMode

public void setPortletMode(PortletMode portletMode)
                    throws PortletModeException

Specified by:

setPortletMode in interface StateAwareResponse

Throws:

PortletModeException

setWindowState

public void setWindowState(WindowState windowState)
                    throws WindowStateException

Specified by:

setWindowState in interface StateAwareResponse

Throws:

WindowStateException

sendRedirect

public void sendRedirect(String arg0,
                         String arg1)
                  throws IOException

Specified by:

sendRedirect in interface ActionResponse

Throws:

IOException

getPortletMode

public PortletMode getPortletMode()

Specified by:

getPortletMode in interface StateAwareResponse

getRenderParameterMap

public Map<String,String[]> getRenderParameterMap()

Specified by:

getRenderParameterMap in interface StateAwareResponse

getWindowState

public WindowState getWindowState()

Specified by:

getWindowState in interface StateAwareResponse

removePublicRenderParameter

public void removePublicRenderParameter(String arg0)

Specified by:

removePublicRenderParameter in interface StateAwareResponse

setEvent

public void setEvent(QName arg0,
                     Serializable arg1)

Specified by:

setEvent in interface StateAwareResponse

setEvent

public void setEvent(String arg0,
                     Serializable arg1)

Specified by:

setEvent in interface StateAwareResponse

setStatusInternal

public void setStatusInternal(int statusCode,
                              String message)

Sets the status code and message for this action response. This is a temporary implementation that is used exclusively for requests with accept: application/json header. This code and message will be returned in the http response headers in this case. The final support for setting response status will be available in the future.

Specified by:

setStatusInternal in interface IServiceInterfaceActionResponseSPI

Parameters:

statusCode - the status code for the response

message - the message

Since:

8.0.0

getStatusCode

public int getStatusCode()

Returns the status code

Returns:

the response status code

Since:

8.0.0

getStatusMessage

public String getStatusMessage()

Returns the status message

Returns:

the status message

Since:

8.0.0