Package net.shibboleth.idp.persistence

Interface PersistenceManager<ItemType>

  • Type Parameters:
    ItemType - type of item stored and managed
    All Superinterfaces:
    Component, IdentifiedComponent
    @Deprecated
public interface PersistenceManager<ItemType>
extends IdentifiedComponent
    Deprecated.
    Interface describing behavior for IdP components that persist and manage a particular type of stored data.

    • Method Detail

      • contains

        boolean contains​(String id)
        Deprecated.
        Determines if an item with the given ID is exists within the persistence store.
        Parameters:
        id - ID of the item, may be null or empty
        Returns:
        true if an item with the given ID exists within the persistence store, false if the ID is null or empty or an item with the given ID does not exists within the persistence store

      • contains

        boolean contains​(ItemType item)
        Deprecated.
        Determines if an item exists within the persistence store.
        Parameters:
        item - the item to check to see if it exists within the persistence store
        Returns:
        true if the item exists within the persistence store, false if the item is null or does not exists within the persistence store

      • get

        ItemType get​(String id)
        Deprecated.
        Gets the item associated with the given ID.
        Parameters:
        id - ID of the item, may be null or empty
        Returns:
        the item associated with the ID or null if the given ID was null or empty or no item is associated with that id

      • persist

        ItemType persist​(String id,
                 ItemType item)
        Deprecated.
        Persists an item to the persistence store. If the item does not currently exist in the persistence store then a new record will be created, otherwise the existing record will be updated. If the item to be persisted is an update to an existing item then the argument to this method MUST be an updated version of the item as returned by get(String) or persist(String, Object). Note, the item returned from this method is not necessarily the same as the one provided as an argument. A given implementation of this interface may return a different object or update the provided object in some way during this method call.
        Parameters:
        id - the ID of the item to be persisted
        item - item to be persisted, maybe null
        Returns:
        the persisted item or null if the given item was null

      • remove

        ItemType remove​(String id)
        Deprecated.
        Removes an item with the given ID from the persistence store.
        Parameters:
        id - ID of the item, may be null or empty
        Returns:
        the item that was removed or null if the given ID was null or empty or no item was associated with the given ID

      • remove

        ItemType remove​(ItemType item)
        Deprecated.
        Removes an item from the persistence store.
        Parameters:
        item - the item to remove, may be null
        Returns:
        the item that was removed or null if the given item was null or no record existed for the given item