All Classes and Interfaces

Class
Description
 
The base class for serving GenericServlet, i.e.
 
 
The base class for all content generating components.
Creation-Date: 07.07.2006, 20:50:22
The AbstractGwtRpc class is the base abstract class of classes that represent a GWT Remote Procedure Call which is made via HTTP.
Base class for GWT RPC proxying servlets, which allows developers to write GWT Services as Pojos and have the GWT client POST requests to subclasses of this class.
The AbstractGwtRpcRequestMatcher class is the base class for GWT-RPC request matchers.
 
 
 
 
 
This class was created to solve the following jira case.
 
 
 
The purpose of this content generator is to render prompts for a specific xaction, used during background and scheduling operations.
The AnalysisView enum facilitates predefined views for charting performance metrics
 
 
By default, this class will initialize itself from resource/config/console.xml (relative to the current working directory).
Will import all the zip files in a given directory using the supplied IPlatformImporter User: kwalker Date: 6/20/13
 
POJO to simply represent authentication providers in SystemResource endpoints
Resource deals with the Authorization Action in the BA Platform.
 
Executes an operation of a web service.
Writes the WSDL for a Axis web service to the output stream provided
This class subclasses AxisServlet to expose protected methods and variables
 
 
This class dispatches requests coming from GenericServlet and determines which AxisService should be invoked.
 
 
A BaseExportProcessor subclass should encapsulate all logic for creating and assembling export file.
 
User: rfellows Date: 10/26/11 Time: 9:19 AM
User: rfellows Date: 10/25/11 Time: 2:36 PM
This class provides an access point for pluggable caching mechanisms.
Class Description
Caching Decorator for an IUserRoleListService.
This class contains a list of UserDetailsService objects.
 
This class was adapted from ChartComponent by cboyden
Takes all inputs necessary to generate a chart and passes them to the ChartBeans engine (via an xaction).
 
This exception wraps the generic exception thrown by the ChartBeans boot process so that developers can properly account for boot errors.
Deprecated.
please use ChartAction
 
 
Provides a collection of callback methods used by the chart beans API which give the api user the ability link data points in the chart URLs or javascript.
 
 
 
This interceptor changes the thread context classloader to the class' current classloader.
 
Handles the parsing of command line arguments and creates an import process based upon them
 
 
 
Java class for complexJobTrigger complex type.
Java class for anonymous complex type.
Java class for anonymous complex type.
Java class for anonymous complex type.
Java class for anonymous complex type.
Java class for anonymous complex type.
Java class for anonymous complex type.
Java class for anonymous complex type.
Java class for complexJobTriggerProxy complex type.
 
This class delgates calls to a configured list of IUserRoleListService delegates.
 
 
This class serves as a away to gain access to OSGI ConfigurationAdmin capabilities, more precisely to the configuration properties.
 
 
This component takes an input, and writes the output into the current output handler.
Deprecated. 
 
Java class for cronJobTrigger complex type.
 
 
Java class for CustomProperty complex type.
Java class for databaseAccessType.
Java class for databaseConnection complex type.
Defining an inner class to support the attributes'Map object from the original class.
Defining an inner class to support the connectionPoolingProperties'Map object from the original class.
Defining an inner class to support the extraOptions'Map object from the original class.
Defining an inner class to support the extraOptionsOrder'Map object from the original class.
An implementation of XmlAdapter that allows us to have passwords encrypted on serialization.
 
Java class for databaseType complex type.
Defining an inner class to support the DefaultOptions'Map object from the original class.
Java class for dayOfWeek.
Java class for dayOfWeekQualifier.
An ImportSource that connects to the legacy database-based solution repository.
 
 
 
 
 
 
 
 
 
 
 
The default implementation of IServiceManager
 
Default IThemeResolver implementation.
This resource manages folders in the repository and provides methods for creating new folders.
Slave Server Config for Carte Servlet running within the DI Server.
 
 
 
 
Bean which contains all the information for the email configuration
 
