Package org.pentaho.platform.api.engine

Interface Summary
IAcceptsRuntimeInputs  
IAclHolder TODO mlowery List type should probably not be a concrete class (PentahoAclEntry).
IAclPublisher  
IAclSolutionFile This interface makes certain that there is a mechanism to traverse the solution files from root to leaf.
IAclVoter  
IActionCompleteListener The listener interface for receiving notification when a Component execution has completed.
IActionParameter An IActionParameter represents one input or output in an IActionSequence.
IActionRequestHandler The basic interface for requests to execute actions .
IActionSequence An ActionSequence is the functional object that wraps a SequenceDefinition for processing by the RuntimeContext.
IActionSequenceResource The ActionResource interface represents one resource in an ActionSequence.
IApplicationContext Defines a set of methods to retrieve information about the application environment.
IAuditable Any subsystem that implements the IAuditable interface is candidate for auditing within the platform.
IAuditEntry An implementation of the IAuditEntry interface describes the method by which audit messages are recorded and what destination storage they are recorded to.
IBackgroundExecution  
ICacheManager  
IComponent A Component is the smallest module in the platform architecture and represents a unit of work, or an action to be performed.
IConditionalExecution This interface supports conditional execution of action sequence 'actions' blocks
IConfiguredPojo The interface for a POJO component that wants access to system settings.
IConnectionUserRoleMapper This interface provides for mapping a Platform user to a connection user, or a users' roles to known/valid roles for a connection.
IContentGenerator This interface is implemented by bi-platform plugins, and is instantiated for each content request made to the plugin system via the IPluginManager API.
IContentGeneratorInfo  
IContentInfo Describes a content type.
IContentListener  
IContentOutputHandler Interface for a class used to stream contents from a Pentaho action sequence to a destination of some kind, e.g.
ICreateFeedbackParameterCallback  
IDocumentResourceLoader  
IExecutionListener  
IFileFilter  
IFileInfo  
IFileInfoGenerator Deprecated.  
ILoggablePojo The interface for a POJO component that wants to be provided with a logger.
ILogger The Logger is the main interface into the platform's logging subsystem.
ILogoutListener  
IMessageFormatter  
IMimeTypeListener  
IOutputDef An OutputDef represents one output parameter in a SequenceDefinition or ActionDefinition.
IOutputHandler An OutputHandler manages the content generated from a Component execution.
IParameterManager  
IParameterProvider A ParameterProvider is a source for input, output or resource parameters for a given action.
IParameterResolver  
IParameterSetter Augments the parameter provider by adding settings for the parameters.
IPentahoAclEntry Base Pentaho Access Control entry.
IPentahoDefinableObjectFactory This class subclasses IPentahoObjectFactory and adds methods that enables the implementation to allow objects to be defined through public classes.
IPentahoInitializer  
IPentahoObjectFactory The way the BI platform creates and manages system objects.
IPentahoPublisher Defines the interface for getting objects published in the platform.
IPentahoSession Provides an overall representation of the concept of a session.
IPentahoSystemEntryPoint System Entry Point implementors get called upon entry to the system after they've been registered with the ApplicationContext (IApplicationContext).
IPentahoSystemExitPoint System Exit Point implementors are called with the action on a thread completes.
IPentahoSystemListener Classes that implement this interface can be notified about key system events, in order to perform one-time operations such as initialization, maintenance or other tasks.
IPentahoUrl Provides a simple interface for Portlet URL's (PortletURL objects).
IPentahoUrlFactory Provides an interface around getting a URL object which can be used to construct a URL managing the parameters that need to be built up.
IPermissionMask  
IPermissionMgr  
IPermissionRecipient  
IPlatformPlugin This interface represents the contract for the specification of a plugin.
IPluginLifecycleListener This interface provides entry points to the plugin manager for plugin loading, and unloading.
IPluginManager The contract API between the platform and platform plugins.
IPluginOperation  
IPluginProvider A plugin provider is responsible for serving up IPlatformPlugins to whoever is asking, typically IPluginManager.
IPluginResourceLoader This class presents an abstraction layer for accessing resources from within a platform plugin.
IProducesRuntimeOutputs  
IRuntimeContext This interface defines methods and constants that are used during action execution to resolve parameters, inputs and outputs, resources, and persist the runtime data.
IScheduledJob  
IScheduler The IScheduler implementation should be able to take an ISubscription and add it to it's internal scheduling mechanism to cause a trigger in the platform
ISelectionMapper  
ISequenceDefinition The SequenceDefinition represents the definition of several consecutive action definitions that comprise an ActionSequence object, which is the runtime equivalent of an action sequence document.
IServiceConfig The configuration spec for a platform managed service
IServiceManager A service manager allows a POJO to be exposed as various types of services by constructing a simple ServiceConfig and calling #registerService(ServiceConfig).
ISessionContainer A "something" that refers to a session.
ISessionStartupAction  
ISimplePojoComponent  
ISolutionActionDefinition The ActionDefinition represents the definition and metadata for a single action execution, which is equivalent to one execution of any given Component.
ISolutionAttributeContributor  
ISolutionEngine The Solution Engine handles loading and launching execution of solutions and action sequences.
ISolutionFile A solution file is an abstract represention of either a file or a directory.
ISolutionFileMetaProvider Provides meta information about solution files.
ISolutionFilter  
IStreamingPojo The interface for POJO components that want to stream content to the caller.
IStreamingPojoComponent Deprecated.
ISubscriptionScheduler Interface class between the subscription repository and the implementation of the scheduler.
ISystemSettings The SystemSettings manages the platform's overall configuration settings.
IUITemplater  
IUserDetailsRoleListService  
IUserRoleListService  
 

Class Summary
PluginBeanDefinition  
PluginServiceDefinition  
SolutionFileMetaAdapter This class only exists for backwards compatibility with IFileInfoGenerator.
 

Enum Summary
IFileInfoGenerator.ContentType Deprecated.
IPentahoDefinableObjectFactory.Scope The different object scopes that are supported
IPlatformPlugin.ClassLoaderType  
 

Exception Summary
ActionExecutionException  
ActionInitializationException  
ActionSequenceException  
ActionSequencePromptException  
ActionValidationException  
AuditException  
ComponentException  
InvalidParameterException This exception just signals that an exception occurred initializing parameters for an adcion-definition
ObjectFactoryException  
PentahoAccessControlException  
PentahoSystemException  
PlatformPluginRegistrationException An exception raised when an IPlatformPlugin fails to register.
PluginBeanException  
PluginLifecycleException  
ServiceException  
ServiceInitializationException  
SubscriptionSchedulerException  
UnresolvedParameterException