Package org.kuali.rice.kim.impl.identity

Interface IdentityArchiveService

public interface IdentityArchiveService
This service archives EntityDefault. It's purpose is to provide long term storage for basic identity data that may be removed from the IdentityService implementation's backing store.
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Details

    • getEntityDefaultFromArchive

      org.kuali.rice.kim.api.identity.entity.EntityDefault getEntityDefaultFromArchive(String id) throws IllegalArgumentException
      Gets a EntityDefault with an id from the archive. EntityDefault is a condensed version of Entity that contains default values of its subclasses

      This method will return null if the Entity does not exist.

      Parameters:
      id - the unique id to retrieve the entity by. cannot be null.
      Returns:
      a EntityDefault or null
      Throws:
      IllegalArgumentException - if the id is blank

    • getEntityDefaultFromArchiveByPrincipalId

      org.kuali.rice.kim.api.identity.entity.EntityDefault getEntityDefaultFromArchiveByPrincipalId(String principalId) throws IllegalArgumentException
      Gets a EntityDefault with an principalId from the archive. EntityDefault is a condensed version of Entity that contains default values of its subclasses

      This method will return null if the Entity does not exist.

      Parameters:
      principalId - the unique principalId to retrieve the entity by. cannot be null.
      Returns:
      a EntityDefault or null
      Throws:
      IllegalArgumentException - if the principalId is blank

    • getEntityDefaultFromArchiveByPrincipalName

      org.kuali.rice.kim.api.identity.entity.EntityDefault getEntityDefaultFromArchiveByPrincipalName(String principalName) throws IllegalArgumentException
      Gets a EntityDefault with an principalName from the archive. EntityDefault is a condensed version of Entity that contains default values of its subclasses

      This method will return null if the Entity does not exist.

      Parameters:
      principalName - the unique principalName to retrieve the entity by. cannot be null.
      Returns:
      a EntityDefault or null
      Throws:
      IllegalArgumentException - if the principalName is blank

    • getEntityDefaultFromArchiveByEmployeeId

      org.kuali.rice.kim.api.identity.entity.EntityDefault getEntityDefaultFromArchiveByEmployeeId(String employeeId) throws IllegalArgumentException
      Gets a EntityDefault with an employeeId from the archive. EntityDefault is a condensed version of Entity that contains default values of its subclasses

      This method will return null if the Entity does not exist.

      Parameters:
      employeeId - the unique employeeId to retrieve the entity by. cannot be null.
      Returns:
      a EntityDefault or null
      Throws:
      IllegalArgumentException - if the employeeId is blank

    • saveEntityDefaultToArchive

      void saveEntityDefaultToArchive(org.kuali.rice.kim.api.identity.entity.EntityDefault entityDefault) throws IllegalArgumentException
      Saves a EntityDefault to the archive. EntityDefault is a condensed version of Entity that contains default values of its subclasses

      This method will return the saved EntityDefault object

      Parameters:
      entityDefault - the unique principalName to retrieve the entity by. cannot be null.
      Throws:
      IllegalArgumentException - if the entityDefault is null

    • flushToArchive

      void flushToArchive() throws IllegalArgumentException
      Flushes EntityDefault to the archive.

      This method flushes the "saved" entities to the database

      Throws:
      IllegalArgumentException