lumis.portal.serviceinterface

Class ServiceInterfaceRenderResponseSPIWrapper

java.lang.Object

lumis.portal.serviceinterface.ServiceInterfaceRenderResponseSPIWrapper

All Implemented Interfaces:

MimeResponse, PortletResponse, RenderResponse, IServiceInterfaceRenderResponse, IServiceInterfaceRenderResponseSPI, IServiceInterfaceResponse, IURLFactory

Direct Known Subclasses:

BufferedServiceInterfaceRenderResponseSPI

public class ServiceInterfaceRenderResponseSPIWrapper
extends Object
implements IServiceInterfaceRenderResponseSPI

Provides a convenient implementation of the IServiceInterfaceRenderResponseSPI interface that can be subclassed by developers wishing to adapt the request to a Servlet. This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped request object.

Since:

7.0.0

Version:

$Revision: 17104 $ $Date: 2015-03-17 21:18:33 +0000 (Tue, 17 Mar 2015) $

Field Summary

Fields inherited from interface lumis.portal.serviceinterface.IServiceInterfaceRenderResponse

APPLY_STYLE_FROM_DEFINITION, APPLY_STYLE_NONE, APPLY_STYLE_ONLY_IF_NOT_DEFINED, APPLY_STYLE_OVERRIDE

Fields inherited from interface javax.portlet.MimeResponse

CACHE_SCOPE, ETAG, EXPIRATION_CACHE, MARKUP_HEAD_ELEMENT, NAMESPACED_RESPONSE, PRIVATE_SCOPE, PUBLIC_SCOPE, USE_CACHED_CONTENT

Method Summary

Modifier and Type	Method and Description
void	addCookie(Cookie cookie)
void	addProperty(Cookie cookie)
void	addProperty(String key, Element element)
void	addProperty(String key, String value)
void	applyStyle(int applyRule, String styleFile)
IServiceInterfaceUrl	createActionURL() Creates an action URL.
Element	createElement(String tagName)
IServiceInterfaceUrl	createPortalURL() Creates a URL for accessing a portal page.
IServiceInterfaceUrl	createRenderURL() Creates a render URL.
ResourceURL	createResourceURL()
void	deleteCookie(Cookie cookie)
String	encodeURL(String path)
void	flushBuffer()
PortalPrintWriter	getBeforeWriter()
int	getBufferSize()
CacheControl	getCacheControl()
String	getCharacterEncoding()
String	getContentType()
Locale	getLocale()
String	getNamespace()
OutputStream	getPortletOutputStream()
IServiceInterfaceRenderResponseSPI	getResponse() Returns the wrapped response.
String	getResponseString() Returns this response's output string.
ServiceContainerHttpServletResponse	getServiceContainerHttpServletResponse() Returns the ServiceContainerHttpServletResponse.
PrintWriter	getWriter()
boolean	isCommited()
boolean	isCommitted()
void	reset()
void	resetBuffer()
void	setBufferSize(int size)
void	setContentType(String type)
void	setNextPossiblePortletModes(Collection<PortletMode> portletModes)
void	setProperty(String key, String value)
void	setResponse(IServiceInterfaceRenderResponseSPI response) Sets the wrapped response.
void	setStyleId(String styleId)
void	setTitle(String title)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getResponse

public IServiceInterfaceRenderResponseSPI getResponse()

Returns the wrapped response.

Returns:

IServiceInterfaceRenderResponseSPI the wrapped response

Since:

7.0.0

setResponse

public void setResponse(IServiceInterfaceRenderResponseSPI response)

Sets the wrapped response.

Parameters:

IServiceInterfaceRenderResponseSPI - wrapped response

Since:

7.0.0

addCookie

public void addCookie(Cookie cookie)

Specified by:

addCookie in interface IServiceInterfaceResponse

addProperty

public void addProperty(Cookie cookie)

Specified by:

addProperty in interface PortletResponse

addProperty

public void addProperty(String key,
                        Element element)

Specified by:

addProperty in interface PortletResponse

addProperty

public void addProperty(String key,
                        String value)

Specified by:

addProperty in interface PortletResponse

applyStyle

public void applyStyle(int applyRule,
                       String styleFile)
                throws ServiceException,
                       PortalException

Specified by:

applyStyle in interface IServiceInterfaceRenderResponse

Throws:

ServiceException

PortalException

createActionURL

public IServiceInterfaceUrl createActionURL()

Description copied from interface: IURLFactory

Creates an action URL.

Specified by:

createActionURL in interface MimeResponse

Specified by:

createActionURL in interface IServiceInterfaceRenderResponse

Specified by:

