Skip navigation links


oracle.iam.platformservice.api
Interface PlatformService


public interface PlatformService

Method Summary
 void CleanupOrchestrationData(long batchSize, boolean deleteJustOneBatch)
          Clean up the Completed Orchestration related data including the entries from ORCHPROCESS, ORCHEVENTS, CONTEXT and CONTEXTVALUES
 java.util.Properties LoadResourceBundleFromDB(java.lang.String resourceType, java.lang.String resourceName)
          loads resource bundles from the OIM DB
 void LoadResourceBundleToDB(java.util.Properties props, java.lang.String resourceType, java.lang.String resourceName)
          loads resource bundles to the OIM DB
 void registerPlugin(byte[] zipBytes)
          Register a plug-in
 void setEventResult(long processId, long eventId, oracle.iam.platform.kernel.vo.EventResult result)
          Sets the event result on async handler.
 void setEventResult(long processId, java.lang.String eventName, oracle.iam.platform.kernel.vo.EventResult result)
          Sets the event result on async handler.
 void unRegisterPlugin(java.lang.String pluginID)
          Unregister all versions of a plug-in
 void unRegisterPlugin(java.lang.String pluginID, java.lang.String version)
          Unregister a specific version of a plug-in

 

Method Detail

registerPlugin

void registerPlugin(byte[] zipBytes)
                    throws PlatformServiceAccessDeniedException,
                           oracle.iam.platform.pluginframework.PluginException,
                           java.io.IOException
Register a plug-in
Parameters:
zipBytes - array of bytes of the plug-in zip file
Throws:
PlatformServiceAccessDeniedException - if the logged in user does not have permission to register plug-in
oracle.iam.platform.pluginframework.PluginException - if error occurred while registering the plug-in
java.io.IOException - if error occurred while performing I/O

unRegisterPlugin

void unRegisterPlugin(java.lang.String pluginID)
                      throws PlatformServiceAccessDeniedException,
                             oracle.iam.platform.pluginframework.PluginException
Unregister all versions of a plug-in
Parameters:
pluginID - ID of the plug-in to be unregistered
Throws:
PlatformServiceAccessDeniedException - if the logged in user does not have permission to unregister plug-in
oracle.iam.platform.pluginframework.PluginException - if error occurred while unregistering the plug-in

unRegisterPlugin

void unRegisterPlugin(java.lang.String pluginID,
                      java.lang.String version)
                      throws PlatformServiceAccessDeniedException,
                             oracle.iam.platform.pluginframework.PluginException
Unregister a specific version of a plug-in
Parameters:
pluginID - ID of the plug-in to be unregistered
version - version of the plug-in to be unregistered
Throws:
PlatformServiceAccessDeniedException - if the logged in user does not have permission to unregister plug-in
oracle.iam.platform.pluginframework.PluginException - if error occurred while unregistering the plug-in

LoadResourceBundleFromDB

java.util.Properties LoadResourceBundleFromDB(java.lang.String resourceType,
                                              java.lang.String resourceName)
                                              throws java.lang.Exception
loads resource bundles from the OIM DB
Parameters:
resourceType - Type of the resource
ResourceName - Name of the resource
Returns:
Properties The properties for this resource bundle
Throws:
java.lang.Exception

LoadResourceBundleToDB

void LoadResourceBundleToDB(java.util.Properties props,
                            java.lang.String resourceType,
                            java.lang.String resourceName)
                            throws java.lang.Exception
loads resource bundles to the OIM DB
Parameters:
props - All the properties that should form the resource bundle. For updates to the resource bundle first get the existing bundle properties and then add the new ones to them before calling this API.
resourceType - Type of the resource
ResourceName - Name of the resource
Throws:
java.lang.Exception

CleanupOrchestrationData

void CleanupOrchestrationData(long batchSize,
                              boolean deleteJustOneBatch)
                              throws OrchDataCleanupException
Clean up the Completed Orchestration related data including the entries from ORCHPROCESS, ORCHEVENTS, CONTEXT and CONTEXTVALUES
Parameters:
batchSize, - All the completed data is deleted in iteration. batchSize indicates the number of processes that are deleted in each iteration
deleteJustOneBatch, - value true indicates only a single batch of completed events are delete. Value of false indicates that all the completed events are delete batch at a time in a loop
Throws:
OrchDataCleanupException, - If an exception occurs during cleanup
OrchDataCleanupException

setEventResult

void setEventResult(long processId,
                    long eventId,
                    oracle.iam.platform.kernel.vo.EventResult result)
                    throws PlatformServiceAccessDeniedException,
                           oracle.iam.platform.kernel.ProcessNotInPrePostStageException
Sets the event result on async handler. This notifies kernel to complete this async handler and move forward with the orchestration
Parameters:
processId, - Orchestration Process ID
eventId, - Orchestration event ID
result, - Event Result
Throws:
PlatformServiceAccessDeniedException, - If login user doesn't have required permissions. Platform Service Policy controls whether user can invoke this API or not
ProcessNotInPrePostStageException, - If process to in correct stage to call this API
PlatformServiceAccessDeniedException
oracle.iam.platform.kernel.ProcessNotInPrePostStageException

setEventResult

void setEventResult(long processId,
                    java.lang.String eventName,
                    oracle.iam.platform.kernel.vo.EventResult result)
                    throws PlatformServiceAccessDeniedException,
                           oracle.iam.platform.kernel.ProcessNotInPrePostStageException
Sets the event result on async handler. This notifies kernel to complete this async handler and move forward with the orchestration
Parameters:
processId, - Orchestration Process ID
eventName, - Orchestration event Name to complete
result, - Event Result
Throws:
PlatformServiceAccessDeniedException, - If login user doesn't have required permissions. Platform Service Policy controls whether user can invoke this API or not
ProcessNotInPrePostStageException, - If process to in correct stage to call this API
PlatformServiceAccessDeniedException
oracle.iam.platform.kernel.ProcessNotInPrePostStageException

Skip navigation links


Copyright © 2011, Oracle and/or its affiliates. All rights reserved.