pl.edu.icm.unity.engine.api

Interface EntityCredentialManagement

public interface EntityCredentialManagement

API for management of entities' credentials.

Author:

K. Benedyczak

Method Summary

Modifier and Type	Method and Description
boolean	isCurrentCredentialRequiredForChange(pl.edu.icm.unity.types.basic.EntityParam entity, String credentialId)
void	setEntityCredential(pl.edu.icm.unity.types.basic.EntityParam entity, String credentialId, String rawCredential) As setEntityCredential(EntityParam, String, String, String) but works only when invoked with super administrative role, so that the current credential is not used.
void	setEntityCredential(pl.edu.icm.unity.types.basic.EntityParam entity, String credentialId, String secrets, String previousSecrets) Sets authentication secretes for the entity.
void	setEntityCredentialRequirements(pl.edu.icm.unity.types.basic.EntityParam entity, String requirementId) Changes CredentialRequirements of an entity.
void	setEntityCredentialStatus(pl.edu.icm.unity.types.basic.EntityParam entity, String credentialId, pl.edu.icm.unity.types.authn.LocalCredentialState desiredCredentialState) Sets local credential state.

Method Detail

setEntityCredentialRequirements

void setEntityCredentialRequirements(pl.edu.icm.unity.types.basic.EntityParam entity,
                                     String requirementId)
                              throws pl.edu.icm.unity.exceptions.EngineException

Changes CredentialRequirements of an entity.

Parameters:

entity - to be modified

requirementId - to be set

Throws:

pl.edu.icm.unity.exceptions.EngineException

setEntityCredential

void setEntityCredential(pl.edu.icm.unity.types.basic.EntityParam entity,
                         String credentialId,
                         String secrets,
                         String previousSecrets)
                  throws pl.edu.icm.unity.exceptions.EngineException

Sets authentication secretes for the entity. After the change, the credential will be in correct state.

Parameters:

entity - to be modified

credentialId - credential id to be changed.

secrets - the credential type specific value of the credential.

previousSecrets - used to check if the previous credential is known to the caller.

Throws:

pl.edu.icm.unity.exceptions.EngineException

setEntityCredentialStatus

void setEntityCredentialStatus(pl.edu.icm.unity.types.basic.EntityParam entity,
                               String credentialId,
                               pl.edu.icm.unity.types.authn.LocalCredentialState desiredCredentialState)
                        throws pl.edu.icm.unity.exceptions.EngineException

Sets local credential state.

Parameters:

entity - to be modified

credentialId - credential id to be changed.

desiredCredentialState - desired credential state. If 'notSet' then the current credential is removed. The status can be set to 'outdated' only if the credential supports invalidation and currently there is a (correct or outdated) credential set. The 'correct' value is not allowed, and will cause an exception. Credential can be put into correct state with setEntityCredential(EntityParam, String, String).

Throws:

pl.edu.icm.unity.exceptions.EngineException

setEntityCredential

void setEntityCredential(pl.edu.icm.unity.types.basic.EntityParam entity,
                         String credentialId,
                         String rawCredential)
                  throws pl.edu.icm.unity.exceptions.EngineException

As setEntityCredential(EntityParam, String, String, String) but works only when invoked with super administrative role, so that the current credential is not used.

Parameters:

entity -

credentialId -

rawCredential -

Throws:

pl.edu.icm.unity.exceptions.EngineException

isCurrentCredentialRequiredForChange

boolean isCurrentCredentialRequiredForChange(pl.edu.icm.unity.types.basic.EntityParam entity,
                                             String credentialId)
                                      throws pl.edu.icm.unity.exceptions.EngineException

Parameters:

entity -

credentialId -

Returns:

true only if the setEntityCredential(EntityParam, String, String) method can be used. If false then the setEntityCredential(EntityParam, String, String, String) version must be used.

Throws:

pl.edu.icm.unity.exceptions.EngineException