Configures and manage the Email configuration in the platform
Manages the email connection information
Java class for EntityAcl complex type.
Java class for anonymous complex type.
 
 
Java class for EntityMetaData complex type.
 
An implementation which determines the client type by looking of the call stack to the class which called KettleEnvironment.init() / KettleClientEnvironment.init()
 
Exception that indicates an error during import processing User: dkincade
This class is used to encode and decode file names added to or extracted from an export zip file.
Contract with ExportProcessor to know how to perform export given the parameters
The Primary Object which represents the ExportManifest XML file by the same name stored in the Repository Export zip file during a repository export.
Java class for ExportManifestDatasource complex type.
Java class for ExportManifestDto complex type.
Java class for anonymous complex type.
This Object represents the information stored in the ExportManifest for one file or folder.
Java class for ExportManifestEntityDto complex type.
Exceptions handled explicitly by this package dealing with errors in XML values that are not caught by JAXB will represented by this object.
Java class for ExportManifestMetadata complex type.
Definition of the export metadata required for a MetaStore.
Java class for ExportManifestMondrian complex type.
Java class for ExportManifestProperty complex type.
 
 
 
 
Deprecated.
Use org.pentaho.platform.plugin.services.security.userrole.ExtraRolesUserRoleListServiceDecorator
Decorates another IUserRoleListService and returns a merged list consisting of the original roles from IUserRoleListService.getAllRoles() plus the extra roles.
 
This service provides methods for listing, creating, downloading, uploading, and removal of files.
Abstract class that enables a content generator to act like a Java Bean through the IFileResourceRenderer api
 
 
 
An Axis Configurator that uses PentahoSystem to get the axis configuration file
A web service manager that only uses the file system for configuration
A plugin provider that does not rely on an the repository being configured
 
 
 
 
 
 
 
 
 
 
Transforms a GrantedAuthority into a String.
 
This is the plugin variant of the GwtRpcProxyServlet.
 
This servlet is the traffic cop for GWT services core to the BIServer.
The GwtRpcSerializationPolicyCache class is a basic in-memory, multi-threaded implementation of the IGwtRpcSerializationPolicyCache interface.
 
Contains internal utility code that supports the implementation of the classes in the org.pentaho.platform.web.gwt.rpc namespace.
 
 
 
 
 
 
 
 
 
The purpose of this Java class is to startup a HSQLDB databases.
 
A content generator for listing metadata on Axis web services.
 
Deprecated.
 
 
 
 
 
Populates the PentahoSessionHolder with information obtained from the HttpSession.
Detects when an HTTP session which contains a logged-in user (as indicated by request.getRemoteUser()) is attempting to authenticate again without logging out.
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"
 
 
 
 
This interface is a temporary solution created to keep backwards compatibility prior to 6.0
Note: This interface will be removed in 6.0
This interface is a temporary solution created to keep backwards compatibility prior to 6.0
Note: This interface will be removed in 6.0
 
 
This interface allows generation of OpenFlashChart Json
Implementations return a PDI client-type identifier (spoon,pan,carte,kitchen) or "default" if not one of those.
Deprecated.
 
This interface defines a metadata domain repository, used to maintain a system-wide set of metadata domains.
 
 
The IGwtRpcSerializationPolicyCache interface represents a cached serialization policy provider.
 
Assigns an instance number and ports to a KarafInstance
 
Deprecated.
 
A service registering/enumerating registered Mondrian catalogs (schemas).
 
Java class for ImportHandlerDto complex type.
Java class for ImportHandlerMimeTypeDefinitionsDto complex type.
General purpose objects whose lifecycle is that of an formal import session
A source of files for import operations.
A struct-like object for bundling related objects together.
Java class for incrementalRecurrence complex type.
Exception generated when any initialization is unsuccessful User: dkincade
Used to format the member given a format string.
An in-memory implementation of UserRoleListService.
 
 
This interface can be implemented to modify the connection properties before a connection is made.
This service manages the hosted OLAP connections, implemented with Mondrian, as well as other generic olap4j connections.
Representation of a catalog.
Representation of a Cube with its parent IOlapService.Schema.
Representation of a schema.
Thrown by the IOlapService when something made a boo-boo.
Possible causes of an exception in the IOlapService.
 
Class Description
Class Description
 
Implementations handle importing the given content into the Hitachi Vantara System.
Implementations handle importing content into the repository.
* Below is a sample of how to use this class to generate a log file.
The platform's service manager, IServiceManager, may delegate the handling of particular types of services to an implemention of this interface.
Allows a platform plugin to provide it's own file uploading capability which is not currently supported in IContentGenerator.
 
 
 
 
 
 
 
 
This should only be used by a plugin in the plugin.spring.xml file to initialize a Jersey.
This should only be used by a plugin in the plugin.spring.xml file to initialize a Jersey.
 
 
 
Creation-Date: 07.07.2006, 21:01:58
The JFreeReportComponent provides a simple-to-use frontend for the reporting process.
Deprecated. 
Creation-Date: 07.07.2006, 20:42:17
Deprecated. 
Creation-Date: 07.07.2006, 20:42:17
Creation-Date: 07.07.2006, 20:42:17
Deprecated. 
 
Creation-Date: 07.07.2006, 20:42:17
Deprecated.
This code has known bugs and it is highly recommended that it not be used by any sane person
Deprecated. 
Creation-Date: 07.07.2006, 20:42:17
Creation-Date: 07.07.2006, 14:06:43
Creation-Date: 07.07.2006, 20:06:56
Creation-Date: 07.07.2006, 20:42:17
Creation-Date: 07.07.2006, 20:42:17
 
Creation-Date: 07.07.2006, 16:26:25
Creation-Date: 07.07.2006, 20:42:17
Creation-Date: 07.07.2006, 20:42:17
Java class for jobScheduleRequest complex type.
Java class for jobTrigger complex type.
This Pentaho SystemListener starts the Embedded Karaf framework to support OSGI in the platform.
This class assigns and configures property settings for separate karaf instances so that multiple client/server applications can run simultaneously on the same host.
 
Simple Exception for errors when resoving a KarafInstance Created by nbaker on 3/24/16.
KettleComponent shows a list of available transformations in the root of the choosen repository.
 
 
User: rfellows Date: 10/25/11 Time: 3:53 PM
 
Executes a search against a directory context using the given filter arguments plus other static search parameters (in the form of instance variables) known at deploy time.
Wrapper to encapsulate parameters of the search method of javax.naming.directory.DirContext instances.
A factory for creating LdapSearchParams instances.
 
 
 
 
this class is used to handle .properties files that are XACTION or URL files that contain the metadata used for localization.
 
This class makes a message bundle available as a JSON hash.
 
 
 
 
 
 
This service provides methods related to mantle deeplink allowed hosts
User: nbaker Date: 7/14/13
Java class for anonymous complex type.
Java class for anonymous complex type.
 
 
 
 
 
MDXOlap4jConnection implements IPentahoConenction to support olap4j connections to any olap4j provider.
 
A helper class for the web module encapsulating web-related checks as to pass it then to the core IMessageFormatter.
 
 
 
 
 
 
 
 
 
 
 
