Package oracle.iam.reconciliation.api

Interface EventMgmtService

public interface EventMgmtService

  • Method Details

    • getSearchCount

      long getSearchCount(ReconSearchCriteria searchParams)
      Returns the number of database rows matching the given search criteria.
      Parameters:
      srchCrit - The ReconSearchCriteria to use for counting database rows.
      Returns:
      The number of rows matching the Recon Search Criteria.

    • search

      List<ReconEvent> search(ReconSearchCriteria searchParams, Vector order, boolean ascOrderFlag, int startIndex, int pageSize)
      PAGINATED Search for Reconciliation Events where order is provided. The Search will only return results by page. The size of the returned page is the value provided for 'size'. The index of the first search result in the page corresponds to the 'minIndex' parameter.
      For example, if search parameters provided match 10k result rows, a paginated search can be used to return only the first 100 rows (or "size" rows). The next page of (i.e., the next 100) results can then be fetched by incrementing the initial minIndex by size. So:

      minIndex(next Page) = minIndex(initial Page) + size.

      Paginated Search greatly improves Search performance by only returning a subset of the overall results.

      Parameters:
      searchParams - a ReconSearchCriteria object encapsulating the Search parameters.
      order - the list of field names to order the search results by. The Field names are constants defined in EventConstants .
      ascOrderFlag - a boolean that should be set to TRUE to order the results in ascending order.
      size - the maximum size of the expected search results set. This is the size of the search results page.
      minIndex - the index of the first result of the result page.
      Returns:
      a paginated List of ReconEvent objects macthing the Search parameters.

    • performBulkAction

      void performBulkAction(String actionName, HashMap actionParams, List reconEvents, String actionPerformed) throws EventManagementException
      Perform Bulk Event Actions. Applies the same action to a set of Events.
      Parameters:
      actionName - the name of the action like event close, re-evaluate, archive, assign
      actionParams - the parameters required by the selected action
      reconEvents - the list of Reconciliation Events to apply the action to.
      actionPerformed - the name of the Bulk action to perform, as it should appear in the Recon History table. Typically a Language sensitive string coming from a bundle or translatable properties file.
      usrName - the name of the user performing the action.
      Throws:
      EventManagementException - in case the action fails.

    • getTargetAttrDetailsCollection

      List<ReconTargetAttribute> getTargetAttrDetailsCollection(ReconEvent event)
      Deprecated.
      Fetches the attribute data details of the given Recon Event from the database.
      Parameters:
      event - a Recon Event instance encapsulating the Event for which the attribute details are requested.
      Returns:
      a list of Recon Target Attributes (ReconTargetAttribute)

    • getReconEventData

      ReconEventData getReconEventData(ReconEvent evt) throws EventManagementException
      Fetches the data for the given Event.
      Parameters:
      evt - the instance of the Event for which to fetch the Data.
      Returns:
      an instance of ReconEventData containing all the data related to this event.
      Throws:
      EventManagementException

    • getMatchedUsersForEvent

      List<User> getMatchedUsersForEvent(long eventId)
      Returns a list of Users that match the Event which ID is given.
      Parameters:
      eventId - the ID of the Event for which the User matches is requested.
      Returns:
      a List of User who all match the given Event.

    • getMatchedRolesForEvent

      List<Role> getMatchedRolesForEvent(long EventID)
      Returns a list of Roles that match the Event which ID is given.
      Parameters:
      EventID - the ID of the Event for which the Role matches are requested.
      Returns:
      a List of Role who all match the given Event.

    • getMatchedRoleMembersForEvent

      List<RoleMember> getMatchedRoleMembersForEvent(long EventID)
      Returns a list of Role Memberss that match the Event which ID is given.
      Parameters:
      EventID - the ID of the Event for which the Role Member matches are requested.
      Returns:
      a List of Role Member who all match the given Event.

    • getMatchedRoleHierarchiesForEvent

      List<RoleHierarchy> getMatchedRoleHierarchiesForEvent(long EventID)
      Returns the list of Role Hierarchies that match the given Event.
      Parameters:
      EventID - the current Event ID for which matches are requested
      Returns:
      a list of Role Hierarchy Instances

    • getMatchedOrgsForEvent

      List<Organization> getMatchedOrgsForEvent(long eventId)
      Returns the list of Organizations that match the given Event.
      Parameters:
      eventId - the ID of the Event for which the Org macthes are requested.
      Returns:
      the list of Organization that match the given Event.

    • getMatchedAccountsForEvent

      List<Account> getMatchedAccountsForEvent(long eventId)
      Returns the list of matched acounts for a specific event
      Parameters:
      eventId - - event ID for the specified recon event
      Returns:
      list of matched Acount objects for the specified event

    • getLinkedUserForEvent

      User getLinkedUserForEvent(long eventId)
      Returns the linked user for the specified event
      Parameters:
      eventId - - event ID for the specified recon event
      Returns:
      linked user for the specified event

    • getLinkedOrgForEvent

      Organization getLinkedOrgForEvent(long eventId)
      Returns the linked organization for the specified event
      Parameters:
      eventId - - event ID for the specified recon event
      Returns:
      linked organization for the specified event

    • getLinkedRoleForEvent

      Role getLinkedRoleForEvent(long eventId)
      Returns the linked role for the specified event
      Parameters:
      eventId - - event ID for the specified recon event
      Returns:
      linked role for the specified event

    • getLinkedRoleMemberForEvent

      RoleMember getLinkedRoleMemberForEvent(long eventId)
      Returns the linked role member for the specified event
      Parameters:
      eventId - - event ID for the specified recon event
      Returns:
      linked role member for the specified event

    • getLinkedRoleHierarchyForEvent

      RoleHierarchy getLinkedRoleHierarchyForEvent(long eventId)
      Fetches the Role Hierarchy currently linked to the given Event
      Parameters:
      eventId - the ID of the Event for which to find the linked Role.
      Returns:
      a Role Hierarchy instance.

    • getLinkedAccountForEvent

      Account getLinkedAccountForEvent(long eventId)
      Returns the linked account for the specified event
      Parameters:
      eventId - - event ID for the specified recon event
      Returns:
      linked account for the specified event

    • getReconHistoryForEvent

      List<ReconHistory> getReconHistoryForEvent(long eventId)
      Returns the recon history for the specified event
      Parameters:
      eventId - - event ID for the specified recon event
      Returns:
      list of recon history objects for specified event

    • createUser

      void createUser(long eventId, String modifiersName, String linkSrc, String actionPerformed) throws EventManagementException
      Deprecated.
      Please try to use ReconOperationsService.processReconciliationEvent(long)
      Create User with data for the specified event id
      Parameters:
      eventId - - event ID for the specified recon event
      modifiersName - - logged in user name, not used, always pass as null, kept for backword compatibility only.
      linkSrc - - Source of linking
      Throws:
      EventManagementException

    • createAccount

      void createAccount(long eventId, long ownerKey, String ownerType, String modifiersName, String linkSrc, String actionPerformed, boolean ServiceAccount) throws EventManagementException
      Creates a new Account in the OIM DB, using Event data.
      Parameters:
      eventId - the ID of the Recon Event containing the new account data.
      ownerKey - the User Key of the owner of the Account.
      ownerType - The type of owner, usually USER.
      modifiersName - the name of the user performing the action, not used, always pass as null, kept for backword compatibility only.
      linkSrc - the source of the create action/Event Link: either manual Linking or linked through an automated action rule.
      actionPerformed -
      ServiceAccount - a boolean stating whether Account to create should be a service account or not.
      Throws:
      EventManagementException - in case the operation fails

    • establishUserLink

      void establishUserLink(long eventId, long usrKey, String modifiersName, String linkSrc, String actionPerformed) throws EventManagementException
      Links an Event to a User, thus performing all necessary database updates.
      Parameters:
      eventId - the ID of the Event to link.
      usrKey - the User ID/Key of the user to link the event to.
      modifiersName - the name of the user performing the action, not used, always pass as null, kept for backword compatibility only.
      linkSrc - the source of the Event Link: either manual Linking or linked through an automated action rule.
      actionPerformed - the name of the operation, for logging into the History table.
      Throws:
      EventManagementException - in case the operation fails.

    • establishLink

      void establishLink(long eventId, long key, String linkSrc, String actionPerformed) throws EventManagementException
      Links an Event, thus triggering all necessary database updates.
      Parameters:
      eventId - the ID of the Event to Link.
      key - The Key to link the Event to.
      linkSrc - the source of the Event Link: either manual Linking or linked through an automated action rule.
      actionPerformed - the name of the operation, for logging into the History table.
      Throws:
      EventManagementException - in case the operatrion fails.

    • establishAccountLink

      void establishAccountLink(long eventId, long orcKey, String modifiersName, String linkSrc, String actionPerformed) throws EventManagementException
      Links an Event to an Account, thus triggering all necessary database updates to the Account.
      Parameters:
      eventId - the ID of the Event to Link.
      orcKey - The ORC Key of the Account to link the Event to.
      modifiersName - the name of the user performing the action, not used, always pass as null, kept for backword compatibility only.
      linkSrc - the source of the Event Link: either manual Linking or linked through an automated action rule.
      actionPerformed - the name of the operation, for logging into the History table.
      Throws:
      EventManagementException - in case the operatrion fails.

    • assignEvent

      @Deprecated boolean assignEvent(long eventId, String usrLogin, long usrKey, long grpKey)
      Deprecated.

    • performBulkAction

      @Deprecated void performBulkAction(String actionName, HashMap actionParams, List reconEvents) throws EventManagementException
      Deprecated.
      Throws:
      EventManagementException