public class PentahoSystem extends Object
Constructor and Description |
---|
PentahoSystem() |
Modifier and Type | Method and Description |
---|---|
static void |
addInitializationFailureMessage(int failureBit,
String message) |
static void |
addLogoutListener(org.pentaho.platform.api.engine.ILogoutListener listener) |
static void |
clearGlobals() |
static void |
clearObjectFactory() |
static Object |
createObject(String className)
Deprecated.
|
static Object |
createObject(String className,
org.pentaho.platform.api.engine.ILogger logger)
Deprecated.
|
static boolean |
deregisterObjectFactory(org.pentaho.platform.api.engine.IPentahoObjectFactory factory)
De-Register an ObjectFactory
|
static <T> T |
get(Class<T> interfaceClass)
A convenience method for retrieving Pentaho system objects from the object factory.
|
static <T> T |
get(Class<T> interfaceClass,
org.pentaho.platform.api.engine.IPentahoSession session)
A convenience method for retrieving Pentaho system objects from the object factory implementing or extending the
given Class literal
get(Class, String, IPentahoSession) . |
static <T> T |
get(Class<T> interfaceClass,
org.pentaho.platform.api.engine.IPentahoSession session,
Map<String,String> properties)
A convenience method for retrieving Pentaho system objects from the object factory.
|
static <T> T |
get(Class<T> interfaceClass,
String key,
org.pentaho.platform.api.engine.IPentahoSession session)
A convenience method for retrieving Pentaho system objects from the object factory.
|
static List |
getACLFileExtensionList() |
static <T> List<T> |
getAll(Class<T> interfaceClass)
A convenience method for retrieving Pentaho system objects from the object factory.
|
static <T> List<T> |
getAll(Class<T> interfaceClass,
org.pentaho.platform.api.engine.IPentahoSession session)
A convenience method for retrieving Pentaho system objects from the object factory.
|
static <T> List<T> |
getAll(Class<T> interfaceClass,
org.pentaho.platform.api.engine.IPentahoSession session,
Map<String,String> props)
Retrieves objects from the object factory registered to the PentahoSystem implementing or extending the given Class
literal
|
static org.pentaho.platform.api.engine.IApplicationContext |
getApplicationContext() |
static org.pentaho.platform.api.engine.ICacheManager |
getCacheManager(org.pentaho.platform.api.engine.IPentahoSession session) |
static List |
getDownloadRolesList() |
static org.pentaho.platform.api.engine.IParameterProvider |
getGlobalParameters() |
static List<String> |
getInitializationFailureMessages() |
static boolean |
getInitializedOK() |
static int |
getInitializedStatus() |
static org.pentaho.platform.api.engine.IPentahoObjectFactory |
getObjectFactory()
Gets the factory that will create and manage Pentaho system objects.
|
static <T> org.pentaho.platform.api.engine.IPentahoObjectReference<T> |
getObjectReference(Class<T> interfaceClass,
org.pentaho.platform.api.engine.IPentahoSession curSession)
Returns an IPentahoObjectReference for the requested Object containing registered Object Properties.
|
static <T> org.pentaho.platform.api.engine.IPentahoObjectReference<T> |
getObjectReference(Class<T> interfaceClass,
org.pentaho.platform.api.engine.IPentahoSession curSession,
Map<String,String> properties)
Returns an IPentahoObjectReference for the requested Object containing registered Object Properties.
|
static <T> List<org.pentaho.platform.api.engine.IPentahoObjectReference<T>> |
getObjectReferences(Class<T> interfaceClass,
org.pentaho.platform.api.engine.IPentahoSession curSession) |
static <T> List<org.pentaho.platform.api.engine.IPentahoObjectReference<T>> |
getObjectReferences(Class<T> interfaceClass,
org.pentaho.platform.api.engine.IPentahoSession curSession,
Map<String,String> properties) |
static org.pentaho.platform.api.engine.IContentOutputHandler |
getOutputDestinationFromContentRef(String contentTag,
org.pentaho.platform.api.engine.IPentahoSession session) |
static List |
getPublisherList() |
static org.dom4j.Document |
getPublishersDocument() |
static String |
getSystemName() |
static String |
getSystemSetting(String settingName,
String defaultValue) |
static String |
getSystemSetting(String path,
String settingName,
String defaultValue) |
static org.pentaho.platform.api.engine.ISystemSettings |
getSystemSettings() |
static void |
globalStartup() |
static void |
globalStartup(org.pentaho.platform.api.engine.IPentahoSession session) |
static boolean |
init() |
static boolean |
init(org.pentaho.platform.api.engine.IApplicationContext pApplicationContext) |
static boolean |
init(org.pentaho.platform.api.engine.IApplicationContext pApplicationContext,
Map listenerMap) |
static void |
invokeLogoutListeners(org.pentaho.platform.api.engine.IPentahoSession session) |
static String |
publish(org.pentaho.platform.api.engine.IPentahoSession session,
String className) |
static Object |
putInGlobalAttributesMap(Object key,
Object value) |
static void |
refreshSettings() |
static org.pentaho.platform.api.engine.IPentahoObjectRegistration |
registerObject(Object obj)
This static method shadows the one defined here:
.IPentahoRegistrableObjectFactory#registerObject(Object) |
static org.pentaho.platform.api.engine.IPentahoObjectRegistration |
registerObject(Object obj,
org.pentaho.platform.api.engine.IPentahoRegistrableObjectFactory.Types types)
This static method shadows the one defined here:
.IPentahoRegistrableObjectFactory#registerObject(Object, org.pentaho.platform.api.engine .IPentahoRegistrableObjectFactory.Types) |
static <T> org.pentaho.platform.api.engine.IPentahoObjectRegistration |
registerObject(T obj,
Class<?>... classes)
This static method shadows the one defined here:
.IPentahoRegistrableObjectFactory#registerObject(Object, Class[]) |
static void |
registerObjectFactory(org.pentaho.platform.api.engine.IPentahoObjectFactory pentahoObjectFactory)
Registers the factory that will create and manage Pentaho system objects.
|
static void |
registerPrimaryObjectFactory(org.pentaho.platform.api.engine.IPentahoObjectFactory pentahoObjectFactory)
Registers the primary factory that will create and manage Pentaho system objects.
|
static <T> org.pentaho.platform.api.engine.IPentahoObjectRegistration |
registerReference(org.pentaho.platform.api.engine.IPentahoObjectReference<T> reference)
IPentahoRegistrableObjectFactory.registerReference(org.pentaho.platform.api.engine.IPentahoObjectReference) |
static <T> org.pentaho.platform.api.engine.IPentahoObjectRegistration |
registerReference(org.pentaho.platform.api.engine.IPentahoObjectReference<T> reference,
Class<?>... classes)
This static method shadows the one defined here:
.IPentahoRegistrableObjectFactory#registerReference(org.pentaho.platform.api.engine.IPentahoObjectReference, Class[]) |
static <T> org.pentaho.platform.api.engine.IPentahoObjectRegistration |
registerReference(org.pentaho.platform.api.engine.IPentahoObjectReference<T> reference,
org.pentaho.platform.api.engine.IPentahoRegistrableObjectFactory.Types types)
This static method shadows the one defined here:
.IPentahoRegistrableObjectFactory#registerReference(org.pentaho.platform.api.engine.IPentahoObjectReference, org.pentaho.platform.api.engine .IPentahoRegistrableObjectFactory.Types) |
static org.pentaho.platform.api.engine.ILogoutListener |
remove(org.pentaho.platform.api.engine.ILogoutListener listener) |
static Object |
removeFromGlobalAttributesMap(Object key) |
static void |
sessionStartup(org.pentaho.platform.api.engine.IPentahoSession session) |
static void |
sessionStartup(org.pentaho.platform.api.engine.IPentahoSession session,
org.pentaho.platform.api.engine.IParameterProvider sessionParameters) |
static void |
setAdministrationPlugins(List<org.pentaho.platform.api.engine.IPentahoPublisher> administrationPlugins)
Registers administrative capabilities that can be invoked later via
publish(IPentahoSession, String) |
static void |
setApplicationContext(org.pentaho.platform.api.engine.IApplicationContext pApplicationContext) |
static void |
setBundleContext(org.osgi.framework.BundleContext context) |
static void |
setSessionStartupActions(List<org.pentaho.platform.api.engine.ISessionStartupAction> actions)
Registers server actions that will be invoked when a session is created.
|
static void |
setSystemListeners(List<org.pentaho.platform.api.engine.IPentahoSystemListener> systemListeners)
Registers custom handlers that are notified of both system startup and system shutdown events.
|
static void |
setSystemSettingsService(org.pentaho.platform.api.engine.ISystemSettings systemSettingsService)
Sets the system settings service: the means by which the platform obtains it's overall system settings.
|
static void |
shutdown() |
static void |
systemEntryPoint() |
static void |
systemExitPoint() |
public static final boolean debug
public static final boolean trace
public static final boolean ignored
public static final String JAVA_SYSTEM_PROPERTIES
public static int loggingLevel
protected static final String CONTENT_REPOSITORY
protected static final String RUNTIME_REPOSITORY
protected static final String SOLUTION_ENGINE
public static final String BACKGROUND_EXECUTION
public static final String CONDITIONAL_EXECUTION
public static String DEFAULT_CONDITIONAL_EXECUTION_PROVIDER
public static String DEFAULT_MESSAGE_FORMATTER
public static final String SCHEDULER
public static final String MESSAGE_FORMATTER
public static final String SCOPE_GLOBAL
public static final String SCOPE_SESSION
public static final String SCOPE_LOCAL
public static final String SCOPE
public static final String PENTAHO_SESSION_KEY
public static final String WAIT_SECONDS
public static final String CORS_REQUESTS_ALLOWED
public static final String CORS_REQUESTS_ALLOWED_DOMAINS
public static final int SYSTEM_NOT_INITIALIZED
public static final int SYSTEM_INITIALIZED_OK
public static final int SYSTEM_LISTENERS_FAILED
public static final int SYSTEM_OBJECTS_FAILED
public static final int SYSTEM_PUBLISHERS_FAILED
public static final int SYSTEM_AUDIT_FAILED
public static final int SYSTEM_PENTAHOXML_FAILED
public static final int SYSTEM_SETTINGS_FAILED
public static final int SYSTEM_OTHER_FAILED
public static final String HIDE_USER_HOME_FOLDER_ON_CREATION_PROPERTY
public static void setBundleContext(org.osgi.framework.BundleContext context)
public static boolean init()
public static boolean init(org.pentaho.platform.api.engine.IApplicationContext pApplicationContext)
public static boolean init(org.pentaho.platform.api.engine.IApplicationContext pApplicationContext, Map listenerMap)
public static boolean getInitializedOK()
public static int getInitializedStatus()
public static void addInitializationFailureMessage(int failureBit, String message)
public static org.pentaho.platform.api.engine.IContentOutputHandler getOutputDestinationFromContentRef(String contentTag, org.pentaho.platform.api.engine.IPentahoSession session)
public static <T> T get(Class<T> interfaceClass)
interfaceClass
as the object key in
get(Class, String, IPentahoSession)
. NOTE: session will be derived for you by using
PentahoSessionHolder, so a session must already have been bound to the thread local in PentahoSessionHolder in
order for you to be able to access session-bound objects.public static <T> T get(Class<T> interfaceClass, org.pentaho.platform.api.engine.IPentahoSession session, Map<String,String> properties)
interfaceClass
as the object key in get(Class, IPentahoSession, Map)
. NOTE: session will be derived for you by using PentahoSessionHolder, so a session must already have been bound to
the thread local in PentahoSessionHolder in order for you to be able to access session-bound objects.public static <T> List<T> getAll(Class<T> interfaceClass)
interfaceClass
as the object key in getAll(Class, IPentahoSession)
.
NOTE: session will be derived for you by using PentahoSessionHolder, so a session must already have been bound to
the thread local in PentahoSessionHolder in order for you to be able to access session-bound objects.public static <T> List<T> getAll(Class<T> interfaceClass, org.pentaho.platform.api.engine.IPentahoSession session)
interfaceClass
as the object key in getAll(Class, IPentahoSession)
.
NOTE: session will be derived for you by using PentahoSessionHolder, so a session must already have been bound to
the thread local in PentahoSessionHolder in order for you to be able to access session-bound objects.public static <T> List<T> getAll(Class<T> interfaceClass, org.pentaho.platform.api.engine.IPentahoSession session, Map<String,String> props)
public static <T> T get(Class<T> interfaceClass, org.pentaho.platform.api.engine.IPentahoSession session)
get(Class, String, IPentahoSession)
.public static <T> T get(Class<T> interfaceClass, String key, org.pentaho.platform.api.engine.IPentahoSession session)
null
if the object could not be
retrieved for any reason. If the object is defined but for some reason can not be retrieved, an error message will
be logged.null
if either the object was not configured or it was
configured but there was a problem retrieving it.getObjectFactory()
,
IPentahoObjectFactory.get(Class, String, IPentahoSession)
public static <T> org.pentaho.platform.api.engine.IPentahoObjectReference<T> getObjectReference(Class<T> interfaceClass, org.pentaho.platform.api.engine.IPentahoSession curSession)
interfaceClass
- Interface or Class literal for which implementations of will be foundcurSession
- current session to be used for session-based implementationspublic static <T> org.pentaho.platform.api.engine.IPentahoObjectReference<T> getObjectReference(Class<T> interfaceClass, org.pentaho.platform.api.engine.IPentahoSession curSession, Map<String,String> properties)
interfaceClass
- Interface or Class literal for which implementations of will be foundcurSession
- current session to be used for session-based implementationsproperties
- Map of properties to filter matches in the ObjectFactory bypublic static <T> List<org.pentaho.platform.api.engine.IPentahoObjectReference<T>> getObjectReferences(Class<T> interfaceClass, org.pentaho.platform.api.engine.IPentahoSession curSession)
public static <T> List<org.pentaho.platform.api.engine.IPentahoObjectReference<T>> getObjectReferences(Class<T> interfaceClass, org.pentaho.platform.api.engine.IPentahoSession curSession, Map<String,String> properties)
public static String getSystemName()
public static org.pentaho.platform.api.engine.IParameterProvider getGlobalParameters()
public static void sessionStartup(org.pentaho.platform.api.engine.IPentahoSession session)
public static void clearGlobals()
public static void sessionStartup(org.pentaho.platform.api.engine.IPentahoSession session, org.pentaho.platform.api.engine.IParameterProvider sessionParameters)
public static void globalStartup()
public static void globalStartup(org.pentaho.platform.api.engine.IPentahoSession session)
public static void shutdown()
public static org.pentaho.platform.api.engine.IApplicationContext getApplicationContext()
public static void setApplicationContext(org.pentaho.platform.api.engine.IApplicationContext pApplicationContext)
@Deprecated public static Object createObject(String className, org.pentaho.platform.api.engine.ILogger logger)
@Deprecated public static Object createObject(String className)
public static String getSystemSetting(String path, String settingName, String defaultValue)
public static org.pentaho.platform.api.engine.ISystemSettings getSystemSettings()
public static void refreshSettings()
public static String publish(org.pentaho.platform.api.engine.IPentahoSession session, String className)
public static List getPublisherList()
public static org.dom4j.Document getPublishersDocument()
public static void systemEntryPoint()
public static void systemExitPoint()
public static org.pentaho.platform.api.engine.ICacheManager getCacheManager(org.pentaho.platform.api.engine.IPentahoSession session)
public static List getACLFileExtensionList()
public static List getDownloadRolesList()
public static void addLogoutListener(org.pentaho.platform.api.engine.ILogoutListener listener)
public static org.pentaho.platform.api.engine.ILogoutListener remove(org.pentaho.platform.api.engine.ILogoutListener listener)
public static void invokeLogoutListeners(org.pentaho.platform.api.engine.IPentahoSession session)
public static org.pentaho.platform.api.engine.IPentahoObjectFactory getObjectFactory()
public static void registerObjectFactory(org.pentaho.platform.api.engine.IPentahoObjectFactory pentahoObjectFactory)
pentahoObjectFactory
- the factorypublic static boolean deregisterObjectFactory(org.pentaho.platform.api.engine.IPentahoObjectFactory factory)
factory
- public static void registerPrimaryObjectFactory(org.pentaho.platform.api.engine.IPentahoObjectFactory pentahoObjectFactory)
pentahoObjectFactory
- the factorypublic static void setAdministrationPlugins(List<org.pentaho.platform.api.engine.IPentahoPublisher> administrationPlugins)
publish(IPentahoSession, String)
administrationPlugins
- a list of admin functions to registerpublic static void setSystemListeners(List<org.pentaho.platform.api.engine.IPentahoSystemListener> systemListeners)
systemListeners
- the system event handlerspublic static void setSessionStartupActions(List<org.pentaho.platform.api.engine.ISessionStartupAction> actions)
IPentahoSession
implementation whether to advise the system of it's creation via
sessionStartup(IPentahoSession)
.actions
- the server actions to execute on session startuppublic static void setSystemSettingsService(org.pentaho.platform.api.engine.ISystemSettings systemSettingsService)
systemSettingsService
- the settings servicepublic static void clearObjectFactory()
public static <T> org.pentaho.platform.api.engine.IPentahoObjectRegistration registerReference(org.pentaho.platform.api.engine.IPentahoObjectReference<T> reference, org.pentaho.platform.api.engine.IPentahoRegistrableObjectFactory.Types types)
.IPentahoRegistrableObjectFactory#registerReference(org.pentaho.platform.api.engine.IPentahoObjectReference, org.pentaho.platform.api.engine .IPentahoRegistrableObjectFactory.Types)
T
- reference
- types
- public static org.pentaho.platform.api.engine.IPentahoObjectRegistration registerObject(Object obj)
.IPentahoRegistrableObjectFactory#registerObject(Object)
obj
- public static org.pentaho.platform.api.engine.IPentahoObjectRegistration registerObject(Object obj, org.pentaho.platform.api.engine.IPentahoRegistrableObjectFactory.Types types)
.IPentahoRegistrableObjectFactory#registerObject(Object, org.pentaho.platform.api.engine .IPentahoRegistrableObjectFactory.Types)
obj
- types
- public static <T> org.pentaho.platform.api.engine.IPentahoObjectRegistration registerReference(org.pentaho.platform.api.engine.IPentahoObjectReference<T> reference)
IPentahoRegistrableObjectFactory.registerReference(org.pentaho.platform.api.engine.IPentahoObjectReference)
T
- reference
- public static <T> org.pentaho.platform.api.engine.IPentahoObjectRegistration registerObject(T obj, Class<?>... classes)
.IPentahoRegistrableObjectFactory#registerObject(Object, Class[])
obj
- classes
- public static <T> org.pentaho.platform.api.engine.IPentahoObjectRegistration registerReference(org.pentaho.platform.api.engine.IPentahoObjectReference<T> reference, Class<?>... classes)
.IPentahoRegistrableObjectFactory#registerReference(org.pentaho.platform.api.engine.IPentahoObjectReference, Class[])
T
- reference
- classes
- Copyright © 2019 Hitachi Vantara. All rights reserved.