Class SolutionEngine

  • All Implemented Interfaces:
    Serializable, org.pentaho.platform.api.engine.ILogger, org.pentaho.platform.api.engine.IPentahoInitializer, org.pentaho.platform.api.engine.ISolutionEngine

    public class SolutionEngine
    extends PentahoMessenger
    implements org.pentaho.platform.api.engine.ISolutionEngine, org.pentaho.platform.api.engine.IPentahoInitializer
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.pentaho.platform.api.engine.IRuntimeContext runtime  
      • 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
      • Fields inherited from interface org.pentaho.platform.api.engine.ISolutionEngine

        RUNTIME_SOLUTION_NAME
    • Constructor Summary

      Constructors 
      Constructor Description
      SolutionEngine()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void applyParameterMappers​(Map parameterProviderMap)
      FIXME: This is in dire need of fixing
      protected void auditStart​(String actionPath, String instanceId)  
      protected boolean checkParameters​(String sequencePath, String processId)  
      protected void createRuntime​(org.pentaho.platform.api.repository.IRuntimeElement runtimeData, String solutionName, org.pentaho.platform.api.engine.IOutputHandler outputHandler, String processId, org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory)  
      org.pentaho.platform.api.engine.IRuntimeContext execute​(String actionPath, String processId, boolean async, boolean instanceEnds, String instanceId, boolean isPersisted, Map parameterProviderMap, org.pentaho.platform.api.engine.IOutputHandler outputHandler, org.pentaho.platform.api.engine.IActionCompleteListener pListener, org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory, List messages)  
      protected org.pentaho.platform.api.engine.IRuntimeContext execute​(String actionPath, String processId, boolean async, boolean instanceEnds, String instanceId, boolean isPersisted, Map parameterProviderMap, org.pentaho.platform.api.engine.IOutputHandler outputHandler, org.pentaho.platform.api.engine.IActionCompleteListener pListener, org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory, List messages, String actionSequenceXML)  
      org.pentaho.platform.api.engine.IRuntimeContext execute​(String actionSequenceXML, String sequencePath, String processId, boolean async, boolean instanceEnds, String instanceId, boolean isPersisted, Map parameterProviderMap, org.pentaho.platform.api.engine.IOutputHandler outputHandler, org.pentaho.platform.api.engine.IActionCompleteListener pListener, org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory, List messages)  
      org.pentaho.platform.api.engine.IRuntimeContext execute​(org.pentaho.platform.api.engine.IRuntimeContext pRuntime, String actionPath, String processId, boolean async, boolean instanceEnds, Map parameterProviderMap, org.pentaho.platform.api.engine.IOutputHandler outputHandler)  
      protected org.pentaho.platform.api.engine.IRuntimeContext executeInternal​(String sequencePath, String processId, boolean async, boolean instanceEnds, Map parameterProviderMap)  
      protected org.pentaho.platform.api.engine.IRuntimeContext executeInternal​(String sequencePath, String processId, boolean async, boolean instanceEnds, Map parameterProviderMap, String actionSequenceXML)  
      protected org.pentaho.platform.api.engine.ICreateFeedbackParameterCallback getCreateFeedbackParameterCallback()  
      org.pentaho.platform.api.engine.IRuntimeContext getExecutionContext()  
      org.apache.commons.logging.Log getLogger()  
      protected Map getParameterProviders()  
      protected org.pentaho.platform.api.engine.IRuntimeContext getRuntime()  
      protected org.pentaho.platform.api.engine.IPentahoSession getSession()  
      int getStatus()  
      void init​(org.pentaho.platform.api.engine.IPentahoSession pSession)  
      void setCreateFeedbackParameterCallback​(org.pentaho.platform.api.engine.ICreateFeedbackParameterCallback callback)  
      void setForcePrompt​(boolean forcePrompt)  
      void setlistener​(org.pentaho.platform.api.engine.IActionCompleteListener doneListener)  
      void setlistener​(org.pentaho.platform.api.engine.IExecutionListener execListener)  
      void setParameterProvider​(String name, org.pentaho.platform.api.engine.IParameterProvider parameterProvider)  
      void setParameterXsl​(String xsl)  
      protected void setRuntime​(org.pentaho.platform.api.engine.IRuntimeContext runtime)  
      void setSession​(org.pentaho.platform.api.engine.IPentahoSession session)  
      • Methods inherited from interface org.pentaho.platform.api.engine.ILogger

        debug, debug, error, error, fatal, fatal, getLoggingLevel, info, info, setLoggingLevel, trace, trace, warn, warn
    • Field Detail

      • runtime

        protected org.pentaho.platform.api.engine.IRuntimeContext runtime
    • Constructor Detail

      • SolutionEngine

        public SolutionEngine()
    • Method Detail

      • getLogger

        public org.apache.commons.logging.Log getLogger()
        Specified by:
        getLogger in class PentahoBase
      • init

        public void init​(org.pentaho.platform.api.engine.IPentahoSession pSession)
        Specified by:
        init in interface org.pentaho.platform.api.engine.IPentahoInitializer
        Specified by:
        init in interface org.pentaho.platform.api.engine.ISolutionEngine
      • setParameterProvider

        public void setParameterProvider​(String name,
                                         org.pentaho.platform.api.engine.IParameterProvider parameterProvider)
        Specified by:
        setParameterProvider in interface org.pentaho.platform.api.engine.ISolutionEngine
      • getParameterProviders

        protected Map getParameterProviders()
      • setlistener

        public void setlistener​(org.pentaho.platform.api.engine.IActionCompleteListener doneListener)
        Specified by:
        setlistener in interface org.pentaho.platform.api.engine.ISolutionEngine
      • setlistener

        public void setlistener​(org.pentaho.platform.api.engine.IExecutionListener execListener)
        Specified by:
        setlistener in interface org.pentaho.platform.api.engine.ISolutionEngine
      • setSession

        public void setSession​(org.pentaho.platform.api.engine.IPentahoSession session)
        Specified by:
        setSession in interface org.pentaho.platform.api.engine.ISolutionEngine
      • checkParameters

        protected boolean checkParameters​(String sequencePath,
                                          String processId)
      • getStatus

        public int getStatus()
        Specified by:
        getStatus in interface org.pentaho.platform.api.engine.ISolutionEngine
      • getExecutionContext

        public org.pentaho.platform.api.engine.IRuntimeContext getExecutionContext()
        Specified by:
        getExecutionContext in interface org.pentaho.platform.api.engine.ISolutionEngine
      • getSession

        protected org.pentaho.platform.api.engine.IPentahoSession getSession()
      • getRuntime

        protected org.pentaho.platform.api.engine.IRuntimeContext getRuntime()
      • setRuntime

        protected void setRuntime​(org.pentaho.platform.api.engine.IRuntimeContext runtime)
      • auditStart

        protected void auditStart​(String actionPath,
                                  String instanceId)
      • execute

        public org.pentaho.platform.api.engine.IRuntimeContext execute​(String actionPath,
                                                                       String processId,
                                                                       boolean async,
                                                                       boolean instanceEnds,
                                                                       String instanceId,
                                                                       boolean isPersisted,
                                                                       Map parameterProviderMap,
                                                                       org.pentaho.platform.api.engine.IOutputHandler outputHandler,
                                                                       org.pentaho.platform.api.engine.IActionCompleteListener pListener,
                                                                       org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory,
                                                                       List messages)
        Specified by:
        execute in interface org.pentaho.platform.api.engine.ISolutionEngine
      • execute

        public org.pentaho.platform.api.engine.IRuntimeContext execute​(String actionSequenceXML,
                                                                       String sequencePath,
                                                                       String processId,
                                                                       boolean async,
                                                                       boolean instanceEnds,
                                                                       String instanceId,
                                                                       boolean isPersisted,
                                                                       Map parameterProviderMap,
                                                                       org.pentaho.platform.api.engine.IOutputHandler outputHandler,
                                                                       org.pentaho.platform.api.engine.IActionCompleteListener pListener,
                                                                       org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory,
                                                                       List messages)
        Specified by:
        execute in interface org.pentaho.platform.api.engine.ISolutionEngine
      • execute

        protected org.pentaho.platform.api.engine.IRuntimeContext execute​(String actionPath,
                                                                          String processId,
                                                                          boolean async,
                                                                          boolean instanceEnds,
                                                                          String instanceId,
                                                                          boolean isPersisted,
                                                                          Map parameterProviderMap,
                                                                          org.pentaho.platform.api.engine.IOutputHandler outputHandler,
                                                                          org.pentaho.platform.api.engine.IActionCompleteListener pListener,
                                                                          org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory,
                                                                          List messages,
                                                                          String actionSequenceXML)
      • execute

        public org.pentaho.platform.api.engine.IRuntimeContext execute​(org.pentaho.platform.api.engine.IRuntimeContext pRuntime,
                                                                       String actionPath,
                                                                       String processId,
                                                                       boolean async,
                                                                       boolean instanceEnds,
                                                                       Map parameterProviderMap,
                                                                       org.pentaho.platform.api.engine.IOutputHandler outputHandler)
        Specified by:
        execute in interface org.pentaho.platform.api.engine.ISolutionEngine
      • executeInternal

        protected org.pentaho.platform.api.engine.IRuntimeContext executeInternal​(String sequencePath,
                                                                                  String processId,
                                                                                  boolean async,
                                                                                  boolean instanceEnds,
                                                                                  Map parameterProviderMap)
      • executeInternal

        protected org.pentaho.platform.api.engine.IRuntimeContext executeInternal​(String sequencePath,
                                                                                  String processId,
                                                                                  boolean async,
                                                                                  boolean instanceEnds,
                                                                                  Map parameterProviderMap,
                                                                                  String actionSequenceXML)
      • createRuntime

        protected void createRuntime​(org.pentaho.platform.api.repository.IRuntimeElement runtimeData,
                                     String solutionName,
                                     org.pentaho.platform.api.engine.IOutputHandler outputHandler,
                                     String processId,
                                     org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory)
      • setForcePrompt

        public void setForcePrompt​(boolean forcePrompt)
        Specified by:
        setForcePrompt in interface org.pentaho.platform.api.engine.ISolutionEngine
      • setParameterXsl

        public void setParameterXsl​(String xsl)
        Specified by:
        setParameterXsl in interface org.pentaho.platform.api.engine.ISolutionEngine
      • applyParameterMappers

        protected void applyParameterMappers​(Map parameterProviderMap)
        FIXME: This is in dire need of fixing
        Parameters:
        parameterProviderMap -
      • setCreateFeedbackParameterCallback

        public void setCreateFeedbackParameterCallback​(org.pentaho.platform.api.engine.ICreateFeedbackParameterCallback callback)
        Specified by:
        setCreateFeedbackParameterCallback in interface org.pentaho.platform.api.engine.ISolutionEngine
      • getCreateFeedbackParameterCallback

        protected org.pentaho.platform.api.engine.ICreateFeedbackParameterCallback getCreateFeedbackParameterCallback()