sailpoint.api

Interface SailPointContext

All Superinterfaces:

PersistenceManager, Resolver, RuleRunner, XMLReferenceResolver

public interface SailPointContext
extends PersistenceManager, RuleRunner, XMLReferenceResolver

The primary API for accessing the persistent store and performing core system operations.

Nested Class Summary

Nested classes/interfaces inherited from interface sailpoint.api.PersistenceManager

PersistenceManager.LockParameters, PersistenceManager.LockPhase

Field Summary

Fields inherited from interface sailpoint.api.PersistenceManager

LOCK_NAME, LOCK_TYPE, LOCK_TYPE_PERSISTENT, LOCK_TYPE_TRANSACTION

Method Summary

Modifier and Type	Method and Description
Identity	authenticate(java.lang.String accountId, java.lang.String password) Authenticate a user with the given accountId and password.
java.lang.String	decrypt(java.lang.String src) Decrypt an encrypted string.
java.lang.String	encrypt(java.lang.String src) Encrypt a string.
Configuration	getConfiguration() Retrieve the system configuration object.
java.sql.Connection	getConnection() Deprecated. Use getJdbcConnection()
SailPointContext	getContext() Return a context derived from this one.
java.sql.Connection	getJdbcConnection() Return a JDBC Connection to the underlying database.
java.lang.Object	getProperty(java.lang.String name) Return the property with the given name.
boolean	getScopeResults() Returns true if query results are being scoped.
java.lang.String	getUserName() Return the name of the current user of this context.
void	impersonate(Identity identity) This can be used to impersonate the given identity with respect to the scoping that is applied.
boolean	isClosed() Return true if this context has been closed and can no longer be used.
void	prepare() Method to be called by the SailPointFactory immediately after creating a context from a prototype.
void	sendEmailNotification(EmailTemplate template, EmailOptions options) Send an email notification.
void	setProperty(java.lang.String name, java.lang.Object value) Set a context property.
void	setScopeResults(boolean scopeResults) Set whether the results from search and getObjects methods should have scoping applied to them based on the controlled scopes of the user set with setUserName(String).
void	setUserName(java.lang.String name) Set the name of the current user of this context.

Methods inherited from interface sailpoint.api.PersistenceManager

attach, clearHighLevelCache, clone, close, commitTransaction, commitTransaction, countObjects, decache, decache, enableStatistics, getObjectById, getObjectByName, getObjects, getObjects, getPersistenceOptions, getPropertyIterator, getPropertyList, getUniqueObject, getUniqueObject, importObject, lockObject, lockObjectById, lockObjectByName, printStatistics, reconnect, releasePersistentLocks, removeObject, removeObjects, requiresJoin, rollbackTransaction, saveObject, search, search, search, search, setPersistenceOptions, startTransaction, unlockObject, update

Methods inherited from interface sailpoint.object.Resolver

getObject

Methods inherited from interface sailpoint.object.RuleRunner

runRule, runRule, runScript, runScript

Methods inherited from interface sailpoint.tools.xml.XMLReferenceResolver

getReferencedObject

Method Detail

getContext

SailPointContext getContext()

Return a context derived from this one. A single prototype context can serve as a factory for thread-specific contexts, depending on the implementation. SailPointFactory will always call this when returning contexts.

prepare

void prepare()

Method to be called by the SailPointFactory immediately after creating a context from a prototype. See comments in InternalContext for the complex and unfortunate reason.

getJdbcConnection

java.sql.Connection getJdbcConnection()
                               throws GeneralException

Return a JDBC Connection to the underlying database. This is used in a few places that need to run complex SQL queries. It should be unnecessary now that you can run SQL with PersistenceManager.search(java.lang.Class<T>, sailpoint.object.QueryOptions).

Throws:

GeneralException

getConnection

@Deprecated
java.sql.Connection getConnection()
                                       throws GeneralException

Deprecated. Use getJdbcConnection()

Throws:

GeneralException

isClosed

boolean isClosed()

Return true if this context has been closed and can no longer be used.

setUserName

void setUserName(java.lang.String name)

Set the name of the current user of this context. This will be used when generating audit events.

getUserName

java.lang.String getUserName()

Return the name of the current user of this context. This will normally be the name of an Identity but occasionally it might be an abstract name like "System" or "Scheduler".

impersonate

void impersonate(Identity identity)

This can be used to impersonate the given identity with respect to the scoping that is applied. When impersonating, the given identity's controlled scopes are used to scope results rather than the user specified by setUserName(String). Note that this Identity does not have to be persistent.

Parameters:

identity - The Identity to impersonate for scoping.

setScopeResults

void setScopeResults(boolean scopeResults)

Set whether the results from search and getObjects methods should have scoping applied to them based on the controlled scopes of the user set with setUserName(String). This can be overridden by the QueryOptions that are passed into the searching methods. Scoping results is disabled by default.

Parameters:

scopeResults - Whether results from the search methods should be scoped.

getScopeResults

boolean getScopeResults()

Returns true if query results are being scoped.

getConfiguration

Configuration getConfiguration()
                        throws GeneralException

Retrieve the system configuration object. You can also get this just by calling getObject() but this method will use a static cache.

Throws:

GeneralException

encrypt

java.lang.String encrypt(java.lang.String src)
                  throws GeneralException

Encrypt a string.

Throws:

GeneralException

decrypt

java.lang.String decrypt(java.lang.String src)
                  throws GeneralException

Decrypt an encrypted string. This can fail if the context does not have privileges to perform decryption.

Throws:

GeneralException

sendEmailNotification

void sendEmailNotification(EmailTemplate template,
                           EmailOptions options)
                    throws GeneralException

Send an email notification.

Throws:

EmailException - If there is a problem sending the email.

GeneralException - If there is a system error.

authenticate

Identity authenticate(java.lang.String accountId,
                      java.lang.String password)
               throws GeneralException

Authenticate a user with the given accountId and password. This should have the side-effect of creating a new Identity if the following criteria are met:

1. Authentication is passed-through to another authentication source and succeeds.
2. The account that was correlated on the pass-through authentication source does not have a corresponding Identity.

Parameters:

accountId - A unique identifier for the user/account to authenticate.

password - The password to use in the authentication credentials.

Returns:

The authenticated or newly created user if authentication succeeded.

Throws:

GeneralException - Can be thrown if authentication fails for some reason (invalid password, account locked), if an account/user with the given accountId cannot was not found, or a problem occurs when auto-creating a user.

setProperty

void setProperty(java.lang.String name,
                 java.lang.Object value)

Set a context property. This is intended only for diagnostics, currently there are not any publicly defined properties.

getProperty

java.lang.Object getProperty(java.lang.String name)

Return the property with the given name.