Package lumis.portal.controller

Class ControllerXml

java.lang.Object

lumis.portal.controller.ControllerXml

Direct Known Subclasses:

ChannelControllerXml, ChannelTemplateControllerXml, ChannelTreeControllerXml, ChatControllerXml, CssControllerXml, DouiContentTreeControllerXml, DouiControlControllerXml, DouiControllerXml, DouiReindexerControllerXml, DouiSourceControllerXml, InContextEditControllerXml, LockController, PageControllerXml, PageTemplateControllerXml, ServiceControllerXml, ServiceInterfaceControllerXml, ServiceInterfaceInstanceControllerXml, ServiceInterfaceListControllerXml, SessionKeepAliveControllerXml, UserControllerXml

@StableMinor(version="16.1",
             sinceVersion="4.0")
public class ControllerXml
extends java.lang.Object

Base class for all Xml Controllers

Since:

4.0.0

Version:

$Revision: 26156 $ $Date: 2024-01-13 10:26:46 -0300 (Sat, 13 Jan 2024) $

Field Summary

Fields

Modifier and Type	Field	Description
protected java.io.Writer	out
protected HttpServletRequest	request
protected HttpServletResponse	response
protected SessionConfig	sessionConfig

Constructor Summary

Constructors

Constructor	Description
ControllerXml(HttpServletRequest request, HttpServletResponse response)

Method Summary

Modifier and Type	Method	Description
protected void	checkRequestIsPost()	Checks if the current request method is POST.
static java.lang.String	getResponseXml()
static java.lang.String	getResponseXml(java.lang.String innerXml)
protected java.lang.String	getResponseXml(PortalException portalException)
void	loadUserInfo(org.w3c.dom.Document requestDom, ITransaction portalTransaction)	Deprecated. Since 4.0.7 this method does nothing.

Methods inherited from class java.lang.Object

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

Field Detail

sessionConfig

protected SessionConfig sessionConfig

request

protected HttpServletRequest request

response

protected HttpServletResponse response

out

protected java.io.Writer out

Constructor Detail

ControllerXml

public ControllerXml(HttpServletRequest request,
                     HttpServletResponse response)
              throws ControllerException,
                     PortalException

Parameters:

request -

response -

Throws:

ControllerException

PortalException

Method Detail

loadUserInfo

public void loadUserInfo(org.w3c.dom.Document requestDom,
                         ITransaction portalTransaction)
                  throws ControllerException,
                         PortalException

Deprecated.

Since 4.0.7 this method does nothing. sessionConfig is now initialized in the constructor.

Parameters:

requestDom -

portalTransaction -

Throws:

ControllerException

PortalException

getResponseXml

protected java.lang.String getResponseXml(PortalException portalException)
                                   throws ControllerException,
                                          PortalException

Throws:

ControllerException

PortalException

getResponseXml

public static java.lang.String getResponseXml(java.lang.String innerXml)

Parameters:

innerXml -

Returns:

wraps the xml within response xml tags

getResponseXml

public static java.lang.String getResponseXml()

checkRequestIsPost

protected void checkRequestIsPost()

Checks if the current request method is POST.

Throws:

java.lang.IllegalArgumentException - if the request method is not POST.

Since:

15.0.1