Package lumis.portal.serviceinterfaceinstance

Class ServiceInterfaceInstanceControllerHtml

java.lang.Object

lumis.portal.controller.ControllerHtml

lumis.portal.serviceinterfaceinstance.ServiceInterfaceInstanceControllerHtml

Direct Known Subclasses:

BannerController

public class ServiceInterfaceInstanceControllerHtml
extends ControllerHtml

This class renders and returns the HTML for a single service interface. It is used by the client side service interfaces when you drag and drop an interface, or refresh an interface in Administration (F12) Mode.

Since:

4.0.0

Version:

$Revision: 21800 $ $Date: 2018-09-10 16:56:27 -0300 (Mon, 10 Sep 2018) $

Field Summary

Fields

Modifier and Type	Field	Description
protected int	debugLevel
protected int	mode
protected ServiceContainer	serviceContainer

Fields inherited from class lumis.portal.controller.ControllerHtml

out, request, response, sessionConfig, userConfig

Constructor Summary

Constructors

Constructor	Description
ServiceInterfaceInstanceControllerHtml(HttpServletRequest request, HttpServletResponse response, PageContext pageContext)

Method Summary

Modifier and Type	Method	Description
protected void	clearServiceInterfaceInstanceCache()	Clears the HTML cache of the specified interface, if any, and clears the XSL Transformer cache for the XSL file used by the interface.
protected void	getServiceInterfaceInstanceXmlData()
void	handleRequest()
protected String	processHTML(ServiceContainerRenderRequest renderRequest, String outputHTML)	Processes the HTML generated by the service interface instance, for proper rendering in the final page.
protected void	renderOutput(ServiceContainerRenderRequest renderRequest, ServiceContainerRenderResponse renderResponse, Map<String,String> originalMap, ITransaction portalTransaction)
protected void	renderServiceInterfaceInstance()	Returns the HTML for a single service interface instance.
protected void	setRequestMode()	Sets the Request Mode.

Methods inherited from class lumis.portal.controller.ControllerHtml

deleteCookie, getCookie, getRequestMode, getSessionConfig, loadUserInfo, setCookie

Methods inherited from class java.lang.Object

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

Field Detail

serviceContainer

protected ServiceContainer serviceContainer

mode

protected int mode

debugLevel

protected int debugLevel

Constructor Detail

ServiceInterfaceInstanceControllerHtml

public ServiceInterfaceInstanceControllerHtml(HttpServletRequest request,
                                              HttpServletResponse response,
                                              PageContext pageContext)
                                       throws ControllerException,
                                              PortalException

Parameters:

request -

response -

pageContext -

Throws:

ControllerException

PortalException

Method Detail

handleRequest

public void handleRequest()
                   throws Exception

Throws:

Exception

setRequestMode

protected void setRequestMode()
                       throws ControllerException,
                              PortalException

Sets the Request Mode. This could either be PortalContext.MODE_ADMIN, or PortalContext.MODE_USER.

If mode is not PortalContext.MODE_USER, the IMonitorContext is disabled.

Throws:

ControllerException

PortalException

See Also:

IMonitorContext#setEnabled(boolean)

clearServiceInterfaceInstanceCache

protected void clearServiceInterfaceInstanceCache()
                                           throws ControllerException,
                                                  PortalException

Clears the HTML cache of the specified interface, if any, and clears the XSL Transformer cache for the XSL file used by the interface.

Throws:

ControllerException

PortalException

Since:

4.0.4

renderServiceInterfaceInstance

protected void renderServiceInterfaceInstance()
                                       throws ControllerException,
                                              PortalException

Returns the HTML for a single service interface instance.

Throws:

ControllerException

PortalException

renderOutput

protected void renderOutput(ServiceContainerRenderRequest renderRequest,
                            ServiceContainerRenderResponse renderResponse,
                            Map<String,String> originalMap,
                            ITransaction portalTransaction)
                     throws ServiceException,
                            IOException,
                            PortalException

Throws:

ServiceException

IOException

PortalException

processHTML

protected String processHTML(ServiceContainerRenderRequest renderRequest,
                             String outputHTML)
                      throws PortalException

Processes the HTML generated by the service interface instance, for proper rendering in the final page.

Parameters:

renderRequest - the renderization request.

outputHTML - the HTML generated by the service interface instance.

Returns:

the processed HTML.

Throws:

PortalException

Since:

8.0.0

getServiceInterfaceInstanceXmlData

protected void getServiceInterfaceInstanceXmlData()
                                           throws ControllerException,
                                                  PortalException

Throws:

ControllerException

PortalException