Package net.shibboleth.oidc.metadata

Interface BatchBackingStore<I,T>

Type Parameters:
I - The metadata identifier type.
T - The metadata type.
All Superinterfaces:
BackingStore<I,T>
All Known Implementing Classes:
DefaultBatchBackingStore
public interface BatchBackingStore<I,T> extends BackingStore<I,T>
A specialisation of a BackingStore that deals with batch metadata. Operations on batch metadata happen together e.g. a reload will evict all previous entries and all new entries are reloaded in one go. Individual entries are not updated dynamically as an when needed.

  • Method Summary

    Modifier and Type
    Method
    Description
    Instant
    getLastRefresh()
    Get the time the last refresh of this backing store was attempted.
    Instant
    getLastUpdate()
    Get the time at which this batch backing store was successfully reloaded.
    byte[]
    getOriginalValue()
    Gets the source bytes of the source before it was parsed.
    void
    setLastRefresh(Instant refreshedAt)
    Set the time at which the last refresh was attempted.
    void
    setLastUpdate(Instant updatedAt)
    Set the time at which this batch backing store was successfully reloaded/updated.
    void
    setOriginalValue(byte[] originalValue)
    Sets the source bytes of the source before it was parsed.

    Methods inherited from interface net.shibboleth.oidc.metadata.BackingStore

    getIndexedValues, getOrderedValues

  • Method Details

    • getLastUpdate

      @Nullable Instant getLastUpdate()
      Get the time at which this batch backing store was successfully reloaded. That is, completely cleared and new entries added.
      Returns:
      the last update time.

    • getLastRefresh

      @Nullable Instant getLastRefresh()
      Get the time the last refresh of this backing store was attempted.
      Returns:
      the last attempted refresh time.

    • setLastUpdate

      void setLastUpdate(@Nullable Instant updatedAt)
      Set the time at which this batch backing store was successfully reloaded/updated.
      Parameters:
      updatedAt - the time it was last updated.

    • setLastRefresh

      void setLastRefresh(@Nullable Instant refreshedAt)
      Set the time at which the last refresh was attempted.
      Parameters:
      refreshedAt - the refreshed time.

    • getOriginalValue

      @Nullable byte[] getOriginalValue()
      Gets the source bytes of the source before it was parsed.
      Returns:
      the source bytes.

    • setOriginalValue

      void setOriginalValue(@Nullable byte[] originalValue)
      Sets the source bytes of the source before it was parsed.
      Parameters:
      originalValue - the source bytes.