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

Interface EntityCredentialManagement

  • public interface EntityCredentialManagement
    API for management of entities' credentials.
    Author:
    K. Benedyczak

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void setEntityCredential​(pl.edu.icm.unity.types.basic.EntityParam entity, java.lang.String credentialId, java.lang.String secrets)
      Sets authentication secretes for the entity.
      void setEntityCredentialRequirements​(pl.edu.icm.unity.types.basic.EntityParam entity, java.lang.String requirementId)
      Changes CredentialRequirements of an entity.
      void setEntityCredentialStatus​(pl.edu.icm.unity.types.basic.EntityParam entity, java.lang.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,
                                     java.lang.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,
                         java.lang.String credentialId,
                         java.lang.String secrets)
                  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.
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • setEntityCredentialStatus

        void setEntityCredentialStatus​(pl.edu.icm.unity.types.basic.EntityParam entity,
                               java.lang.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