Package lumis.collaboration.chat

Class ChatServiceInterfaceResponse

java.lang.Object

lumis.collaboration.chat.ChatServiceInterfaceResponse

All Implemented Interfaces:

javax.portlet.MimeResponse, javax.portlet.PortletResponse, javax.portlet.RenderResponse, IServiceInterfaceBaseRenderResponse, IServiceInterfaceRenderResponse, IServiceInterfaceRenderResponseSPI, IServiceInterfaceResponse, IServiceInterfaceResponseSPI, IURLFactory

public class ChatServiceInterfaceResponse
extends java.lang.Object
implements IServiceInterfaceRenderResponseSPI

Chat service interface for ChatControllerXml.

Since:

8.1.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

Constructors

Constructor	Description
ChatServiceInterfaceResponse()

Method Summary

Modifier and Type	Method	Description
void	addCookie(javax.servlet.http.Cookie cookie)
void	addProperty(java.lang.String key, java.lang.String value)
void	addProperty(java.lang.String key, org.w3c.dom.Element element)
void	addProperty(javax.servlet.http.Cookie cookie)
void	applyStyle(int applyRule, java.lang.String styleFile)
IServiceInterfaceUrl	createActionURL()	Creates an action URL.
org.w3c.dom.Element	createElement(java.lang.String tagName)
IServiceInterfaceUrl	createPortalURL()	Creates a URL for accessing a portal page.
IServiceInterfaceUrl	createRenderURL()	Creates a render URL.
javax.portlet.ResourceURL	createResourceURL()
void	deleteCookie(javax.servlet.http.Cookie cookie)
java.lang.String	encodeURL(java.lang.String path)	Returns the encoded URL of the resource, like servlets, JSPs, images and other static files, at the given path.
void	flushBuffer()
PortalPrintWriter	getBeforeWriter()
int	getBufferSize()
javax.portlet.CacheControl	getCacheControl()
java.lang.String	getCharacterEncoding()
java.lang.String	getContentType()
java.util.Locale	getLocale()
java.lang.String	getNamespace()	The value returned by this method should be prefixed or appended to elements, such as JavaScript variables or function names, to ensure they are unique in the context of the portal page.
java.io.OutputStream	getPortletOutputStream()
java.lang.String	getResponseString()	Returns this response's output string.
ServiceContainerHttpServletResponse	getServiceContainerHttpServletResponse()	Returns the ServiceContainerHttpServletResponse.
java.io.PrintWriter	getWriter()
boolean	isCommited()
boolean	isCommitted()
void	reset()
void	resetBuffer()
void	setBufferSize(int size)
void	setContentType(java.lang.String type)
void	setNextPossiblePortletModes(java.util.Collection<javax.portlet.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

ChatServiceInterfaceResponse

public ChatServiceInterfaceResponse()

Method Detail

getWriter

public java.io.PrintWriter getWriter()
                              throws java.io.IOException

Specified by:

getWriter in interface IServiceInterfaceRenderResponse

Specified by:

getWriter in interface javax.portlet.MimeResponse

Throws:

java.io.IOException

getBeforeWriter

public PortalPrintWriter getBeforeWriter()
                                  throws java.io.IOException

Specified by:

getBeforeWriter in interface IServiceInterfaceBaseRenderResponse

Throws:

java.io.IOException

isCommited

public boolean isCommited()

Specified by:

isCommited in interface IServiceInterfaceBaseRenderResponse

applyStyle

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

Specified by:

applyStyle in interface IServiceInterfaceRenderResponse

Throws:

ServiceException

PortalException

setStyleId

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

Specified by:

setStyleId in interface IServiceInterfaceRenderResponse

Throws:

ServiceException

PortalException

createActionURL

public IServiceInterfaceUrl createActionURL()

Description copied from interface: IURLFactory

Creates an action URL.

Specified by:

createActionURL in interface IServiceInterfaceRenderResponse

Specified by:

createActionURL in interface IURLFactory

Specified by:

createActionURL in interface javax.portlet.MimeResponse

Returns:

the URL object.

See Also:

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

createRenderURL

public IServiceInterfaceUrl createRenderURL()

Description copied from interface: IURLFactory

Creates a render URL.

Specified by:

createRenderURL in interface IServiceInterfaceRenderResponse

Specified by:

createRenderURL in interface IURLFactory

Specified by:

createRenderURL in interface javax.portlet.MimeResponse

Returns:

the URL object.

See Also:

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

addCookie

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

Specified by:

addCookie in interface IServiceInterfaceBaseRenderResponse

Specified by:

addCookie in interface IServiceInterfaceResponse

deleteCookie

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

Specified by:

deleteCookie in interface IServiceInterfaceBaseRenderResponse

Specified by:

deleteCookie in interface IServiceInterfaceResponse

addProperty

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

Specified by:

addProperty in interface javax.portlet.PortletResponse

addProperty

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

Specified by:

addProperty in interface javax.portlet.PortletResponse

addProperty

public void addProperty(java.lang.String key,
                        org.w3c.dom.Element element)

Specified by:

addProperty in interface javax.portlet.PortletResponse

createElement

public org.w3c.dom.Element createElement(java.lang.String tagName)
                                  throws org.w3c.dom.DOMException

Specified by:

createElement in interface javax.portlet.PortletResponse

Throws:

org.w3c.dom.DOMException

encodeURL

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

Description copied from interface: IServiceInterfaceBaseRenderResponse

Returns the encoded URL of the resource, like servlets, JSPs, images and other static files, at the given path.

Portlets should encode all resource URLs pointing to resources in the portlet application via this method in order to ensure that they get served via the portal application.

Some portal/portlet-container implementation may require those URLs to contain implementation specific data encoded in it. Because of that, portlets should use this method to create such URLs.

The encodeURL method may include the session ID and other portal/portlet-container specific information into the URL. If encoding is not needed, it returns the URL unchanged.

Portlet developer should be aware that the returned URL might not be a well formed URL but a special token at the time the portlet is generating its content. Thus portlets should not add additional parameters on the resulting URL or expect to be able to parse the URL. As a result, the outcome of the encodeURL call may be different than calling encodeURL in the servlet world.

Specified by:

encodeURL in interface IServiceInterfaceBaseRenderResponse

Specified by:

encodeURL in interface javax.portlet.PortletResponse

Parameters:

path - the URI path to the resource. This must be either an absolute URL (e.g. http://my.co/myportal/mywebap/myfolder/myresource.gif) or a full path URI (e.g. /myportal/mywebap/myfolder/myresource.gif).

Returns:

the encoded resource URL as string, may not be a valid URL

getNamespace

public java.lang.String getNamespace()

Description copied from interface: IServiceInterfaceBaseRenderResponse

The value returned by this method should be prefixed or appended to elements, such as JavaScript variables or function names, to ensure they are unique in the context of the portal page.

The namespace value must be constant for the lifetime of the portlet window.

Specified by:

getNamespace in interface IServiceInterfaceBaseRenderResponse

Specified by:

getNamespace in interface javax.portlet.PortletResponse

Returns:

the namespace

setProperty

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

Specified by:

setProperty in interface javax.portlet.PortletResponse

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)

setContentType

public void setContentType(java.lang.String type)

Specified by:

setContentType in interface javax.portlet.MimeResponse

Specified by:

setContentType in interface javax.portlet.RenderResponse

setNextPossiblePortletModes

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

Specified by:

setNextPossiblePortletModes in interface javax.portlet.RenderResponse

setTitle

public void setTitle(java.lang.String title)

Specified by:

setTitle in interface javax.portlet.RenderResponse

createResourceURL

public javax.portlet.ResourceURL createResourceURL()

Specified by:

createResourceURL in interface javax.portlet.MimeResponse

flushBuffer

public void flushBuffer()
                 throws java.io.IOException

Specified by:

flushBuffer in interface javax.portlet.MimeResponse

Throws:

java.io.IOException

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface javax.portlet.MimeResponse

getCacheControl

public javax.portlet.CacheControl getCacheControl()

Specified by:

getCacheControl in interface javax.portlet.MimeResponse

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface javax.portlet.MimeResponse

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface javax.portlet.MimeResponse

getLocale

public java.util.Locale getLocale()

Specified by:

getLocale in interface javax.portlet.MimeResponse

getPortletOutputStream

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

Specified by:

getPortletOutputStream in interface javax.portlet.MimeResponse

Throws:

java.io.IOException

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface javax.portlet.MimeResponse

reset

public void reset()

Specified by:

reset in interface javax.portlet.MimeResponse

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface javax.portlet.MimeResponse

setBufferSize

public void setBufferSize(int size)

Specified by:

setBufferSize in interface javax.portlet.MimeResponse

getServiceContainerHttpServletResponse

public ServiceContainerHttpServletResponse getServiceContainerHttpServletResponse()

Description copied from interface: IServiceInterfaceResponseSPI

Returns the ServiceContainerHttpServletResponse.

Specified by:

getServiceContainerHttpServletResponse in interface IServiceInterfaceResponseSPI

Returns:

the ServiceContainerHttpServletResponse.

getResponseString

public java.lang.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.