Package lumis.portal.serviceinterface

Interface IServiceInterfaceBaseRenderResponse

All Superinterfaces:

IURLFactory

All Known Subinterfaces:

IMockServiceInterfaceRenderResponse, IServiceInterfaceRenderResponse, IServiceInterfaceRenderResponseSPI, IServiceInterfaceRenderResultResponse

All Known Implementing Classes:

BufferedServiceInterfaceRenderResponseSPI, ChatServiceInterfaceResponse, MockServiceInterfaceRenderResponse, MockServiceInterfaceRenderResultResponse, ServiceContainerRenderResponse, ServiceInterfaceRenderResponseSPIWrapper, ServiceInterfaceRenderResultResponse

@StableMinor(version="17.1",
             sinceVersion="17.1")
public interface IServiceInterfaceBaseRenderResponse
extends IURLFactory

Base response for a render action of a given interface instance.

Since:

17.1.0

Method Summary

Modifier and Type	Method	Description
void	addCookie(javax.servlet.http.Cookie cookie)
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.
PortalPrintWriter	getBeforeWriter()
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.
boolean	isCommited()

Methods inherited from interface lumis.portal.url.IURLFactory

createActionURL, createPortalURL, createRenderURL

Method Detail

getBeforeWriter

PortalPrintWriter getBeforeWriter()
                           throws java.io.IOException

Throws:

java.io.IOException

isCommited

boolean isCommited()

addCookie

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

Parameters:

cookie -

deleteCookie

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

Parameters:

cookie -

encodeURL

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.

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.

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

Throws:

java.lang.IllegalArgumentException - if path doesn't have a leading slash or is not an absolute URL

getNamespace

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.

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

Returns:

the namespace