org.pentaho.platform.engine.core.system
Class PentahoSystem

java.lang.Object
  org.pentaho.platform.engine.core.system.PentahoSystem

public class PentahoSystem
extends Object

Field Summary

static String	BACKGROUND_EXECUTION
static String	CONDITIONAL_EXECUTION
static boolean	debug
static String	DEFAULT_CONDITIONAL_EXECUTION_PROVIDER
static String	DEFAULT_MESSAGE_FORMATTER
static String	DEFAULT_NAVIGATION_COMPONENT
static boolean	ignored
static int	loggingLevel
static String	MESSAGE_FORMATTER
static String	NAVIGATION_COMPONENT
static String	PENTAHO_SESSION_KEY
static String	SCHEDULER
static String	SCOPE
static String	SCOPE_GLOBAL
static String	SCOPE_LOCAL
static String	SCOPE_SESSION
static int	SYSTEM_AUDIT_FAILED
static int	SYSTEM_INITIALIZED_OK
static int	SYSTEM_LISTENERS_FAILED
static int	SYSTEM_NOT_INITIALIZED
static int	SYSTEM_OBJECTS_FAILED
static int	SYSTEM_PENTAHOXML_FAILED
static int	SYSTEM_PUBLISHERS_FAILED
static int	SYSTEM_SETTINGS_FAILED
static boolean	trace

Constructor Summary

PentahoSystem()

Method Summary

static void	addInitializationFailureMessage(int failureBit, String message)
static void	addLogoutListener(ILogoutListener listener)
static void	clearGlobals()
static Object	createObject(String className) Deprecated.
static Object	createObject(String className, ILogger logger) Deprecated.
static <T> T	get(Class<T> interfaceClass, IPentahoSession session) A convenience method for retrieving Pentaho system objects from the object factory.
static <T> T	get(Class<T> interfaceClass, String key, IPentahoSession session) A convenience method for retrieving Pentaho system objects from the object factory.
static List	getACLFileExtensionList()
static IAclPublisher	getAclPublisher(IPentahoSession session) Deprecated.
static IAclVoter	getAclVoter(IPentahoSession session) Deprecated.
static IApplicationContext	getApplicationContext()
static ICacheManager	getCacheManager(IPentahoSession session)
static IConditionalExecution	getConditionalExecutionHandler(IPentahoSession session) Deprecated.
static IContentRepository	getContentRepository(IPentahoSession session) Deprecated.
static IParameterProvider	getGlobalParameters()
static List	getInitializationFailureMessages()
static boolean	getInitializedOK()
static int	getInitializedStatus()
static IMessageFormatter	getMessageFormatter(IPentahoSession session) Deprecated.
static INavigationComponent	getNavigationComponent(IPentahoSession session) Deprecated.
static Object	getObject(IPentahoSession session, String objectName) Deprecated.
static IPentahoObjectFactory	getObjectFactory() Gets the factory that will create and manage Pentaho system objects.
static IContentOutputHandler	getOutputDestinationFromContentRef(String contentTag, IPentahoSession session)
static List	getPublisherList()
static Document	getPublishersDocument()
static IRuntimeRepository	getRuntimeRepository(IPentahoSession session) Deprecated.
static IScheduler	getScheduler(IPentahoSession session) Deprecated.
static ISolutionEngine	getSolutionEngineInstance(IPentahoSession session) Deprecated.
static ISolutionRepository	getSolutionRepository(IPentahoSession session) Deprecated.
static ISubscriptionRepository	getSubscriptionRepository(IPentahoSession session) Deprecated.
static ISubscriptionScheduler	getSubscriptionScheduler(IPentahoSession session) Deprecated.
static String	getSystemName()
static String	getSystemSetting(String settingName, String defaultValue)
static String	getSystemSetting(String path, String settingName, String defaultValue)
static ISystemSettings	getSystemSettings()
static IUITemplater	getUITemplater(IPentahoSession session) Deprecated.
static IUserDetailsRoleListService	getUserDetailsRoleListService()
static IXMLComponent	getUserFilesComponent(IPentahoSession session) Deprecated.
static IUserSettingService	getUserSettingService(IPentahoSession session) Deprecated.
static IVersionHelper	getVersionHelper(IPentahoSession session) Deprecated.
static void	globalStartup(IPentahoSession session)
static boolean	init(IApplicationContext pApplicationContext)
static boolean	init(IApplicationContext pApplicationContext, Map listenerMap)
static void	invokeLogoutListeners(IPentahoSession session)
static String	publish(IPentahoSession session, String className)
static Object	putInGlobalAttributesMap(Object key, Object value)
static void	refreshSettings()
static ILogoutListener	remove(ILogoutListener listener)
static Object	removeFromGlobalAttributesMap(Object key)
static void	sessionStartup(IPentahoSession session)
static void	sessionStartup(IPentahoSession session, IParameterProvider sessionParameters)
static void	setAdministrationPlugins(List<IPentahoPublisher> administrationPlugins) Registers administrative capabilities that can be invoked later via publish(IPentahoSession, String)
static void	setObjectFactory(IPentahoObjectFactory pentahoObjectFactory) Registers the factory that will create and manage Pentaho system objects.
static void	setSessionStartupActions(List<ISessionStartupAction> actions) Registers server actions that will be invoked when a session is created.
static void	setSystemListeners(List<IPentahoSystemListener> systemListeners) Registers custom handlers that are notified of both system startup and system shutdown events.
static void	setSystemSettingsService(ISystemSettings systemSettingsService) Sets the system settings service: the means by which the platform obtains it's overall system settings.
static void	setUserDetailsRoleListService(IUserDetailsRoleListService value)
static void	shutdown()
static void	systemEntryPoint()
static void	systemExitPoint()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