Class Description
This is the BI Platform Pojo Component for Pentaho Metadata Queries.
 
 
Java class for MimeTypeDefinitionDto complex type.
Java class for MimeTypeDefinitionsDto complex type.
 
 
 
 
Simplification of XMLA-specific DataSourcesConfig.Catalog.
represents the entire regional cache structure for caching Mondrian Catalogs.
Represents the state of the Mondrian Catalog Cache for one region
Class to contain extra attributes that we want to connect to the Mondrian Catalog
Reads in file containing Mondrian data sources and catalogs.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
guava's elegant Catch-All-That-Fell-Thru-Cracks
Wrapper for the AsyncEventBus class.
Deprecated. 
Deprecated.
Please use MultiReadHttpServletRequestWrapper instead.
Resolves mime-types by extension.
Uses a map, defined in Spring, that maps child roles to parent roles.
For use when authorities are stored in the user object (e.g.
Immediately returns an empty list without connecting to a server.
 
This object contains factory methods for each Java content interface and Java element interface generated in the org.pentaho.platform.plugin.services.importer.mimeType.bindings package.
This object contains factory methods for each Java content interface and Java element interface generated in the org.pentaho.platform.plugin.services.importexport.exportManifest.bindings package.
 
Implementation of the IOlapService which uses the MondrianCatalogRepositoryHelper as a backend to store the connection informations and uses DriverManager to create the connections.
This component is a contribution from Nick Goodman and Tom Qin, it conforms to the ChartComponent API.
This IPentahoSystemListener is a facade for another KarafBoot.
 
Java class for Parameters complex type.
User: nbaker Date: 7/15/13
Java class for anonymous complex type.
Java class for anonymous complex type.
Java class for partitionDatabaseMeta complex type.
provides a resource for encrypting a password using the configured IPasswordService
 
 
 
Looks at the context-param named encoding in web.xml for its encoding selection.
 
PentahoBasicPostProcessingFilter is used to invalidate a browsers cached Basic-Auth credentials.
This class's sole purpose is to defeat the persistence of Basic-Auth credentials in the browser.
This class is designed to help embedded deployments start the Hitachi Vantara system
 
 
 
 
User: nbaker Date: 8/7/13 Copy of the org.springframework.security.config.CachingUserDetailsService for modification due to poor extensibility of core class.
This needs the latest CVS version of JFreeReport (0.8.7-5-cvs)...
This class provides SPI functionality to Mondrian.
Datasource Type
 
 
 
 
 
Hitachi Vantara behavior that should be invoked when a web user logs out.
PentahoMDCFilter is a Servlet filter that adds and clears MDC logging information.
 
Handles the storage and retrieval of Pentaho Metada Domain objects in a repository.
Contains information about how and where metadata information is stored in the IUnifiedRepository}
Parser for potential Pentaho Metadata Filenames from the old repository
 
Initializes folders used by Pentaho Metadata
 
 
 
 
Standard OSGI Activator class which is called when the OSGI environment is started.
This filter is designed to work around a limitation of some web servers which prohibit the encoded form of / and \ (%2F and %5C) being in the URL.
 
Default implementation of IPlatformImporter.
 
User: nbaker Date: 4/2/13
Creation-Date: 05.07.2007, 19:48:16
Populates the PentahoRequestContextHolder with context information obtained from the HttpServletRequest.
The resource-bundle factory is responsible for loading referenced resourcebundles.
Deprecated.
This is an empty stub in case we have to maintain backward compatiblity.
This class is implemented to support loading solution files from the pentaho repository into JFreeReport
This class is implemented to support loading solution files from the pentaho repository into JFreeReport
 
Deprecated.
obsolete
Overrides getResourceByPath so that relative paths are relative to the Hitachi Vantara solution repository's system directory instead of being relative to servlet context root.
 
 
An IPluginManager implementation based on registering objects to the PentahoSystem and querying for them there.
 
The PentahoTableDataFactory class implements JFreeReport's data factory and manages the TableModels provided to JFreeReport.
Defines the Module for PentahoTableDataFactory
 
