|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.lang.String |
getLocalizedMessage(java.util.List resourceBundleNames, java.lang.Exception e, java.lang.Object[] arguments) Returns a localized message for the error code contained in the Exception |
java.lang.String |
getLocalizedMessage(java.lang.String resourceBundleName, java.lang.Exception e, java.lang.Object[] arguments) Returns a localized message for the error code contained in the Exception |
boolean |
isSSOEnabled() APIthat tells if OIM is intgegrated with an SSO solution or not |
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 |
java.util.Hashtable |
registerPluginAndReturnStatus(byte[] zipBytes) Register a plug-in |
void |
setEventResult(long processId, long eventId, EventResult result) Sets the event result on async handler. |
void |
setEventResult(long processId, java.lang.String eventName, EventFailedException exception) Sets the event result on async handler. |
void |
setEventResult(long processId, java.lang.String eventName, 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 |
java.util.Hashtable |
unRegisterPluginAndReturnStatus(java.lang.String pluginID) Unregister all versions of a plug-in |
Method Detail |
---|
void registerPlugin(byte[] zipBytes) throws PlatformServiceAccessDeniedException, oracle.iam.platform.pluginframework.PluginException, java.io.IOException
zipBytes
- array of bytes of the plug-in zip filePlatformServiceAccessDeniedException
- if the logged in user does not have permission to register plug-inoracle.iam.platform.pluginframework.PluginException
- if error occurred while registering the plug-injava.io.IOException
- if error occurred while performing I/Ojava.util.Hashtable registerPluginAndReturnStatus(byte[] zipBytes) throws PlatformServiceAccessDeniedException, oracle.iam.platform.pluginframework.PluginException, java.io.IOException
zipBytes
- array of bytes of the plug-in zip filePlatformServiceAccessDeniedException
- if the logged in user does not have permission to register plug-inoracle.iam.platform.pluginframework.PluginException
- if error occurred while registering the plug-injava.io.IOException
- if error occurred while performing I/Ovoid unRegisterPlugin(java.lang.String pluginID) throws PlatformServiceAccessDeniedException, oracle.iam.platform.pluginframework.PluginException
pluginID
- ID of the plug-in to be unregisteredPlatformServiceAccessDeniedException
- if the logged in user does not have permission to unregister plug-inoracle.iam.platform.pluginframework.PluginException
- if error occurred while unregistering the plug-invoid unRegisterPlugin(java.lang.String pluginID, java.lang.String version) throws PlatformServiceAccessDeniedException, oracle.iam.platform.pluginframework.PluginException
pluginID
- ID of the plug-in to be unregisteredversion
- version of the plug-in to be unregisteredPlatformServiceAccessDeniedException
- if the logged in user does not have permission to unregister plug-inoracle.iam.platform.pluginframework.PluginException
- if error occurred while unregistering the plug-injava.util.Hashtable unRegisterPluginAndReturnStatus(java.lang.String pluginID) throws PlatformServiceAccessDeniedException, oracle.iam.platform.pluginframework.PluginException
pluginID
- ID of the plug-in to be unregisteredPlatformServiceAccessDeniedException
- if the logged in user does not have permission to unregister plug-inoracle.iam.platform.pluginframework.PluginException
- if error occurred while unregistering the plug-injava.util.Properties LoadResourceBundleFromDB(java.lang.String resourceType, java.lang.String resourceName) throws java.lang.Exception
resourceType
- Type of the resourceResourceName
- Name of the resourcejava.lang.Exception
void LoadResourceBundleToDB(java.util.Properties props, java.lang.String resourceType, java.lang.String resourceName) throws java.lang.Exception
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 resourceResourceName
- Name of the resourcejava.lang.Exception
void CleanupOrchestrationData(long batchSize, boolean deleteJustOneBatch) throws OrchDataCleanupException
batchSize,
- All the completed data is deleted in iteration. batchSize indicates the number of processes that are deleted in each iterationdeleteJustOneBatch,
- 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 loopOrchDataCleanupException,
- If an exception occurs during cleanupOrchDataCleanupException
void setEventResult(long processId, long eventId, EventResult result) throws PlatformServiceAccessDeniedException, oracle.iam.platform.kernel.ProcessNotInPrePostStageException
processId,
- Orchestration Process IDeventId,
- Orchestration event IDresult,
- Event ResultPlatformServiceAccessDeniedException,
- If login user doesn't have required permissions. Platform Service Policy controls whether user can invoke this API or notProcessNotInPrePostStageException,
- If process to in correct stage to call this APIPlatformServiceAccessDeniedException
oracle.iam.platform.kernel.ProcessNotInPrePostStageException
void setEventResult(long processId, java.lang.String eventName, EventResult result) throws PlatformServiceAccessDeniedException, oracle.iam.platform.kernel.ProcessNotInPrePostStageException
processId,
- Orchestration Process IDeventName,
- Orchestration event Name to completeresult,
- Event ResultPlatformServiceAccessDeniedException,
- If login user doesn't have required permissions. Platform Service Policy controls whether user can invoke this API or notProcessNotInPrePostStageException,
- If process to in correct stage to call this APIPlatformServiceAccessDeniedException
oracle.iam.platform.kernel.ProcessNotInPrePostStageException
void setEventResult(long processId, java.lang.String eventName, EventFailedException exception) throws PlatformServiceAccessDeniedException, oracle.iam.platform.kernel.ProcessNotInPrePostStageException
processId,
- Orchestration Process IDeventName,
- Orchestration event Name to completeexception,
- Event failed exception containing information on why this event failedPlatformServiceAccessDeniedException,
- If login user doesn't have required permissions. Platform Service Policy controls whether user can invoke this API or notProcessNotInPrePostStageException,
- If process to in correct stage to call this APIPlatformServiceAccessDeniedException
oracle.iam.platform.kernel.ProcessNotInPrePostStageException
java.lang.String getLocalizedMessage(java.lang.String resourceBundleName, java.lang.Exception e, java.lang.Object[] arguments)
resourceBundleName
- Name of the bundle in which the method will be looking into (optional, null can be passed)e
- Exception containing the errorCodearguments
-java.lang.String getLocalizedMessage(java.util.List resourceBundleNames, java.lang.Exception e, java.lang.Object[] arguments)
resourceBundleNames
- List of bundles in which the method will be looking intoe
- Exception containing the errorCodearguments
-boolean isSSOEnabled()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |