Package oracle.iam.platformservice.api

Interface PlatformService

public interface PlatformService

  • Method Details

    • registerPlugin

      void registerPlugin(byte[] zipBytes) throws PlatformServiceAccessDeniedException, oracle.iam.platform.pluginframework.PluginException, 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
      IOException - if error occurred while performing I/O

    • registerPluginAndReturnStatus

      Hashtable<String,String[]> registerPluginAndReturnStatus(byte[] zipBytes) throws PlatformServiceAccessDeniedException, oracle.iam.platform.pluginframework.PluginException, IOException
      Register a plug-in
      Parameters:
      zipBytes - array of bytes of the plug-in zip file
      Returns:
      table to store message of successful, re-register and failed plugin during registration
      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
      IOException - if error occurred while performing I/O

    • unRegisterPlugin

      void unRegisterPlugin(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(String pluginID, 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

    • unRegisterPluginAndReturnStatus

      Hashtable<String,String[]> unRegisterPluginAndReturnStatus(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
      Returns:
      Hashtable This hashtable contains plugin name, version and status of plugin registration
      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

      Properties LoadResourceBundleFromDB(String resourceType, String resourceName) throws 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:
      Exception

    • LoadResourceBundleToDB

      void LoadResourceBundleToDB(Properties props, String resourceType, String resourceName) throws 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:
      Exception

    • setEventResult

      void setEventResult(long processId, long eventId, 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
      oracle.iam.platform.kernel.ProcessNotInPrePostStageException

    • setEventResult

      void setEventResult(long processId, String eventName, 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
      oracle.iam.platform.kernel.ProcessNotInPrePostStageException

    • setEventResult

      void setEventResult(long processId, String eventName, EventFailedException exception) throws PlatformServiceAccessDeniedException, oracle.iam.platform.kernel.ProcessNotInPrePostStageException
      Sets the event result on async handler. This notifies kernel to fail the async handler
      Parameters:
      processId - , Orchestration Process ID
      eventName - , Orchestration event Name to complete
      exception - , Event failed exception containing information on why this event failed
      Throws:
      PlatformServiceAccessDeniedException
      oracle.iam.platform.kernel.ProcessNotInPrePostStageException

    • getLocalizedMessage

      String getLocalizedMessage(String resourceBundleName, Exception e, Object... arguments)
      Returns a localized message for the error code contained in the Exception
      Parameters:
      resourceBundleName - Name of the bundle in which the method will be looking into (optional, null can be passed)
      e - Exception containing the errorCode
      arguments -
      Returns:

    • getLocalizedMessage

      String getLocalizedMessage(List<String> resourceBundleNames, Exception e, Object... arguments)
      Returns a localized message for the error code contained in the Exception
      Parameters:
      resourceBundleNames - List of bundles in which the method will be looking into
      e - Exception containing the errorCode
      arguments -
      Returns:

    • isSSOEnabled

      boolean isSSOEnabled()
      APIthat tells if OIM is intgegrated with an SSO solution or not
      Returns:
      true if SSO enabled, false otherwise

    • getIDSProfileName

      String getIDSProfileName()
      API that tells which IDS Profile is configured in ldap mode
      Returns:
      name of the IDS Profile