Package org.pentaho.platform.api.engine

Interface Summary

Interface	Description
IAcceptsRuntimeInputs	Deprecated Pojo components are deprecated, use IAction
IAclEntry	This is a port from spring-security 2.0.8.RELEASE
IAclHolder	Deprecated
IAclSolutionFile	Deprecated
IAclVoter	Deprecated
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.
IAuthorizationAction	Represents a Logical Role name used by some IAuthorizationPolicy implementations.
IAuthorizationPolicy	An access control policy.
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
IConfiguration	User: nbaker Date: 4/2/13
IConfiguredPojo	Deprecated Pojo components are deprecated, use IAction
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	This should only be used internally by the plugin manager
IContentGeneratorInvoker
IContentInfo	Describes a content type.
IContentListener
IContentOutputHandler	Interface for a class used to stream contents from a Hitachi Vantara action sequence to a destination of some kind, e.g.
ICreateFeedbackParameterCallback
IDocumentResourceLoader
IExecutionListener
IFileFilter
IFileInfo
ILoggablePojo	Deprecated Pojo components are deprecated, use IAction
ILogger	The Logger is the main interface into the platform's logging subsystem.
ILogoutListener
IMessageFormatter
IMimeTypeListener
IObjectCreator<T>	A simple creator interface.
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	Deprecated
IPentahoAclObjectIdentity	Deprecated
IPentahoBasicAclEntry	Deprecated
IPentahoDefinableObjectFactory	Deprecated Use the new IPentahoRegistrableObjectFactory facilities available in PentahoSystem
IPentahoInitializer
IPentahoObjectFactory	The way the BI platform creates and manages system objects.
IPentahoObjectReference<T>	User: nbaker Date: 1/16/13 IPentahoObjectReference objects represent a pointer to an available object in the IPentahoObjectFactory and contains all attributes associated with that object (priority, adhoc attributes).
IPentahoObjectRegistration	A handle for a registered IPentahoObjectReference allowing the removal from the registered IPentahoRegistrableObjectFactory Created by nbaker on 4/18/14.
IPentahoPublisher	Defines the interface for getting objects published in the platform.
IPentahoRegistrableObjectFactory	Supports the registration of new implementations with the IPentahoObjectFactory at runtime.
IPentahoRequestContext	Manages Hitachi Vantara Request Context
IPentahoRequestContextHolderStrategy	A strategy for storing an IPentahoRequestContext against a thread.
IPentahoSession	Provides an overall representation of the concept of a session.
IPentahoSystem
IPentahoSystemAclHelper
IPentahoSystemAdminPlugins
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.
IPentahoSystemHelper
IPentahoSystemInitializer
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.
IPentahoSystemListeners
IPentahoSystemStartupActions
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	Deprecated
IPermissionMgr	Deprecated
IPermissionRecipient	Deprecated
IPlatformPlugin	This interface represents the contract for the specification of a plugin.
IPlatformPluginCsrfProtection	This interface represents an extension to the contract of a plugin containing CSRF protection information.
IPlatformReadyListener	This interface is meant to augment IPluginLifecycleListener.
IPlatformWebResource	Simple interface representing a Web Resource Created by nbaker on 9/8/16.
IPluginLifecycleListener	This interface provides entry points to the plugin manager for plugin loading, and unloading.
IPluginManager	The contract API between the platform and BIServer plugins.
IPluginManagerListener	A sinple listener for the IPluginManager.
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	Deprecated Pojo components are deprecated, use IAction
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
ISecurityHelper	Interface for a utility class with several methods that are used to either bind the Authentication to the IPentahoSession, retrieve the Authentication from the IPentahoSession, and other various helper functions.
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.
IServerStatusChangeListener	This is a listener for the IServerStatusProvider which should call onStatusChange whenever the values of the ServerStatus or status message change value.
IServerStatusProvider	Provides a facility that reports the current status of the server.
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	Deprecated Pojo components are deprecated, use IAction
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.
ISolutionFilter
IStreamingPojo	Deprecated Pojo components are deprecated, use IAction
IStreamingPojoComponent
ISystemConfig	User: nbaker Date: 4/2/13
ISystemSettings	The SystemSettings manages the platform's overall configuration settings.
IUITemplater
IUserRoleListService

Class Summary

Class	Description
CsrfProtectionDefinition	This class represents an extension to the contract of a plugin containing CSRF protection information.
IServerStatusProvider.Locator
PluginBeanDefinition
PluginServiceDefinition
RequestMatcherDefinition	This class represents a request matcher that identifies one or more endpoints.
ServerStatusProvider	This is the default implementation of server status log message provider.

Enum Summary

Enum	Description
IPentahoDefinableObjectFactory.Scope	The different object scopes that are supported
IPentahoRegistrableObjectFactory.Types	The types that the Object instance or IPentahoObjectReference can be registered under.
IPlatformPlugin.ClassLoaderType
IServerStatusProvider.ServerStatus

Exception Summary

Exception	Description
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
UnresolvedParameterException