lumis.lptf.portal.serviceinterface
Class MockServiceInterfaceRenderResponse

java.lang.Object
  lumis.lptf.portal.serviceinterface.MockServiceInterfaceRenderResponse

All Implemented Interfaces:

MimeResponse, PortletResponse, RenderResponse, IMockServiceInterfaceRenderResponse, IMockServiceInterfaceResponse, IServiceInterfaceRenderResponse, IServiceInterfaceResponse, IURLFactory

public class MockServiceInterfaceRenderResponse
extends java.lang.Object
implements IMockServiceInterfaceRenderResponse

Implementation for IMockServiceInterfaceRenderResponse interface.

Since:

5.6.0

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

Constructor Summary

MockServiceInterfaceRenderResponse(IServiceInterfaceRenderRequest renderRequest)

Method Summary

void	addCookie(javax.servlet.http.Cookie cookie)
void	addProperty(javax.servlet.http.Cookie arg0)
void	addProperty(java.lang.String arg0, org.w3c.dom.Element arg1)
void	addProperty(java.lang.String key, java.lang.String value)
void	applyStyle(int applyRule, java.lang.String styleFile)
IServiceInterfaceUrl	createActionURL() Creates an action URL.
org.w3c.dom.Element	createElement(java.lang.String arg0)
IServiceInterfaceUrl	createPortalURL() Creates a URL for accessing a portal page.
IServiceInterfaceUrl	createRenderURL() Creates a render URL.
ResourceURL	createResourceURL()
void	deleteCookie(javax.servlet.http.Cookie cookie)
java.lang.String	encodeURL(java.lang.String path)
void	flushBuffer()
PortalPrintWriter	getBeforeWriter()
java.lang.String	getBeforeWriterOutput() Returns the output written to IServiceInterfaceRenderResponse.getBeforeWriter().
int	getBufferSize()
CacheControl	getCacheControl()
java.lang.String	getCharacterEncoding()
java.lang.String	getContentType()
java.util.Map<java.lang.String,javax.servlet.http.Cookie>	getCookieMap() Returns a map containing the cookies set in this response.
java.util.Locale	getLocale()
java.lang.String	getNamespace()
java.io.OutputStream	getPortletOutputStream()
int	getStyleApplyRule() Returns the style apply rule set by the call to IServiceInterfaceRenderResponse.applyStyle(int, String).
java.lang.String	getStyleFile() Returns the file path set by the call to IServiceInterfaceRenderResponse.applyStyle(int, String).
java.lang.String	getStyleId() Returns the styleId set by a call to the IServiceInterfaceRenderResponse.setStyleId(String) method.
java.lang.String	getTitle() Returns the title set by RenderResponse.setTitle(String).
PortalPrintWriter	getWriter()
java.lang.String	getWriterOutput() Returns the output written to IServiceInterfaceRenderResponse.getWriter().
boolean	isCommited() Deprecated.
boolean	isCommitted()
void	reset()
void	resetBuffer()
void	setBufferSize(int bufferSize)
void	setContentType(java.lang.String contentType)
void	setLocale(java.util.Locale locale) Sets the locale returned by MimeResponse.getLocale().
void	setNamespace(java.lang.String namespace) Sets the namespace string returned by PortletResponse.getNamespace().
void	setNextPossiblePortletModes(java.util.Collection<PortletMode> portletModes)
void	setProperty(java.lang.String key, java.lang.String value)
void	setStyleId(java.lang.String styleId)
void	setTitle(java.lang.String title)

Methods inherited from class java.lang.Object

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

Constructor Detail

MockServiceInterfaceRenderResponse

public MockServiceInterfaceRenderResponse(IServiceInterfaceRenderRequest renderRequest)

Method Detail

addCookie

public void addCookie(javax.servlet.http.Cookie cookie)

Specified by:

addCookie in interface IServiceInterfaceResponse

addProperty

public void addProperty(javax.servlet.http.Cookie arg0)

Specified by:

addProperty in interface PortletResponse

addProperty

public void addProperty(java.lang.String arg0,
                        org.w3c.dom.Element arg1)

Specified by:

addProperty in interface PortletResponse

addProperty

public void addProperty(java.lang.String key,
                        java.lang.String value)

Specified by:

addProperty in interface PortletResponse

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 org.w3c.dom.Element createElement(java.lang.String arg0)
                                  throws org.w3c.dom.DOMException

Specified by:

createElement in interface PortletResponse

Throws:

org.w3c.dom.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)

deleteCookie

public void deleteCookie(javax.servlet.http.Cookie cookie)

Specified by:

deleteCookie in interface IServiceInterfaceResponse

encodeURL

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

Specified by:

encodeURL in interface PortletResponse

getCookieMap

public java.util.Map<java.lang.String,javax.servlet.http.Cookie> getCookieMap()

Description copied from interface: IMockServiceInterfaceResponse

Returns a map containing the cookies set in this response.

Specified by:

getCookieMap in interface IMockServiceInterfaceResponse

Returns:

the map with the cookies. The key is the cookie name and the value is the cookie object.

See Also:

IServiceInterfaceResponse.addCookie(Cookie), IServiceInterfaceResponse.deleteCookie(Cookie)