createActionURL in interface IURLFactory

Returns:

the URL object.

See Also:

IServiceInterface.processAction(lumis.portal.serviceinterface.IServiceInterfaceActionRequest, lumis.portal.serviceinterface.IServiceInterfaceActionResponse)

createElement

public Element createElement(String tagName)
                      throws DOMException

Specified by:

createElement in interface PortletResponse

Throws:

DOMException

createPortalURL

public IServiceInterfaceUrl createPortalURL()

Description copied from interface: IURLFactory

Creates a URL for accessing a portal page.

The returned URL object will not have its destination specified, so it will refer to the portal home by default. Its methods may be used to specify the URL destination.

Specified by:

createPortalURL in interface IURLFactory

Returns:

the URL object.

See Also:

IServiceInterfaceUrl.setPageId(String), IServiceInterfaceUrl.setChannelId(String)

createRenderURL

public IServiceInterfaceUrl createRenderURL()

Description copied from interface: IURLFactory

Creates a render URL.

Specified by:

createRenderURL in interface MimeResponse

Specified by:

createRenderURL in interface IServiceInterfaceRenderResponse

Specified by:

createRenderURL in interface IURLFactory

Returns:

the URL object.

See Also:

IServiceInterface.render(lumis.portal.serviceinterface.IServiceInterfaceRenderRequest, lumis.portal.serviceinterface.IServiceInterfaceRenderResponse)

createResourceURL

public ResourceURL createResourceURL()

Specified by:

createResourceURL in interface MimeResponse

deleteCookie

public void deleteCookie(Cookie cookie)

Specified by:

deleteCookie in interface IServiceInterfaceResponse

encodeURL

public String encodeURL(String path)

Specified by:

encodeURL in interface PortletResponse

flushBuffer

public void flushBuffer()
                 throws IOException

Specified by:

flushBuffer in interface MimeResponse

Throws:

IOException

getBeforeWriter

public PortalPrintWriter getBeforeWriter()
                                  throws IOException

Specified by:

getBeforeWriter in interface IServiceInterfaceRenderResponse

Throws:

IOException

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface MimeResponse

getCacheControl

public CacheControl getCacheControl()

Specified by:

getCacheControl in interface MimeResponse

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface MimeResponse

getContentType

public String getContentType()

Specified by:

getContentType in interface MimeResponse

getLocale

public Locale getLocale()

Specified by:

getLocale in interface MimeResponse

getNamespace

public String getNamespace()

Specified by:

getNamespace in interface PortletResponse

getPortletOutputStream

public OutputStream getPortletOutputStream()
                                    throws IOException

Specified by:

getPortletOutputStream in interface MimeResponse

Throws:

IOException

getWriter

public PrintWriter getWriter()
                      throws IOException

Specified by:

getWriter in interface MimeResponse

Specified by:

getWriter in interface IServiceInterfaceRenderResponse

Throws:

IOException

isCommited

public boolean isCommited()

Specified by:

isCommited in interface IServiceInterfaceRenderResponse

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface MimeResponse

reset

public void reset()

Specified by:

reset in interface MimeResponse

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface MimeResponse

setBufferSize

public void setBufferSize(int size)

Specified by:

setBufferSize in interface MimeResponse

setContentType

public void setContentType(String type)

Specified by:

setContentType in interface MimeResponse

Specified by:

setContentType in interface RenderResponse

setNextPossiblePortletModes

public void setNextPossiblePortletModes(Collection<PortletMode> portletModes)

Specified by:

setNextPossiblePortletModes in interface RenderResponse

setProperty

public void setProperty(String key,
                        String value)

Specified by:

setProperty in interface PortletResponse

setStyleId

public void setStyleId(String styleId)
                throws ServiceException,
                       PortalException

Specified by:

setStyleId in interface IServiceInterfaceRenderResponse

Throws:

ServiceException

PortalException

setTitle

public void setTitle(String title)

Specified by:

setTitle in interface RenderResponse

getServiceContainerHttpServletResponse

public ServiceContainerHttpServletResponse getServiceContainerHttpServletResponse()

Description copied from interface: IServiceInterfaceRenderResponseSPI

Returns the ServiceContainerHttpServletResponse.

Specified by:

getServiceContainerHttpServletResponse in interface IServiceInterfaceRenderResponseSPI

Returns:

the ServiceContainerHttpServletResponse.

getResponseString

public String getResponseString()

Description copied from interface: IServiceInterfaceRenderResponseSPI

Returns this response's output string.

Specified by:

getResponseString in interface IServiceInterfaceRenderResponseSPI

Returns:

this response's output string.