Package lumis.portal.servicecontainer

Class ServiceContainerResponse

java.lang.Object

javax.servlet.ServletResponseWrapper

javax.servlet.http.HttpServletResponseWrapper

lumis.portal.servicecontainer.ServiceContainerResponse

All Implemented Interfaces:

javax.portlet.PortletResponse, javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse, IServiceInterfaceResponse, IURLFactory

Direct Known Subclasses:

ServiceContainerActionResponse, ServiceContainerRenderResponse

public class ServiceContainerResponse
extends javax.servlet.http.HttpServletResponseWrapper
implements IServiceInterfaceResponse

Since:

4.0.0

Version:

$Revision$ $Date$

Field Summary

Fields

Modifier and Type	Field	Description
protected PageConfig	pageConfig
protected ServiceContainerHttpServletResponse	serviceContainerHttpServletResponse
protected ServiceContainerRequest	serviceContainerRequest
protected java.lang.String	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	Description
ServiceContainerResponse(ServiceContainerRequest request, javax.servlet.http.HttpServletResponse httpServletResponse)
ServiceContainerResponse(ServiceContainerRequest request, ServiceContainerHttpServletResponse serviceContainerHttpServletResponse)

Method Summary

Modifier and Type	Method	Description
void	addProperty(java.lang.String key, java.lang.String value)
void	addProperty(java.lang.String arg0, org.w3c.dom.Element arg1)
void	addProperty(javax.servlet.http.Cookie arg0)
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.
protected IServiceInterfaceUrl	createServiceInterfaceURL(int urlType)
void	deleteCookie(javax.servlet.http.Cookie cookie)
java.lang.String	encodeURL(java.lang.String url)
java.lang.String	getNamespace()
ServiceContainerHttpServletResponse	getServiceContainerHttpServletResponse()
void	setNamespace(java.lang.String namespace)	Sets the namespace to be used in this response.
void	setPageWebResource(PageWebResource pageWebResource)	Sets the page web resource for this response.
void	setProperty(java.lang.String key, java.lang.String value)
void	setServiceInterfaceInstanceId(java.lang.String serviceInterfaceInstanceId)

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, getHeader, getHeaderNames, getHeaders, getStatus, sendError, sendError, sendRedirect, 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

Methods inherited from interface javax.servlet.ServletResponse

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

Field Detail

serviceContainerHttpServletResponse

protected ServiceContainerHttpServletResponse serviceContainerHttpServletResponse

serviceContainerRequest

protected ServiceContainerRequest serviceContainerRequest

serviceInterfaceInstanceId

protected java.lang.String serviceInterfaceInstanceId

pageConfig

protected PageConfig pageConfig

Constructor Detail

ServiceContainerResponse

public ServiceContainerResponse(ServiceContainerRequest request,
                                javax.servlet.http.HttpServletResponse httpServletResponse)

ServiceContainerResponse

public ServiceContainerResponse(ServiceContainerRequest request,
                                ServiceContainerHttpServletResponse serviceContainerHttpServletResponse)

Method Detail

getServiceContainerHttpServletResponse

public ServiceContainerHttpServletResponse getServiceContainerHttpServletResponse()

createServiceInterfaceURL

protected IServiceInterfaceUrl createServiceInterfaceURL(int urlType)

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)

createActionURL

public IServiceInterfaceUrl createActionURL()

Description copied from interface: IURLFactory

Creates an action URL.

Specified by:

createActionURL in interface IURLFactory

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 IURLFactory

Returns:

the URL object.

See Also:

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

addProperty

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

Specified by:

addProperty in interface javax.portlet.PortletResponse

setProperty

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

Specified by:

setProperty in interface javax.portlet.PortletResponse

setServiceInterfaceInstanceId

public void setServiceInterfaceInstanceId(java.lang.String serviceInterfaceInstanceId)

Parameters:

serviceInterfaceInstanceId -

setPageWebResource

public void setPageWebResource(PageWebResource pageWebResource)

Sets the page web resource for this response.

Parameters:

pageWebResource - the page web resource.

Since:

5.0.0

deleteCookie

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

Specified by:

deleteCookie in interface IServiceInterfaceResponse

addProperty

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

Specified by:

addProperty in interface javax.portlet.PortletResponse

addProperty

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

Specified by:

addProperty in interface javax.portlet.PortletResponse

createElement

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

Specified by:

createElement in interface javax.portlet.PortletResponse

Throws:

org.w3c.dom.DOMException

getNamespace

public java.lang.String getNamespace()

Specified by:

getNamespace in interface javax.portlet.PortletResponse

setNamespace

public void setNamespace(java.lang.String namespace)

Sets the namespace to be used in this response.

Parameters:

namespace - the namespace.

Since:

5.5.0

See Also:

getNamespace()

encodeURL

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

Specified by:

encodeURL in interface javax.servlet.http.HttpServletResponse

Specified by:

encodeURL in interface javax.portlet.PortletResponse

Overrides:

encodeURL in class javax.servlet.http.HttpServletResponseWrapper