Class MetadataIndexStore<T>

java.lang.Object
org.opensaml.saml.metadata.resolver.index.impl.MetadataIndexStore<T>
Type Parameters:
T - the type of data being indexed

public class MetadataIndexStore<T> extends Object
Component which stores indexed instances of a particular type of data, for example EntityDescriptor, under one or more instances of MetadataIndexKey.
  • Field Details

  • Constructor Details

    • MetadataIndexStore

      public MetadataIndexStore()
      Constructor.
  • Method Details

    • getKeys

      @Nonnull @Unmodifiable @NotLive public Set<MetadataIndexKey> getKeys()
      Get the set of all MetadataIndexKey instances currently indexed.
      Returns:
      the set of all currently indexed keys
    • lookup

      @Nonnull @Unmodifiable @NotLive public Set<T> lookup(@Nonnull MetadataIndexKey key)
      Lookup the instances of data indexed under the supplied MetadataIndexKey.
      Parameters:
      key - the index key to lookup
      Returns:
      the set of data items indexed under that key
    • add

      public void add(@Nonnull MetadataIndexKey key, @Nonnull T item)
      Add the supplied data item to the index under the supplied MetadataIndexKey.
      Parameters:
      key - the index key
      item - the data item to index
    • remove

      public void remove(@Nonnull MetadataIndexKey key, @Nonnull T item)
      Remove the supplied data item from the index under the supplied MetadataIndexKey.
      Parameters:
      key - the index key
      item - the data item to index
    • clear

      public void clear(@Nonnull MetadataIndexKey key)
      Clear all data items indexed under the supplied MetadataIndexKey.
      Parameters:
      key - the index key
    • clear

      public void clear()
      Clear all indexed data items from the store.