Package org.pentaho.platform.web.servlet

Class HttpWebService

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.pentaho.platform.web.servlet.ServletBase

org.pentaho.platform.web.servlet.HttpWebService

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, org.pentaho.platform.api.engine.ILogger

public class HttpWebService
extends ServletBase

Servlet Class web.servlet name="ViewAction" display-name="Name for ViewAction" description="Description for ViewAction" web.servlet-mapping url-pattern="/ViewAction" web.servlet-init-param name="A parameter" value="A value"

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.pentaho.platform.web.servlet.ServletBase

debug

Fields inherited from interface org.pentaho.platform.api.engine.ILogger

ACTIVITY_LOG, DEBUG, ERROR, FATAL, INFO, INSTANCE_LOG, SESSION_LOG, SOLUTION_LOG, TRACE, UNKNOWN, WARN

Constructor Summary

Constructors

Constructor	Description
HttpWebService()

Method Summary

Modifier and Type	Method	Description
protected void	doChart(String actionPath, org.pentaho.platform.api.engine.IParameterProvider parameterProvider, OutputStream outputStream, org.pentaho.platform.api.engine.IPentahoSession userSession)
protected void	doDial(String solutionName, String actionPath, String actionName, org.pentaho.platform.api.engine.IParameterProvider parameterProvider, OutputStream outputStream, org.pentaho.platform.api.engine.IPentahoSession userSession)
void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Make sure this request has required parameters either on query string or in body of post. Make calls into UserDetailsRoleListService instance for users and roles. Make static call into PentahoAclEntry for ACLs. Construct SOAP response.
void	doGetFixMe(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	doOtherChart(String actionPath, org.pentaho.platform.api.engine.IParameterProvider parameterProvider, OutputStream outputStream, org.pentaho.platform.api.engine.IPentahoSession userSession)
protected void	doPieChart(String actionPath, org.pentaho.platform.api.engine.IParameterProvider parameterProvider, OutputStream outputStream, org.pentaho.platform.api.engine.IPentahoSession userSession)
protected void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected org.dom4j.Document	getACLs()	Returns XML for list of ACLs.
protected String	getDetailsParameter(javax.servlet.http.HttpServletRequest request)	Returns parameter named details either from query string or body.
org.apache.commons.logging.Log	getLogger()
protected Map	getParameterMapFromPayload(String xml)
String	getPayloadAsString(javax.servlet.http.HttpServletRequest request)
protected org.dom4j.Document	getRoles()	Returns XML for list of roles.
protected org.dom4j.Document	getUsers()	Returns XML for list of users.
protected boolean	hasActionInBody(javax.servlet.http.HttpServletRequest request)	Returns true if required parameter is in body of request.
protected boolean	hasActionInQueryString(javax.servlet.http.HttpServletRequest request)	Returns true if required parameter named action is in query string.
protected boolean	isSecurityDetailsRequest(javax.servlet.http.HttpServletRequest request)	Returns true if the required parameter is either in the query string or body.

Methods inherited from class org.pentaho.platform.web.servlet.ServletBase

debug, debug, error, error, fatal, fatal, getLoggingLevel, getObjectName, getPentahoSession, info, info, setCorsHeaders, setLoggingLevel, trace, trace, warn, warn

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Details

HttpWebService

public HttpWebService()

Method Details

getLogger

public org.apache.commons.logging.Log getLogger()

Specified by:

getLogger in class ServletBase

getPayloadAsString

public String getPayloadAsString(javax.servlet.http.HttpServletRequest request)
                          throws IOException

Throws:

IOException

doGetFixMe

public void doGetFixMe(javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response)
                throws javax.servlet.ServletException,
IOException

Throws:

javax.servlet.ServletException

IOException

doPost

protected void doPost(javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response)
               throws javax.servlet.ServletException,
IOException

Overrides:

doPost in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

doDial

protected void doDial(String solutionName,
 String actionPath,
 String actionName,
 org.pentaho.platform.api.engine.IParameterProvider parameterProvider,
 OutputStream outputStream,
 org.pentaho.platform.api.engine.IPentahoSession userSession)

doChart

protected void doChart(String actionPath,
 org.pentaho.platform.api.engine.IParameterProvider parameterProvider,
 OutputStream outputStream,
 org.pentaho.platform.api.engine.IPentahoSession userSession)

doPieChart

protected void doPieChart(String actionPath,
 org.pentaho.platform.api.engine.IParameterProvider parameterProvider,
 OutputStream outputStream,
 org.pentaho.platform.api.engine.IPentahoSession userSession)

doOtherChart

protected void doOtherChart(String actionPath,
 org.pentaho.platform.api.engine.IParameterProvider parameterProvider,
 OutputStream outputStream,
 org.pentaho.platform.api.engine.IPentahoSession userSession)

doGet

public void doGet(javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response)
           throws javax.servlet.ServletException,
IOException

1. Make sure this request has required parameters either on query string or in body of post.
2. Make calls into UserDetailsRoleListService instance for users and roles.
3. Make static call into PentahoAclEntry for ACLs.
4. Construct SOAP response.

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

isSecurityDetailsRequest

protected boolean isSecurityDetailsRequest(javax.servlet.http.HttpServletRequest request)

Returns true if the required parameter is either in the query string or body.

getDetailsParameter

protected String getDetailsParameter(javax.servlet.http.HttpServletRequest request)

Returns parameter named details either from query string or body. This parameter specifies how much information the caller wants returned.

hasActionInBody

protected boolean hasActionInBody(javax.servlet.http.HttpServletRequest request)

Returns true if required parameter is in body of request.

hasActionInQueryString

protected boolean hasActionInQueryString(javax.servlet.http.HttpServletRequest request)

Returns true if required parameter named action is in query string.

getParameterMapFromPayload

protected Map getParameterMapFromPayload(String xml)

getUsers

protected org.dom4j.Document getUsers()
                               throws javax.servlet.ServletException,
IOException

Returns XML for list of users.

Throws:

javax.servlet.ServletException

IOException

getRoles

protected org.dom4j.Document getRoles()
                               throws javax.servlet.ServletException,
IOException

Returns XML for list of roles.

Throws:

javax.servlet.ServletException

IOException

getACLs

protected org.dom4j.Document getACLs()
                              throws javax.servlet.ServletException,
IOException

Returns XML for list of ACLs.

Throws:

javax.servlet.ServletException

IOException