Deprecated.
This is an empty stub in case we have to maintain backward compatiblity.
Creation-Date: 05.07.2007, 19:16:13
Brought over from spring-security 3.2.5, as this class no longer exists in spring-security 4.1
Brought over from spring-security 3.2.5, as this class no longer exists in spring-security 4.1
Brought over from spring-security 3.2.5, as this class no longer exists in spring-security 4.1
The wadl configurator class that extends in run time the wadl pointing to a file that adds pre-computed information
If the request is searching for a webcontext.js, it writes out the content of the webcontext.js
 
 
Filters out DataSource elements that are not XMLA-related.
 
 
User: nbaker Date: 5/29/12 modifed: tband Date: 7/9/12 1 - Publish failed 2 - General Error - 6 - Data source problem 7 - XMLA Catalog Exists 8 - XMLA Schema Exists 9 - Content exists
 
Default bean implementation of IPlatformPlugin
Access to XmlaExtra inside OSGI where M4 is running is tricky.
 
 
A custom implementation of URLClassLoader for Pentaho Platform Plugins.
Dispatches requests to Servlets provided by BIServer plugins.
 
The PluginGwtRpc class is a specialized GWT-RPC which can be used to handle remote calls to services of Pentaho Platform plugins, e.g.
The PluginGwtRpcRequestMatcher class is a specialized GWT-RPC request matcher which can be used to match URLs of GWT-RPC services of Pentaho Platform plugins (e.g.
 
 
 
Represents the public files available in a plugin.
The default implementation of the IPluginResourceLoader.
Theme resolver for platform plugins.
 
Deprecated.
Pojo components are deprecated, use IAction
PortFileManager is a singleton that saves the ports in use and creates a file with a ports list when requested.
This filter handles the assignment of IPentahoSession and Authentication based on a previously stored in the IPreAuthenticatedSessionHolder.
This class serves to capture a users IPentahoSession and Spring Authentication by assigning them a key.
 
 
 
 
 
User: nbaker Date: 4/2/13
This servlet is used to Proxy a Servlet request to another server for processing and returns that result to the caller as if this Servlet actually serviced it.
This servlet is used to filter Servlet requests coming from another server for processing and sets authentication for the user passed in by the parameter _TRUST_USER_.
This is a special handler that will extract the title and description from the meta.xml - uses the parent class s to do the rest of the lifting.
Java class for qualifiedDayOfMonth complex type.
Java class for qualifiedDayOfWeek complex type.
Java class for recurrenceList complex type.
Creation-Date: 07.07.2006, 15:49:35
The report-wizard component generates a report definition from a report-spec file.
An ImportSource.IRepositoryFileBundle that uses temporary files.
 
Repository implementation of IPlatformImportBundle.
 
User: nbaker Date: 5/29/12
 
This class was derived from Log4j HTMLLayout.
 
Publishes a content file to the repository.
 
The RepositoryResource service retrieves the repository files through various methods.
 
 
Processes Request Parameter authorization, putting the result into the SecurityContextHolder.
Used by the SecurityEnforcementFilter to commence authentication via the PentahoBasicProcessingFilter.
 
 
 
This class flattens an IPentahoResultSet by looking at a particular column.
 
 
 
Extension of LdapUserDetailsMapper which extracts the value of the component named tokenName within any attribute in roleAttributes.
 
 
 
Extracts the value of the token tokenName from the attribute attributeName.
The secure filter component has two separate but related functions.
This is the platform implementation which implements security.
This listener ensures that the Authentication system has been loaded.
Java class for sequentialRecurrence complex type.
This immutable class contains information on variable port that is assigned by this class.
 
This class holds a collection of of all server ports that are formally registered to the platform.
This serves to group ServerPort objects under an arbitrary name.
 
 
This service provides methods related to karaf instances
 
User: nbaker Date: 5/15/11
Delegates Servlet requests to a Spring-managed bean.
This row level security helper resolves SESSION("VALUE") in addition to it's parent USER() and ROLE() resolvers.
This is the platform implementation which provides session-based caching for an existing IMetadataDomainRepository.
Simple callback interface to facilitate iterating over cache keys
this as a public class so that if necessary someone can get access to a session key and clear the cache in their own way via javascript rule / etc
Callable to call IMetadataDomainRepository.getDomain(String) with some logging statement to help in debug.
Asynchronously executes a collection of tasks (ie Callable ).
Thread that sets the IPentahoSession for the thread see PentahoSessionHolder.
The SessionResource service lists the user's current workspace as well as the workspace folder path.
 
 
Example filter that sets the character encoding to be used in parsing the incoming request, either unconditionally or only if the client did not specify a character encoding.
 
This export processor should be used when single file downloads are requested
Java class for simpleJobTrigger complex type.
 
 
 
 
User: nbaker Date: 4/6/13
Spring needs to know the location of the pentaho "system" folder before startup.
Object wrapper around contents of applicationContext-spring-security-hibernate.xml.
SQLBaseComponent is the base class for SQLExecute and SQLLookupRule.
 
 
 
 
 
 
 
 
This exception just signals that an exception occurred during DB interaction
Deprecated.
Use org.pentaho.platform.plugin.services.security.userrole.ExtraRolesUserRoleListServiceDecorator
 
Converts stream of binary or character data.
 
Transforms a String into a GrantedAuthority.
 
 
User: nbaker Date: 4/2/13
 
The SystemGwtRpc class is a specialized GWT-RPC which can be used to handle remote calls to services of the Pentaho Platform itself, e.g.
The SystemGwtRpcRequestMatcher class is a specialized GWT-RPC request matcher which can be used to match URLs of GWT-RPC services of the Pentaho Platform itself (e.g.
Created by nbaker on 2/4/15.
An implementation of IPluginProvider that searches for plugin.xml files in the Pentaho system path and instantiates IPlatformPlugins from the information in those files.
 
This resource is responsible for refreshing different system components (metadata, mondrian etc.)
This api provides methods for discovering information about the system
 
 
Service class for System endpoints
User: nbaker Date: 4/2/13
This class provides axis with its configuration information from the file axis/axis2_config.xml in the pentaho system solutions folder.
The purpose of this filter is to check to make sure that the platform is properly initialized before letting requests in.
This service allows for listing system users in the BA Platform.
 
Deprecated.
This class is no longer used.
 
User: nbaker Date: 8/1/13
 
 
Resource manages themes for the platform
Writes out the current Theme Tree out as Javascript.
The ThrowingSupplier represents a supplier of a value, of type T which, when failing, throws an exception of type E.
 
 
Deprecated.
Due to the PPP-3963
 
Delegates to populators and unions the results.
Iterates over LdapSearch instances in searches and unions the results.
 
 
 
 
The UserConsoleResource service provides both shared and user-specific state or settings related with the use of the Pentaho User Console.
 
 
 
Takes as input the string that defines a UserMap.
Specialization of J2eePreAuthenticatedProcessingFilter where UsernameSubstringPreAuthenticatedProcessingFilter.getPreAuthenticatedPrincipal(HttpServletRequest) optionally extracts a substring of the user principal to use as the return value.
UserRoleDao manages Pentaho Security user and roles in the BA platform.
 
 
 
 
Property editor to assist with the setup of a UserRoleListEnhancedUserMap.
Takes as input the string that defines a UserMap.
The UserRoleListResource service lists roles, permissions, and users.
 
 
This resource manages the user settings of the platform.
 
Provides utilities to help manipulate parameters used in action sequences.
This resource manages version checking capability of the platform
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"
 
Populates the PentahoRequestContextHolder with context information obtained from the HttpServletRequest.
 
Performs the action of processing a webservice call in an action by doing the same functionality as the XQuery action (but not trying to retrieve the column types).
This class should be used to configure a websocket endpoint in platform plugins.
This factory implementation can be used in a web environment in which a Spring WebApplicationContext has already been created during initialization of the web application.
 
Utility class containing web related functionality.
 
 
 
 
 
 
 
Utility class for converting between XMLGregorianCalendar and java.util.Date
 
 
 
XQueryBaseComponent provides a mechanism to run xqueries within the Pentaho BI Platform.