|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.pentaho.platform.engine.core.system.PentahoSystem
public class PentahoSystem
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_OTHER_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
|
get(Class<T> interfaceClass)
A convenience method for retrieving Pentaho system objects from the object factory. |
|
static
|
get(Class<T> interfaceClass,
IPentahoSession session)
A convenience method for retrieving Pentaho system objects from the object factory. |
|
static
|
get(Class<T> interfaceClass,
String key,
IPentahoSession session)
A convenience method for retrieving Pentaho system objects from the object factory. |
|
static List |
getACLFileExtensionList()
|
|
static IApplicationContext |
getApplicationContext()
|
|
static ICacheManager |
getCacheManager(IPentahoSession session)
|
|
static IParameterProvider |
getGlobalParameters()
|
|
static List |
getInitializationFailureMessages()
|
|
static boolean |
getInitializedOK()
|
|
static int |
getInitializedStatus()
|
|
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 org.dom4j.Document |
getPublishersDocument()
|
|
static String |
getSystemName()
|
|
static String |
getSystemSetting(String settingName,
String defaultValue)
|
|
static String |
getSystemSetting(String path,
String settingName,
String defaultValue)
|
|
static ISystemSettings |
getSystemSettings()
|
|
static IUserDetailsRoleListService |
getUserDetailsRoleListService()
|
|
static void |
globalStartup()
|
|
static void |
globalStartup(IPentahoSession session)
|
|
static boolean |
init()
|
|
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 |
---|
public static final boolean debug
public static final boolean trace
public static final boolean ignored
public static int loggingLevel
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 String DEFAULT_NAVIGATION_COMPONENT
public static final String SCHEDULER
public static final String MESSAGE_FORMATTER
public static final String NAVIGATION_COMPONENT
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 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
Constructor Detail |
---|
public PentahoSystem()
Method Detail |
---|
public static boolean init()
public static boolean init(IApplicationContext pApplicationContext)
public static boolean init(IApplicationContext pApplicationContext, Map listenerMap)
public static boolean getInitializedOK()
public static int getInitializedStatus()
public static List getInitializationFailureMessages()
public static void addInitializationFailureMessage(int failureBit, String message)
public static IContentOutputHandler getOutputDestinationFromContentRef(String contentTag, 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, IPentahoSession session)
interfaceClass
as the object key in
get(Class, String, IPentahoSession)
.
public static <T> T get(Class<T> interfaceClass, String key, 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 String getSystemName()
public static IParameterProvider getGlobalParameters()
public static void sessionStartup(IPentahoSession session)
public static void clearGlobals()
public static Object putInGlobalAttributesMap(Object key, Object value)
public static Object removeFromGlobalAttributesMap(Object key)
public static void sessionStartup(IPentahoSession session, IParameterProvider sessionParameters)
public static void globalStartup()
public static void globalStartup(IPentahoSession session)
public static void shutdown()
public static IApplicationContext getApplicationContext()
@Deprecated public static Object createObject(String className, ILogger logger)
public static void setUserDetailsRoleListService(IUserDetailsRoleListService value)
public static IUserDetailsRoleListService getUserDetailsRoleListService()
@Deprecated public static Object createObject(String className)
public static String getSystemSetting(String path, String settingName, String defaultValue)
public static String getSystemSetting(String settingName, String defaultValue)
public static ISystemSettings getSystemSettings()
public static void refreshSettings()
public static String publish(IPentahoSession session, String className)
public static List getPublisherList()
public static org.dom4j.Document getPublishersDocument()
public static void systemEntryPoint()
public static void systemExitPoint()
public static ICacheManager getCacheManager(IPentahoSession session)
public static List getACLFileExtensionList()
public static void addLogoutListener(ILogoutListener listener)
public static ILogoutListener remove(ILogoutListener listener)
public static void invokeLogoutListeners(IPentahoSession session)
public static IPentahoObjectFactory getObjectFactory()
public static void setObjectFactory(IPentahoObjectFactory pentahoObjectFactory)
pentahoObjectFactory
- the factorypublic static void setAdministrationPlugins(List<IPentahoPublisher> administrationPlugins)
publish(IPentahoSession, String)
administrationPlugins
- a list of admin functions to registerpublic static void setSystemListeners(List<IPentahoSystemListener> systemListeners)
systemListeners
- the system event handlerspublic static void setSessionStartupActions(List<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(ISystemSettings systemSettingsService)
systemSettingsService
- the settings service
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |