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

Class AbstractLocalVerificator

java.lang.Object

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

pl.edu.icm.unity.engine.api.authn.local.AbstractLocalVerificator

All Implemented Interfaces:

pl.edu.icm.unity.base.describedObject.DescribedObject, pl.edu.icm.unity.base.describedObject.NamedObject, CredentialExchange, CredentialVerificator, LocalCredentialVerificator, StringConfigurable

public abstract class AbstractLocalVerificator
extends AbstractVerificator
implements LocalCredentialVerificator

Abstract LocalCredentialVerificator with a common boilerplate code.

Author:

K. Benedyczak

Nested Class Summary

Nested classes/interfaces inherited from interface pl.edu.icm.unity.engine.api.authn.CredentialVerificator

CredentialVerificator.VerificatorType

Field Summary

Fields

Modifier and Type	Field	Description
protected String	credentialName

Fields inherited from class pl.edu.icm.unity.engine.api.authn.AbstractVerificator

identityResolver, instanceName

Constructor Summary

Constructors

Constructor	Description
AbstractLocalVerificator(String name, String description, String exchangeId, boolean supportingInvalidation)

Method Summary

Modifier and Type	Method	Description
String	getCredentialName()
CredentialVerificator.VerificatorType	getType()
boolean	isSupportingInvalidation()
void	setCredentialName(String credentialName)	Sets credential definition name for this verificator.
Optional<String>	updateCredentialAfterConfigurationChange(String currentCredential)	Returns optionally changed argument credential, which can be transformed after the change of configuration.

Methods inherited from class pl.edu.icm.unity.engine.api.authn.AbstractVerificator

getDescription, getExchangeId, getName, setIdentityResolver, setInstanceName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface pl.edu.icm.unity.engine.api.authn.CredentialExchange

getExchangeId

Methods inherited from interface pl.edu.icm.unity.engine.api.authn.CredentialVerificator

setIdentityResolver, setInstanceName

Methods inherited from interface pl.edu.icm.unity.base.describedObject.DescribedObject

getDescription

Methods inherited from interface pl.edu.icm.unity.engine.api.authn.local.LocalCredentialVerificator

checkCredentialState, invalidate, isCredentialDefinitionChagneOutdatingCredentials, isCredentialSet, prepareCredential

Methods inherited from interface pl.edu.icm.unity.base.describedObject.NamedObject

getName

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

getSerializedConfiguration, setSerializedConfiguration

Field Details

credentialName

protected String credentialName

Constructor Details

AbstractLocalVerificator

public AbstractLocalVerificator(String name,
 String description,
 String exchangeId,
 boolean supportingInvalidation)

Method Details

getCredentialName

public String getCredentialName()

Specified by:

getCredentialName in interface LocalCredentialVerificator

Returns:

the name of the credential definition associated with this verificator

setCredentialName

public void setCredentialName(String credentialName)

Description copied from interface: LocalCredentialVerificator

Sets credential definition name for this verificator. This is only required to perform resolving of the client's identity, to get a proper credential. It is irrelevant for credential's storage.

Specified by:

setCredentialName in interface LocalCredentialVerificator

isSupportingInvalidation

public boolean isSupportingInvalidation()

Specified by:

isSupportingInvalidation in interface LocalCredentialVerificator

Returns:

If the instances can be put into the LocalCredentialState.outdated state.

getType

public CredentialVerificator.VerificatorType getType()

Specified by:

getType in interface CredentialVerificator

updateCredentialAfterConfigurationChange

public Optional<String> updateCredentialAfterConfigurationChange(String currentCredential)

Description copied from interface: LocalCredentialVerificator

Returns optionally changed argument credential, which can be transformed after the change of configuration. It can be assumed that argument credential was created with some old configuration and that the current object is configured with the new one.

Specified by:

updateCredentialAfterConfigurationChange in interface LocalCredentialVerificator