All Classes and Interfaces
Class
Description
An exception thrown when the invocation of
IAction fails.Thrown when an object already exists with the given identifier.
Implementations of this interface are responsible for converting between an
InputStream and an
IRepositoryFileData.An exception that can be thrown from
Converter implementations.Deprecated.
This is a port from spring-security 2.0.8.RELEASE
Deprecated.
The interface for operations over ACL nodes.
Deprecated.
Deprecated.
Actions are the lightweight alternative to platform components (see
IComponent).This interface will provide a way to create an adaptor between
IAction and
any orchestration tool like for example Mesos or Kubernetes etc.This interface is used register and resolve action class name
The listener interface for receiving notification when a Component execution has completed.
The purpose of this interface is to provide functionality needed to invoke an
IAction instance in a
generic fashion.An API for the object representation of action invocation status, allows us to pass back status
of action invocation, whether any exceptions occurred during invocation and whether the action
needs to be retired.
An
IActionParameter represents one input or output in an IActionSequence.The basic interface for requests to execute actions .
An ActionSequence is the functional object that wraps a SequenceDefinition for processing by the RuntimeContext.
The ActionResource interface represents one resource in an ActionSequence.
Deprecated.
Defines a set of methods to retrieve information about the application environment.
Any subsystem that implements the IAuditable interface is candidate for auditing within the platform.
An implementation of the IAuditEntry interface describes the method by which audit messages are recorded and
what destination storage they are recorded to.
Maps LDAP roles to pentaho security roles using the map defined in the spring configuration file
(applicationContext-spring-security-ldap.xml).
Represents a Logical Role name used by some IAuthorizationPolicy implementations.
An access control policy.
An object used by the scheduler to provide actions that expect to write to an output stream with the stream to be
written to.
Allows external code to do initialization work on the backing repository at certain lifecycle milestones.
This interface defines the API for a registry of
ILastModifiedCacheItem's.A Component is the smallest module in the platform architecture and represents a unit of work, or an action to
be performed.
This interface supports conditional execution of action sequence 'actions' blocks
User: nbaker Date: 4/2/13
Deprecated.
Pojo components are deprecated, use
IActionThis interface provides for mapping a Platform user to a connection user, or a users' roles to known/valid roles
for a connection.
This interface is implemented by bi-platform plugins, and is instantiated for each content request made to the
plugin system via the IPluginManager API.
This should only be used internally by the plugin manager
Describes a content type.
Construction of a new ContentItem is managed by ContentLocation.newContentItem.
Interface for a class used to stream contents from a Hitachi Vantara action sequence to a destination of some kind, e.g.
The data component interface extends component, and adds a single method -
getResultSet().Service to manage JDBC datasources in the platform.
This interface defines Pentaho's DatasourceService API.
Makes an Action privy to certain details about the action definition that is responsible for executing it.
The Email Service used in the Pentaho Platform
This interface defines a file type plugin, which specifies the behavior for viewing and editing specific file
types
Represents versioning information about a repository file.
This interface defines Pentaho's ExtendedDatasourceService API.
Specifies a filter to be used when processing lists of jobs such as in
IScheduler.getJobs(IJobFilter)This structure is a representation of a particular scheduled job run.
API for cached items that contain a last modified timestamp
Deprecated.
Pojo components are deprecated, use
IActionThe Logger is the main interface into the platform's logging subsystem.
The interface for an Action that wants to be provided with a logger.
top-most signature for any event being published to monitoring's event bus
top-most signature for any event handler being subscribed onto monitoring's event bus
Used to specify incremental dates or times.
This exception just signals that an exception occurred initializing parameters for an adcion-definition
A simple creator interface.
An OutputDef represents one output parameter in a SequenceDefinition or ActionDefinition.
An OutputHandler manages the content generated from a Component execution.
A ParameterProvider is a source for input, output or resource parameters for a given action.
Augments the parameter provider by adding settings for the parameters.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Use the new
IPentahoRegistrableObjectFactory facilities available in PentahoSystemThe different object scopes that are supported
The way the BI platform creates and manages system objects.
User: nbaker Date: 1/16/13
A handle for a registered IPentahoObjectReference allowing the removal from the registered
IPentahoRegistrableObjectFactory
Defines the interface for getting objects published in the platform.
Supports the registration of new implementations with the IPentahoObjectFactory at runtime.
The types that the Object instance or IPentahoObjectReference can be registered under.
Manages Hitachi Vantara Request Context
A strategy for storing an IPentahoRequestContext against a thread.
A role in the Pentaho platform.
Provides an overall representation of the concept of a session.
System Entry Point implementors get called upon entry to the system after they've been registered with the
ApplicationContext (IApplicationContext).
System Exit Point implementors are called with the action on a thread completes.
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.
Provides a simple interface for Portlet URL's (PortletURL objects).
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.
A user of the Pentaho platform.
Deprecated.
Deprecated.
Deprecated.
A struct-like object for bundling related objects together for import into the platform.
Implementations of this class compute mime-types based on the given IPlatformImportBundle.
This interface represents the contract for the specification of a plugin.
This interface is meant to augment IPluginLifecycleListener.
Simple interface representing a Web Resource
Created by nbaker on 9/8/16.
This interface provides entry points to the plugin manager for plugin loading, and unloading.
The contract API between the platform and BIServer plugins.
A sinple listener for the
IPluginManager.A plugin provider is responsible for serving up
IPlatformPlugins to whoever is asking, typically
IPluginManager.This class presents an abstraction layer for accessing resources from within a platform plugin.
This interface defines Pentaho's ExtendedDatasourceService API.
The interface for Actions that allows caller get information from Action
The prepared component interface extends component, allowing components to go into a prepared state vs.
Allows an Action to do some preliminary work prior to execution.
Deprecated.
Pojo components are deprecated, use
IActionRepository voter to add custom security to the repository.
Repository voter manager to store list of repository access voters
Repository Content Converter Handler manages the repository content converter in the platform
Supply the default ACL intended to be used when none exist
The data or payload of a
RepositoryFile.This interface defines methods and constants that are used during action execution to resolve parameters, inputs
and outputs, resources, and persist the runtime data.
An object that allows for the scheduling of IActions on the Pentaho platform
An
IScheduleSubject represents an entity that is associated in some way with the scheduling system.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.
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.
This is a listener for the IServerStatusProvider which should call onStatusChange whenever the values of
the ServerStatus or status message change value.
Provides a facility that reports the current status of the server.
The configuration spec for a platform managed service
A service manager allows a POJO to be exposed as various types of services by constructing a simple
ServiceConfig and calling IServiceManager.registerService(ServiceConfig).The interface for an Action that wants to be provided with a session.
A "something" that refers to a session.
A simple way of specifying a schedule on which a job will fire as opposed to
IComplexJobTrigger.Deprecated.
Pojo components are deprecated, use
IActionThe ActionDefinition represents the definition and metadata for a single action execution, which is equivalent
to one execution of any given Component.
The Solution Engine handles loading and launching execution of solutions and action sequences.
A solution file is an abstract represention of either a file or a directory.
The interface for Actions that want to stream content to the caller.
Deprecated.
Pojo components are deprecated, use
IActionThe interface for Actions that want to process the contents of a stream provided by the caller.
User: nbaker Date: 4/2/13
The SystemSettings manages the platform's overall configuration settings.
A tenant of the Pentaho platform.
Utility to go between principal IDs (user/role IDs) and principal name and tenant.
Class responsible for collecting information about all available system module local themes.
Theme Resolvers provide information on available themes and their resources.
A marker interface used to identify classes that can be used to specify the time (hour/minute) recurrence of job
triggers and scheduler availability windows.
Entry point into the unified repository.
Contract for data access objects that read and write users and roles.
Allows an Action to accept inputs from the action sequence that are unspecified by the Action itself.
Created by nbaker on 9/3/14.
Exposes a SpringResource Interface to access wadl extension files
Interface that provide the access to user credentials
Encapsulates all information pertaining to a "work item" at a specific point in its lifecycle.
Responsible for publishing
IWorkItemLifecycleEvents.A common interface for components wishing to listen for
IWorkItemLifecycleEvents.A common interface for work item lifecycle phases.
Java class for jobScheduleParam complex type.
Various utility methods for working with log4j2
ModuleThemeInfo holds theme information for a platform module such as a plugin or other area.
Provides interface for applying model annotations to a Mondrian schema.
An I/O exception thrown by
javax.ws.rs.ext.MessageBodyReader implementations
when reading a zero-length message content to indicate that the message body reader
is not able to produce an instance representing an zero-length message content.Thrown when no object exists with the given identifier.
This is the base Hitachi Vantara Exception class that handles chained exceptions.
An exception raised when an
IPlatformPlugin fails to register.Used to specify a list of recurrences representing dates or times.
Immutable repository file.
Immutable access control entry (ACE).
Immutable access control list (ACL).
JAXB-safe version of
RepositoryFile.Immutable Extra Meta Data.
Repository file permission enumeration.
Repository file security identifier (SID) used as file owners and permission recipients in access control
entries.
A struct for a
RepositoryFile and its immediate children.* The immediate children is a list of this type
(which can have children and so on).Exception thrown from a
IBackingRepositoryLifecycleManager method that failsAn
IRepositoryFileData for illustrative purposes.Used to specify a sequence of dates or times from first value through and including the last value.
This is the default implementation of server status log message provider.
A
IRepositoryFileData that has an input stream, encoding, and optional MIME type.Marks a class as an SNMP Trap entity.
Marks a field to be converted to a SNMP VariableBinding for a Trap event.
Theme encapsulates a collection of ThemeResources and a root directory to access them from.
User: nbaker Date: 5/15/11
Represents some other, usually fatal, exception.
An exception that can be thrown from
IUnifiedRepository implementations.An exception that can be thrown from
IUnifiedRepository implementations.An exception that can be thrown from
IUnifiedRepository implementations.An exception that can be thrown from
IUnifiedRepository implementations.An exception that can be thrown from
IUnifiedRepository implementations.An exception that can be thrown from
IUnifiedRepository implementations.An exception that can be thrown from
IUnifiedRepository implementations.Superclass of all exception types thrown by
IUserRoleDao implementations.Immutable version summary for a
RepositoryFile.
IAction