debug

public static final boolean debug

See Also:

Constant Field Values

trace

public static final boolean trace

See Also:

Constant Field Values

ignored

public static final boolean ignored

See Also:

Constant Field Values

loggingLevel

public static int loggingLevel

BACKGROUND_EXECUTION

public static final String BACKGROUND_EXECUTION

See Also:

Constant Field Values

CONDITIONAL_EXECUTION

public static final String CONDITIONAL_EXECUTION

See Also:

Constant Field Values

DEFAULT_CONDITIONAL_EXECUTION_PROVIDER

public static String DEFAULT_CONDITIONAL_EXECUTION_PROVIDER

DEFAULT_MESSAGE_FORMATTER

public static String DEFAULT_MESSAGE_FORMATTER

DEFAULT_NAVIGATION_COMPONENT

public static String DEFAULT_NAVIGATION_COMPONENT

SCHEDULER

public static final String SCHEDULER

See Also:

Constant Field Values

MESSAGE_FORMATTER

public static final String MESSAGE_FORMATTER

See Also:

Constant Field Values

NAVIGATION_COMPONENT

public static final String NAVIGATION_COMPONENT

See Also:

Constant Field Values

SCOPE_GLOBAL

public static final String SCOPE_GLOBAL

See Also:

Constant Field Values

SCOPE_SESSION

public static final String SCOPE_SESSION

See Also:

Constant Field Values

SCOPE_LOCAL

public static final String SCOPE_LOCAL

See Also:

Constant Field Values

SCOPE

public static final String SCOPE

See Also:

Constant Field Values

PENTAHO_SESSION_KEY

public static final String PENTAHO_SESSION_KEY

See Also:

Constant Field Values

SYSTEM_NOT_INITIALIZED

public static final int SYSTEM_NOT_INITIALIZED

See Also:

Constant Field Values

SYSTEM_INITIALIZED_OK

public static final int SYSTEM_INITIALIZED_OK

See Also:

Constant Field Values

SYSTEM_LISTENERS_FAILED

public static final int SYSTEM_LISTENERS_FAILED

SYSTEM_OBJECTS_FAILED

public static final int SYSTEM_OBJECTS_FAILED

SYSTEM_PUBLISHERS_FAILED

public static final int SYSTEM_PUBLISHERS_FAILED

SYSTEM_AUDIT_FAILED

public static final int SYSTEM_AUDIT_FAILED

SYSTEM_PENTAHOXML_FAILED

public static final int SYSTEM_PENTAHOXML_FAILED

SYSTEM_SETTINGS_FAILED

public static final int SYSTEM_SETTINGS_FAILED

Constructor Detail

PentahoSystem

public PentahoSystem()

Method Detail

init

public static boolean init(IApplicationContext pApplicationContext)

init

public static boolean init(IApplicationContext pApplicationContext,
                           Map listenerMap)

getInitializedOK

public static boolean getInitializedOK()

getInitializedStatus

public static int getInitializedStatus()

getInitializationFailureMessages

public static List getInitializationFailureMessages()

addInitializationFailureMessage

public static void addInitializationFailureMessage(int failureBit,
                                                   String message)

getVersionHelper

@Deprecated
public static IVersionHelper getVersionHelper(IPentahoSession session)

Deprecated.

getUITemplater

@Deprecated
public static IUITemplater getUITemplater(IPentahoSession session)

Deprecated.

getUserFilesComponent

@Deprecated
public static IXMLComponent getUserFilesComponent(IPentahoSession session)

Deprecated.

getOutputDestinationFromContentRef

public static IContentOutputHandler getOutputDestinationFromContentRef(String contentTag,
                                                                       IPentahoSession session)

getObject

public static Object getObject(IPentahoSession session,
                               String objectName)

Deprecated.

Please use get(Class, IPentahoSession) or get(Class, String, IPentahoSession) instead.

get

public static <T> T get(Class<T> interfaceClass,
                        IPentahoSession session)

A convenience method for retrieving Pentaho system objects from the object factory.

get

public static <T> T get(Class<T> interfaceClass,
                        String key,
                        IPentahoSession session)

A convenience method for retrieving Pentaho system objects from the object factory.

getSystemName

public static String getSystemName()

getGlobalParameters

public static IParameterProvider getGlobalParameters()

sessionStartup