getNamespace

public java.lang.String getNamespace()

Specified by:

getNamespace in interface PortletResponse

setNamespace

public void setNamespace(java.lang.String namespace)

Description copied from interface: IMockServiceInterfaceResponse

Sets the namespace string returned by PortletResponse.getNamespace().

Specified by:

setNamespace in interface IMockServiceInterfaceResponse

Parameters:

namespace - the namespace.

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)

Specified by:

setProperty in interface PortletResponse

createResourceURL

public ResourceURL createResourceURL()

Specified by:

createResourceURL in interface MimeResponse

flushBuffer

public void flushBuffer()

Specified by:

flushBuffer in interface MimeResponse

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface MimeResponse

getCacheControl

public CacheControl getCacheControl()

Specified by:

getCacheControl in interface MimeResponse

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface MimeResponse

getWriterOutput

public java.lang.String getWriterOutput()
                                 throws java.io.UnsupportedEncodingException

Description copied from interface: IMockServiceInterfaceRenderResponse

Returns the output written to IServiceInterfaceRenderResponse.getWriter().

Specified by:

getWriterOutput in interface IMockServiceInterfaceRenderResponse

Returns:

the output as a string.

Throws:

java.io.UnsupportedEncodingException

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface MimeResponse

getLocale

public java.util.Locale getLocale()

Specified by:

getLocale in interface MimeResponse

getPortletOutputStream

public java.io.OutputStream getPortletOutputStream()
                                            throws java.io.IOException

Specified by:

getPortletOutputStream in interface MimeResponse

Throws:

java.io.IOException

getTitle

public java.lang.String getTitle()

Description copied from interface: IMockServiceInterfaceRenderResponse

Returns the title set by RenderResponse.setTitle(String).

Specified by:

getTitle in interface IMockServiceInterfaceRenderResponse

Returns:

the title.

getWriter

public PortalPrintWriter getWriter()
                            throws java.io.UnsupportedEncodingException

Specified by:

getWriter in interface MimeResponse

Specified by:

getWriter in interface IServiceInterfaceRenderResponse

Throws:

java.io.UnsupportedEncodingException

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 bufferSize)

Specified by:

setBufferSize in interface MimeResponse

setContentType

public void setContentType(java.lang.String contentType)

Specified by:

setContentType in interface MimeResponse

Specified by:

setContentType in interface RenderResponse

setLocale

public void setLocale(java.util.Locale locale)

Description copied from interface: IMockServiceInterfaceRenderResponse

Sets the locale returned by MimeResponse.getLocale().

Specified by:

setLocale in interface IMockServiceInterfaceRenderResponse

Parameters:

locale - the locale.

setNextPossiblePortletModes

public void setNextPossiblePortletModes(java.util.Collection<PortletMode> portletModes)

Specified by:

setNextPossiblePortletModes in interface RenderResponse

setTitle

public void setTitle(java.lang.String title)

Specified by:

setTitle in interface RenderResponse

applyStyle

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

Specified by:

applyStyle in interface IServiceInterfaceRenderResponse

Throws:

ServiceException

PortalException

getBeforeWriterOutput

public java.lang.String getBeforeWriterOutput()
                                       throws java.io.IOException

Description copied from interface: IMockServiceInterfaceRenderResponse

Returns the output written to IServiceInterfaceRenderResponse.getBeforeWriter().

Specified by:

getBeforeWriterOutput in interface IMockServiceInterfaceRenderResponse

Returns:

the output as a string.

Throws:

java.io.IOException - if an error occur getting the writer.

getBeforeWriter

public PortalPrintWriter getBeforeWriter()
                                  throws java.io.IOException

Specified by:

getBeforeWriter in interface IServiceInterfaceRenderResponse

Throws:

java.io.IOException

isCommited

@Deprecated
public boolean isCommited()

Deprecated.

Specified by:

isCommited in interface IServiceInterfaceRenderResponse

setStyleId

public void setStyleId(java.lang.String styleId)
                throws ServiceException,
                       PortalException

Specified by:

setStyleId in interface IServiceInterfaceRenderResponse

Throws:

ServiceException

PortalException

getStyleId

public java.lang.String getStyleId()

Description copied from interface: IMockServiceInterfaceRenderResponse

Returns the styleId set by a call to the IServiceInterfaceRenderResponse.setStyleId(String) method.

Specified by:

getStyleId in interface IMockServiceInterfaceRenderResponse

Returns:

the style id.

getStyleFile

public java.lang.String getStyleFile()

Description copied from interface: IMockServiceInterfaceRenderResponse

Returns the file path set by the call to IServiceInterfaceRenderResponse.applyStyle(int, String).

Specified by:

getStyleFile in interface IMockServiceInterfaceRenderResponse

Returns:

the style file path set.

getStyleApplyRule

public int getStyleApplyRule()

Description copied from interface: IMockServiceInterfaceRenderResponse

Returns the style apply rule set by the call to IServiceInterfaceRenderResponse.applyStyle(int, String). See the APPLY_* constants for possible values.

Specified by:

getStyleApplyRule in interface IMockServiceInterfaceRenderResponse

Returns:

the style apply rule.