CredentialRetrieval (UNITY documentation 3.2.1 API)

All Superinterfaces:

BindingAuthn, StringConfigurable

All Known Implementing Classes:

AbstractCredentialRetrieval
```
public interface CredentialRetrieval
extends BindingAuthn, StringConfigurable
```
Retrieves credential, using a some binding specific method. Cooperates with CredentialVerificator via CredentialExchange.
Implementations must be thread safe and immutable.

Author:

K. Benedyczak

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`java.lang.String`	`getBindingName()`
`default boolean`	`requiresRedirect()`
`void`	`setCredentialExchange(CredentialExchange e, java.lang.String id)`	Sets initial state, given by the framework (the retrieval's own, implementation specific configuration is set via `#setSerializedConfiguration(com.fasterxml.jackson.databind.node.ObjectNode)`): the credential verificator and the configured id.

Methods inherited from interface pl.edu.icm.unity.engine.api.endpoint.BindingAuthn
destroy, getAuthenticatorId

Methods inherited from interface pl.edu.icm.unity.engine.api.utils.StringConfigurable
getSerializedConfiguration, setSerializedConfiguration

- Method Detail
  - setCredentialExchange
```
void setCredentialExchange(CredentialExchange e,
                           java.lang.String id)
```
    Sets initial state, given by the framework (the retrieval's own, implementation specific configuration is set via #setSerializedConfiguration(com.fasterxml.jackson.databind.node.ObjectNode)): the credential verificator and the configured id.
    
    Parameters:
    
    e -
    
    id -
  - getBindingName
```
java.lang.String getBindingName()
```
    Specified by:
    
    getBindingName in interface BindingAuthn
    
    Returns:
    
    implementation id
  - requiresRedirect
```
default boolean requiresRedirect()
```