Package pl.edu.icm.unity.engine.api.authn

Interface AuthenticatorInstance

public interface AuthenticatorInstance
Representation of an authenticator instance, which is a composition of CredentialRetrieval and CredentialVerificator, configured. It is based on authenticator definition which is created by user, but is a blueprint for instances with potentially different retrievals and thus different supported bindings.

Authenticator instance can be local or remote, depending on the associated verificator type (local or remote).

Local authenticator is special as it has an associated local credential. Its verificator uses the associated credential's configuration internally, but it is not advertised to the outside world, via the AuthenticatorInstanceMetadata interface.

Author:
K. Benedyczak

  • Method Details

    • updateConfiguration

      void updateConfiguration(String vConfiguration, String retrievalConfiguration, String localCredential)
      Updates the current configuration of the authenticator. For local verificators the verificator configuration is only set for the underlying verificator, it is not exposed in the instanceDescription.

    • getRetrieval

      CredentialRetrieval getRetrieval()

    • getMetadata

      AuthenticatorInstanceMetadata getMetadata()

    • setRevision

      void setRevision(long revision)

    • getRevision

      long getRevision()

    • getCredentialVerificator

      CredentialVerificator getCredentialVerificator()

    • getAuthnOptionSelectors

      List<AuthenticationOptionsSelector> getAuthnOptionSelectors()

    • extractIdPs

      List<IdPInfo> extractIdPs()