com.netegrity.imapi
Interface ProviderAccessor

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

BLTHContext, EventContext, EventROContext, ExposedEventContextInformation, ExposedTaskContextInformation, FieldContext, IMContext, IMPersistentContext, LogicalAttributeContext, NotificationRuleContext, ParticipantResolverContext, ScreenContext, TabControllerContext, TabSequenceContext, WorkflowContext

public interface ProviderAccessor
extends java.io.Serializable

Provides all Identity Manager APIs with direct access to the managed objects in the data store.

Each managed object type (such as User, Group, and Organization) is associated with a provider object that you use to access the managed object's data. You use the methods in ProviderAccessor to retrieve the managed object providers.

In addition, ProviderAccessor lets you access the SecurityProvider object for retrieving information about administrator privileges in the Identity Manager environment.

Identity Manager APIs inherit ProviderAccessor methods through IMContext.

Typically, managed objects retrieved through ProviderAccessor are accessed for reading purposes only. However, on occassion, business logic task handlers and event listeners may need to modify objects retrieved through ProviderAccessor.

Note: If you modify a managed object retireved through ProviderAccessor, you are changing the local (in-memory) representation of the object. To persist the changes to the data store, call modifyObject(). The changes are then made directly to the data store. No Identity Manager events are generated, and no workflow approvals, auditing, or security checks are performed.

Since:

IdentityMinder 6.0

Method Summary

AccessControlProvider	getAccessControlProvider() Retrieves the AccessControlProvider object.
AccessRoleProvider	getAccessRoleProvider() Retrieves the AccessRoleProvider object.
AccessTaskProvider	getAccessTaskProvider() Retrieves the AccessTaskProvider object.
AdminRoleProvider	getAdminRoleProvider() Retrieves the AdminRoleProvider object.
AdminTaskProvider	getAdminTaskProvider() Retrieves the AdminTaskProvider object.
AnalyticsEngineProvider	getAnalyticsEngineProvider() Retrieves the (AnalyticsEngineProvider object
EnvironmentSettingsProvider	getEnvironmentSettingsProvider()
GroupProvider	getGroupProvider() Retrieves the GroupProvider object.
ManagedObjectProvider	getManagedObjectProvider(ObjectType objectType) Retrieves the ManagedObjectProvider object.
OrganizationProvider	getOrganizationProvider() Retrieves the OrganizationProvider object.
ProvisioningPolicyProvider	getProvisioningPolicyProvider() Retrieves the ProvisioningPolicyProvider object.
ProvisioningRoleProvider	getProvisioningRoleProvider() Retrieves the ProvisioningRoleProvider object.
RelationshipProvider	getRelationshipProvider() Retrives the RelationshipProvider object.
SecurityProvider	getSecurityProvider() Retrieves the SecurityProvider object.
SynchronizationProvider	getSynchronizationProvider() Retrieves the SynchronizationProvider object.
TabDefinitionProvider	getTabDefinitionProvider() Retrieves the TabDefinitionProvider object.
UserProvider	getUserProvider() Retrieves the UserProvider object.

Method Detail

getAccessRoleProvider

AccessRoleProvider getAccessRoleProvider()
                                         throws java.lang.Exception

Retrieves the AccessRoleProvider object.

Returns:

The provider for Access Role objects.

Throws:

java.lang.Exception

getAccessTaskProvider

AccessTaskProvider getAccessTaskProvider()
                                         throws java.lang.Exception

Retrieves the AccessTaskProvider object.

Returns:

The provider for Access Task objects.

Throws:

java.lang.Exception

getAdminRoleProvider

AdminRoleProvider getAdminRoleProvider()
                                       throws java.lang.Exception

Retrieves the AdminRoleProvider object.

Returns:

The provider for Admin Role objects.

Throws:

java.lang.Exception

getAdminTaskProvider

AdminTaskProvider getAdminTaskProvider()
                                       throws java.lang.Exception

Retrieves the AdminTaskProvider object.

Returns:

The provider for Admin Task objects.

Throws:

java.lang.Exception

getSecurityProvider

SecurityProvider getSecurityProvider()
                                     throws java.lang.Exception

Retrieves the SecurityProvider object.

Returns:

The security provider object.

Throws:

java.lang.Exception

getGroupProvider

GroupProvider getGroupProvider()
                               throws java.lang.Exception

Retrieves the GroupProvider object.

Returns:

The provider for Group objects.

Throws:

java.lang.Exception

getOrganizationProvider

OrganizationProvider getOrganizationProvider()
                                             throws java.lang.Exception

Retrieves the OrganizationProvider object.

Returns:

The provider for Organization objects.

Throws:

java.lang.Exception

getUserProvider

UserProvider getUserProvider()
                             throws java.lang.Exception

Retrieves the UserProvider object.

Returns:

The provider for User objects.

Throws:

java.lang.Exception

getTabDefinitionProvider

TabDefinitionProvider getTabDefinitionProvider()
                                               throws java.lang.Exception

Retrieves the TabDefinitionProvider object.

Returns:

The tab definition provider object.

Throws:

java.lang.Exception

getAccessControlProvider

AccessControlProvider getAccessControlProvider()
                                               throws java.lang.Exception

Retrieves the AccessControlProvider object.

Returns:

The access control provider object.

Throws:

java.lang.Exception

getEnvironmentSettingsProvider

EnvironmentSettingsProvider getEnvironmentSettingsProvider()
                                                           throws java.lang.Exception

Throws:

java.lang.Exception

getProvisioningPolicyProvider

ProvisioningPolicyProvider getProvisioningPolicyProvider()
                                                         throws java.lang.Exception

Retrieves the ProvisioningPolicyProvider object.

Returns:

The provider for Provisioning Policy objects.

Throws:

java.lang.Exception

Since:

Identity Manager 8.1

getProvisioningRoleProvider

ProvisioningRoleProvider getProvisioningRoleProvider()
                                                     throws java.lang.Exception

Retrieves the ProvisioningRoleProvider object.

Returns:

The provider for Provisioning Role objects.

Throws:

java.lang.Exception

Since:

Identity Manager 8.1

getSynchronizationProvider

SynchronizationProvider getSynchronizationProvider()
                                                   throws java.lang.Exception

Retrieves the SynchronizationProvider object.

Returns:

The provider for user sychronization.

Throws:

java.lang.Exception

Since:

Identity Manager 8.1

getManagedObjectProvider

ManagedObjectProvider getManagedObjectProvider(ObjectType objectType)
                                               throws java.lang.Exception

Retrieves the ManagedObjectProvider object.

Parameters:

objectType -

Returns:

the provider for managed objects

Throws:

java.lang.Exception

Since:

Identity Manager 12.0

getRelationshipProvider

RelationshipProvider getRelationshipProvider()
                                             throws java.lang.Exception

Retrives the RelationshipProvider object.

Returns:

the provider for managed object relationships

Throws:

java.lang.Exception

Since:

Identity Manager 12.0

getAnalyticsEngineProvider

AnalyticsEngineProvider getAnalyticsEngineProvider()
                                                   throws java.lang.Exception

Retrieves the (AnalyticsEngineProvider object

Returns:

the provider for the analytics engine

Throws:

java.lang.Exception

Since:

Identity Manager 12.5