public static void sessionStartup(IPentahoSession session)

clearGlobals

public static void clearGlobals()

putInGlobalAttributesMap

public static Object putInGlobalAttributesMap(Object key,
                                              Object value)

removeFromGlobalAttributesMap

public static Object removeFromGlobalAttributesMap(Object key)

sessionStartup

public static void sessionStartup(IPentahoSession session,
                                  IParameterProvider sessionParameters)

globalStartup

public static void globalStartup(IPentahoSession session)

shutdown

public static void shutdown()

getApplicationContext

public static IApplicationContext getApplicationContext()

getSolutionEngineInstance

@Deprecated
public static ISolutionEngine getSolutionEngineInstance(IPentahoSession session)

Deprecated.

getContentRepository

@Deprecated
public static IContentRepository getContentRepository(IPentahoSession session)

Deprecated.

getSolutionRepository

@Deprecated
public static ISolutionRepository getSolutionRepository(IPentahoSession session)

Deprecated.

getRuntimeRepository

@Deprecated
public static IRuntimeRepository getRuntimeRepository(IPentahoSession session)

Deprecated.

getAclPublisher

@Deprecated
public static IAclPublisher getAclPublisher(IPentahoSession session)

Deprecated.

getAclVoter

@Deprecated
public static IAclVoter getAclVoter(IPentahoSession session)

Deprecated.

getSubscriptionRepository

@Deprecated
public static ISubscriptionRepository getSubscriptionRepository(IPentahoSession session)

Deprecated.

getSubscriptionScheduler

@Deprecated
public static ISubscriptionScheduler getSubscriptionScheduler(IPentahoSession session)

Deprecated.

getUserSettingService

@Deprecated
public static IUserSettingService getUserSettingService(IPentahoSession session)

Deprecated.

createObject

@Deprecated
public static Object createObject(String className,
                                             ILogger logger)

Deprecated.

setUserDetailsRoleListService

public static void setUserDetailsRoleListService(IUserDetailsRoleListService value)

getUserDetailsRoleListService

public static IUserDetailsRoleListService getUserDetailsRoleListService()

createObject

@Deprecated
public static Object createObject(String className)

Deprecated.

getSystemSetting

public static String getSystemSetting(String path,
                                      String settingName,
                                      String defaultValue)

getSystemSetting

public static String getSystemSetting(String settingName,
                                      String defaultValue)

getSystemSettings

public static ISystemSettings getSystemSettings()

refreshSettings

public static void refreshSettings()

publish

public static String publish(IPentahoSession session,
                             String className)

getPublisherList

public static List getPublisherList()

getPublishersDocument

public static Document getPublishersDocument()

systemEntryPoint

public static void systemEntryPoint()

systemExitPoint

public static void systemExitPoint()

getCacheManager

public static ICacheManager getCacheManager(IPentahoSession session)

getACLFileExtensionList

public static List getACLFileExtensionList()

addLogoutListener

public static void addLogoutListener(ILogoutListener listener)

remove

public static ILogoutListener remove(ILogoutListener listener)

invokeLogoutListeners

public static void invokeLogoutListeners(IPentahoSession session)

getScheduler

@Deprecated
public static IScheduler getScheduler(IPentahoSession session)

Deprecated.

getConditionalExecutionHandler

@Deprecated
public static IConditionalExecution getConditionalExecutionHandler(IPentahoSession session)

Deprecated.

getMessageFormatter

@Deprecated
public static IMessageFormatter getMessageFormatter(IPentahoSession session)

Deprecated.

getNavigationComponent

@Deprecated
public static INavigationComponent getNavigationComponent(IPentahoSession session)

Deprecated.

getObjectFactory

public static IPentahoObjectFactory getObjectFactory()

Gets the factory that will create and manage Pentaho system objects.

Returns:

the factory

setObjectFactory

public static void setObjectFactory(IPentahoObjectFactory pentahoObjectFactory)

Registers the factory that will create and manage Pentaho system objects.

Parameters:

pentahoObjectFactory - the factory

setAdministrationPlugins

public static void setAdministrationPlugins(List<IPentahoPublisher> administrationPlugins)

Registers administrative capabilities that can be invoked later via publish(IPentahoSession, String)

Parameters:

administrationPlugins - a list of admin functions to register

setSystemListeners

public static void setSystemListeners(List<IPentahoSystemListener> systemListeners)

Registers custom handlers that are notified of both system startup and system shutdown events.

Parameters:

systemListeners - the system event handlers

setSessionStartupActions

public static void setSessionStartupActions(List<ISessionStartupAction> actions)

Registers server actions that will be invoked when a session is created. NOTE: it is completely up to the IPentahoSession implementation whether to advise the system of it's creation via sessionStartup(IPentahoSession).

Parameters:

actions - the server actions to execute on session startup

setSystemSettingsService

public static void setSystemSettingsService(ISystemSettings systemSettingsService)

Sets the system settings service: the means by which the platform obtains it's overall system settings.

Parameters:

systemSettingsService - the settings service