oracle.idm.provisioning.plugin

Interface IDataAccessPlugin

public interface IDataAccessPlugin

This is a Data Access plugin that is invoked from the DAS. The Application teams implements this interface if it desires to store the user footprint by itself.

 ex.
 
 import oracle.ldap.util.PropertySet;
 import oracle.ldap.util.VarPropertySet;
 
 public class DataAccessPluginImpl implementes IDataAccessPlugin
 {
   ....
   public PluginStatus process(ApplicationContext appCtx, IdmUser user,
     ModPropertySet baseUserAttr, ModPropertySet appUserAttr)
          throws PluginException
   {
     ...
     return new PluginStatus(....);
   }


   public PropertySet getAppUserData(ApplicationContext appCtx, 
          IdmUser user, String reqAttrs[]) throws PluginException;
   {
     ...
     return retPropertySet;
   }
 }
 

Since:

OCS 2.1

Version:

$Header: IDataAccessPlugin.java 17-feb-2005.05:41:23 svenugop Exp $

Author:

Siva Kumar Venugopal

Method Summary

Modifier and Type	Method and Description
PropertySet	getAppUserData(ApplicationContext appCtx, IdmUser user, java.lang.String[] reqAttrs) The applications can return their user footprint by implementing this method.
PluginStatus	process(ApplicationContext appCtx, IdmUser idmUser, ModPropertySet baseUserAttr, ModPropertySet appUserAttr) The applications can create/modify/delete the user footprint by implementing this method.

Method Detail

process

PluginStatus process(ApplicationContext appCtx,
                     IdmUser idmUser,
                     ModPropertySet baseUserAttr,
                     ModPropertySet appUserAttr)
              throws PluginException

The applications can create/modify/delete the user footprint by implementing this method.

Parameters:

appCtx - the application context

idmUser - IdmUser object

baseUserAttr - Base user properties

appUserAttr - App user properties

Returns:

PluginStatus a plugin status object, which must contain the either IdmUser.PROVISION_SUCCESS or IdmUser.PROVISION_FAILURE provisioning status

Throws:

PluginException - when an exception occurs.

getAppUserData

PropertySet getAppUserData(ApplicationContext appCtx,
                           IdmUser user,
                           java.lang.String[] reqAttrs)
                    throws PluginException

The applications can return their user footprint by implementing this method. Use oracle.ldap.util.VarPropertySet as the return object

 
  For Ex.

   PropertySet retPropertySet =  null;
   ...
   ...
   retPropertySet = new VarPropertySet();

   //Fetch the App data and add it to retPropertySet
 
   retPropertySet.addProperty("name", "value");
   ...
   ..
   return retPropertySet;

 

Throws:

PluginException - when an exception occurs.