Interface DataConnector

All Superinterfaces:
Component, DestructableComponent, IdentifiedComponent, InitializableComponent, ResolverPlugin<Map<String,​IdPAttribute>>, UnmodifiableComponent
All Known Implementing Classes:
AbstractDataConnector, AbstractPersistentIdDataConnector, AbstractSearchDataConnector, HTTPDataConnector, LDAPDataConnector, PairwiseIdDataConnector, RDBMSDataConnector, ResolvedDataConnector, ScriptedDataConnector, StaticDataConnector, StorageServiceDataConnector, SubjectDataConnector

@ThreadSafe
public interface DataConnector
extends ResolverPlugin<Map<String,​IdPAttribute>>
Base class for data connector resolver plugins.
  • Method Details

    • getNoRetryDelay

      @Nonnull Duration getNoRetryDelay()
      Get how long to wait until we declare the connector (potentially) alive again.
      Returns:
      how long to wait.
    • getLastSuccess

      @Nullable default Instant getLastSuccess()
      Get the time when this connector last succeeded. TODO: Remove default in V5.
      Returns:
      when it last succeeded
      Since:
      4.1.0
    • getLastFail

      @Nullable Instant getLastFail()
      Get the time when this connector last failed. This will be set for any exception regardless of the setting of ResolverPlugin.isPropagateResolutionExceptions()
      Returns:
      when it last failed
    • getFailoverDataConnectorId

      @Nullable String getFailoverDataConnectorId()
      Gets the ID of the DataConnector whose values will be used in the event that this data connector experiences an error.
      Returns:
      ID of the DataConnector whose values will be used in the event that this data connector experiences an error
    • isExportAllAttributes

      boolean isExportAllAttributes()
      Gets whether we export all attributes during resolution.

      If this returns false then getExportAttributes() returns the list of attributes to return.

      Returns:
      whether we export all attributes
    • getExportAttributes

      @Nonnull @NonnullElements @Unmodifiable Collection<String> getExportAttributes()
      Gets the list of attribute names to export during resolution.
      Returns:
      the list of attribute names to export during resolution