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

Interface CredentialManagement

public interface CredentialManagement

Credential management API

Author:

K. Benedyczak

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_CREDENTIAL

Method Summary

Modifier and Type	Method	Description
void	addCredentialDefinition(CredentialDefinition credentialDefinition)	Defines a new credential definition, so it can be assigned to entities via credential requirements and to local authenticators.
CredentialDefinition	getCredentialDefinition(String name)
Collection<CredentialDefinition>	getCredentialDefinitions()
Collection<CredentialType>	getCredentialTypes()
void	removeCredentialDefinition(String toRemove)	Removes the given credential definition.
void	updateCredentialDefinition(CredentialDefinition updated, LocalCredentialState desiredCredState)	Updates a definition of a credential.

Field Detail

DEFAULT_CREDENTIAL

static final String DEFAULT_CREDENTIAL

See Also:

Constant Field Values

Method Detail

getCredentialTypes

Collection<CredentialType> getCredentialTypes()
                                       throws EngineException

Returns:

list of available credential types.

Throws:

EngineException

addCredentialDefinition

void addCredentialDefinition(CredentialDefinition credentialDefinition)
                      throws EngineException

Defines a new credential definition, so it can be assigned to entities via credential requirements and to local authenticators.

Parameters:

credentialDefinition -

Throws:

EngineException

updateCredentialDefinition

void updateCredentialDefinition(CredentialDefinition updated,
                                LocalCredentialState desiredCredState)
                         throws EngineException

Updates a definition of a credential.

Parameters:

updated - updated data. The existing one is matched by name.

desiredCredState - The desired credential state to be applied to entities which have this credential currently set. If value is 'correct', then the operation will be successful only if all entities which have this credential are fulfilling the new rules. If the value is 'outdated' then all identities which have this credential set will have the state changed to 'valid' if their credentials fulfill the rules of the new requirements or to 'outdated' otherwise. The 'notSet' value means that the current credentials should have their values cleared.

Throws:

EngineException

removeCredentialDefinition

void removeCredentialDefinition(String toRemove)
                         throws EngineException

Removes the given credential definition. The operation will be successful only if the credential is not used by neither existing authenticators nor existing credential requirements.

Parameters:

toRemove -

Throws:

EngineException

getCredentialDefinitions

Collection<CredentialDefinition> getCredentialDefinitions()
                                                   throws EngineException

Returns:

collection of existing credential definitions

Throws:

EngineException

getCredentialDefinition

CredentialDefinition getCredentialDefinition(String name)
                                      throws EngineException

Returns:

Credential definition with given name

Throws:

EngineException