Uses of Interface
org.pentaho.platform.api.engine.IPentahoSession

Packages that use IPentahoSession

Package	Description
org.pentaho.platform.api.action
org.pentaho.platform.api.engine
org.pentaho.platform.api.repository2.unified
org.pentaho.platform.api.ui

Uses of IPentahoSession in org.pentaho.platform.api.action

Methods in org.pentaho.platform.api.action with parameters of type IPentahoSession

Modifier and Type	Method and Description
void	ISessionAwareAction.setSession(IPentahoSession session)

Uses of IPentahoSession in org.pentaho.platform.api.engine

Methods in org.pentaho.platform.api.engine that return IPentahoSession

Modifier and Type	Method and Description
IPentahoSession	IRuntimeContext.getSession()
IPentahoSession	IContentOutputHandler.getSession()
IPentahoSession	IOutputHandler.getSession()
IPentahoSession	IComponent.getSession()

Methods in org.pentaho.platform.api.engine with parameters of type IPentahoSession

Modifier and Type	Method and Description
String	IBackgroundExecution.backgroundExecuteAction(IPentahoSession userSession, IParameterProvider parameterProvider) Queues the action specified in the request parameters for execution in the background
String[]	IUITemplater.breakTemplate(String templateName, String title, IPentahoSession session)
String[]	IUITemplater.breakTemplateString(String template, String title, IPentahoSession session)
T	IObjectCreator.create(IPentahoSession session) Return an implementation for the Class T.
File	IApplicationContext.createTempFile(IPentahoSession session, String prefix, String extension, boolean trackFile) Creates a temporary file in the system/tmp solutions folder
File	IApplicationContext.createTempFile(IPentahoSession session, String prefix, String extension, File parentDir, boolean trackFile) Creates a temporary file in the specified parent folder and optionally tracks it for deletion on session termination
<T> T	IPentahoObjectFactory.get(Class<T> interfaceClass, IPentahoSession session) Retrieves an instance of a Pentaho BI Server API interface using the simple interface name (interfaceClass name without the package) as the object key.
<T> T	IPentahoObjectFactory.get(Class<T> interfaceClass, IPentahoSession session, Map<String,String> properties) Retrieves an instance of a Pentaho BI Server API interface using the simple interface name (interfaceClass name without the package) as the object key.
<T> T	IPentahoObjectFactory.get(Class<T> interfaceClass, String key, IPentahoSession session) Retrieves an instance of a Pentaho BI Server API interface by the given object key.
<T> List<T>	IPentahoObjectFactory.getAll(Class<T> interfaceClass, IPentahoSession curSession) Returns all objects implementing the provided interface or extending the provided class if the Class is not an Interface.
<T> List<T>	IPentahoObjectFactory.getAll(Class<T> interfaceClass, IPentahoSession curSession, Map<String,String> properties) Returns all objects implementing the provided interface or extending the provided class if the Class is not an Interface.
org.springframework.security.core.Authentication	ISecurityHelper.getAuthentication(IPentahoSession ignoredSession, boolean ignoredAllowAnonymous) Remove this method when data-access is JCR-branched
IContentItem	IBackgroundExecution.getBackgroundContent(String contentGUID, IPentahoSession userSession) Gets the content generated by background execution
List<IContentItem>	IBackgroundExecution.getBackgroundExecutedContentList(IPentahoSession userSession) Gets a list of content GUIDs of background executed jobs
IContentGenerator	IPluginManager.getContentGeneratorForType(String type, IPentahoSession session) Deprecated. Use {@link #getContentGenerator(String, String) instead
IOutputHandler	IBackgroundExecution.getContentOutputHandler(String location, String fileName, String solutionName, IPentahoSession userSession, IParameterProvider parameterProvider) Returns the output handler for content, specific to the implementation of the background execution helper.
IPentahoAclEntry	IAclVoter.getEffectiveAcl(IPentahoSession session, IAclHolder holder) Deprecated. This returns the effective ACL for the piece of content for the given user.
IAclEntry[]	IAclVoter.getEffectiveAcls(IPentahoSession session, IAclHolder holder) Deprecated. Returns an array of the authorities from the IAclHolder that apply to the provided authentication object.
Object	ICacheManager.getFromSessionCache(IPentahoSession session, String key) Gets an object from the user session specific cache.
<T> IPentahoObjectReference<T>	IPentahoObjectFactory.getObjectReference(Class<T> interfaceClass, IPentahoSession curSession) Returns an IPentahoObjectReference for the requested Object containing registered Object Properties.
<T> IPentahoObjectReference<T>	IPentahoObjectFactory.getObjectReference(Class<T> interfaceClass, IPentahoSession curSession, Map<String,String> properties) Returns an IPentahoObjectReference for the requested Object containing registered Object Properties.
<T> List<IPentahoObjectReference<T>>	IPentahoObjectFactory.getObjectReferences(Class<T> interfaceClass, IPentahoSession curSession) Returns an IPentahoObjectReference for the requested Object containing registered Object Properties.
<T> List<IPentahoObjectReference<T>>	IPentahoObjectFactory.getObjectReferences(Class<T> interfaceClass, IPentahoSession curSession, Map<String,String> properties) Returns an IPentahoObjectReference for the requested Object containing registered Object Properties.
IContentOutputHandler	IPentahoSystemHelper.getOutputDestinationFromContentRef(String contentTag, IPentahoSession session)
List<IPlatformPlugin>	IPluginProvider.getPlugins(IPentahoSession session) Returns a list of IPlatformPlugins defined by this plugin provider.
List<IJobDetail>	IBackgroundExecution.getScheduledAndExecutingBackgroundJobs(IPentahoSession userSession) Gets the list of items scheduled for background execution, and those currently executing
String	IUITemplater.getTemplate(String templateName, IPentahoSession session)
void	IPentahoSystemStartupActions.globalStartup(IPentahoSession session)
boolean	ISecurityHelper.hasAccess(IAclHolder aHolder, int actionOperation, IPentahoSession session) Deprecated.
boolean	IAclVoter.hasAccess(IPentahoSession session, IAclHolder holder, int mask) Deprecated. Determines whether the user (auth) has the requested authority (mask) based on the list of effective authorities from the holder.
void	ISolutionEngine.init(IPentahoSession session) Initialize the SolutionEngine.
void	IPentahoInitializer.init(IPentahoSession session) Simplifier for initialization of objects from the PentahoSystem object
void	IPentahoSystemListeners.invokeLogoutListeners(IPentahoSession session)
boolean	ISecurityHelper.isGranted(IPentahoSession session, org.springframework.security.core.GrantedAuthority role) Utility method that communicates with the installed ACLVoter to determine whether a particular role is granted to the specified user.
boolean	IAclVoter.isGranted(IPentahoSession session, org.springframework.security.core.GrantedAuthority role) Deprecated. Returns true if the user is a member of the specified role
boolean	ISecurityHelper.isPentahoAdministrator(IPentahoSession session) Deprecated. use SystemUtils.canAdminister() instead
boolean	IAclVoter.isPentahoAdministrator(IPentahoSession session) Deprecated. Determines whether the user is a super-manager of Hitachi Vantara.
void	ICacheManager.killSessionCache(IPentahoSession session) Removes any session-based data for the specified IPentahoSession.
String[]	IConnectionUserRoleMapper.mapConnectionRoles(IPentahoSession userSession, String connectionContextName) Provides a mapping from the roles defined for a user, and roles appropriate for the connection Rules: - If the user has no rights to the specified connectionContextName, you must throw PentahoAccessControlException - If null or empty array is returned, then no mapping is required, and connection can use defaults
Object	IConnectionUserRoleMapper.mapConnectionUser(IPentahoSession userSession, String connectionContextName) Maps the user from the given IPentahoSession into a user (or credential) appropriate for the connection Rules: - If the user has no rights to the specified connectionContextName, you must throw PentahoAccessControlException - If null or empty array is returned, then no mapping is required, and connection can use defaults
void	ILogoutListener.onLogout(IPentahoSession session)
void	ICacheManager.onLogout(IPentahoSession session)
String	IUITemplater.processTemplate(String template, String title, IPentahoSession session)
String	IUITemplater.processTemplate(String template, String title, String content, IPentahoSession session)
String	IPentahoPublisher.publish(IPentahoSession session, int loggingLevel) Called when the publish is requested.
String	IPentahoSystemAdminPlugins.publish(IPentahoSession session, String className)
void	ICacheManager.putInSessionCache(IPentahoSession session, String key, Object value) Puts an object in the session-specific cache.
boolean	IPluginManager.reload(IPentahoSession session) Deprecated. Use IPluginManager.reload() instead
void	IBackgroundExecution.removeBackgroundExecutedContentForID(String contentGUID, IPentahoSession userSession) Removes the content generated by background execution
void	ICacheManager.removeFromSessionCache(IPentahoSession session, String key) Removes a data item from the user session specific cache
void	IPentahoSystemStartupActions.sessionStartup(IPentahoSession session)
void	IPentahoSystemStartupActions.sessionStartup(IPentahoSession session, IParameterProvider sessionParameters)
void	ISolutionEngine.setSession(IPentahoSession session) Sets the session in the solution engine
void	IContentOutputHandler.setSession(IPentahoSession session)
void	IOutputHandler.setSession(IPentahoSession session)
void	ISessionContainer.setSession(IPentahoSession sess) Set the session for this session container.
void	IContentGenerator.setSession(IPentahoSession userSession) called before createContent(), this is the users session object.
void	IComponent.setSession(IPentahoSession session)
boolean	IPentahoSystemListener.startup(IPentahoSession session) Notification of system startup.
void	IBackgroundExecution.trackBackgroundExecution(IPentahoSession userSession, String GUID) This provides an entry point for tracking the created background execution task

Uses of IPentahoSession in org.pentaho.platform.api.repository2.unified

Methods in org.pentaho.platform.api.repository2.unified with parameters of type IPentahoSession

Modifier and Type	Method and Description
boolean	IRepositoryAccessVoterManager.hasAccess(RepositoryFile file, RepositoryFilePermission operation, RepositoryFileAcl repositoryFileAcl, IPentahoSession session) Evaluate if the current caller has access to the perform given operation on the current repository item
boolean	IRepositoryAccessVoter.hasAccess(RepositoryFile file, RepositoryFilePermission operation, RepositoryFileAcl acl, IPentahoSession session) Determines whether the user has access to perform a specific operation on a particular file in the repository.

Uses of IPentahoSession in org.pentaho.platform.api.ui

Methods in org.pentaho.platform.api.ui with parameters of type IPentahoSession

Modifier and Type	Method and Description
boolean	IUIComponent.validate(IPentahoSession session, IActionRequestHandler actionRequestHandler) Set the userSession member, generate a Log Id, set the requestHandler, and validate the component's configuration.