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

Interface IdPEngine

  • public interface IdPEngine

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      pl.edu.icm.unity.types.basic.IdentityParam getIdentity​(java.util.List<pl.edu.icm.unity.types.basic.IdentityParam> validIdentities, java.lang.String selectedIdentity)
      Finds selected identity among validIdentities and returns it as IdentityParam.
      TranslationResult obtainUserInformationWithEarlyImport​(pl.edu.icm.unity.types.basic.IdentityTaV entity, java.lang.String group, pl.edu.icm.unity.types.translation.TranslationProfile profile, java.lang.String requester, java.util.Optional<EntityInGroup> requesterEntity, java.lang.String protocol, java.lang.String protocolSubType, boolean allowIdentityCreate, eu.unicore.util.configuration.PropertiesHelper importsConfig)
      Obtains a complete and translated information about entity, authorized to be published.
      TranslationResult obtainUserInformationWithEnrichingImport​(pl.edu.icm.unity.types.basic.EntityParam entity, java.lang.String group, pl.edu.icm.unity.types.translation.TranslationProfile profile, java.lang.String requester, java.util.Optional<EntityInGroup> requesterEntity, java.lang.String protocol, java.lang.String protocolSubType, boolean allowIdentityCreate, eu.unicore.util.configuration.PropertiesHelper importsConfig)
      Obtains a complete and translated information about entity, authorized to be published.

    • Method Detail

      • obtainUserInformationWithEarlyImport

        TranslationResult obtainUserInformationWithEarlyImport​(pl.edu.icm.unity.types.basic.IdentityTaV entity,
                                                       java.lang.String group,
                                                       pl.edu.icm.unity.types.translation.TranslationProfile profile,
                                                       java.lang.String requester,
                                                       java.util.Optional<EntityInGroup> requesterEntity,
                                                       java.lang.String protocol,
                                                       java.lang.String protocolSubType,
                                                       boolean allowIdentityCreate,
                                                       eu.unicore.util.configuration.PropertiesHelper importsConfig)
                                                throws pl.edu.icm.unity.exceptions.EngineException
        Obtains a complete and translated information about entity, authorized to be published. This variant assumes that the entity should be tried to be imported first and only then resolved. Therefore this variant is useful for 3rd party queries where queried user may at the time of query be missing.
        Parameters:
        entity - entity for which the query is performed
        group - the group from which attributes shall be resolved
        profile - output translation profile to be consulted. Can be null -> then default profile is used.
        requester - identity of requester
        requesterEntity - if present then attributes of this entity in the given group will be added to the output profile context
        protocol - identifier of access protocol
        protocolSubType - sub identifier of protocol (e.g. binding)
        allowIdentityCreate - whether a dynamic id can be established
        Returns:
        obtained data
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • obtainUserInformationWithEnrichingImport

        TranslationResult obtainUserInformationWithEnrichingImport​(pl.edu.icm.unity.types.basic.EntityParam entity,
                                                           java.lang.String group,
                                                           pl.edu.icm.unity.types.translation.TranslationProfile profile,
                                                           java.lang.String requester,
                                                           java.util.Optional<EntityInGroup> requesterEntity,
                                                           java.lang.String protocol,
                                                           java.lang.String protocolSubType,
                                                           boolean allowIdentityCreate,
                                                           eu.unicore.util.configuration.PropertiesHelper importsConfig)
                                                    throws pl.edu.icm.unity.exceptions.EngineException
        Obtains a complete and translated information about entity, authorized to be published. This variant assumes that the entity should be imported after being resolved, i.e. import is enriching already existing entity. Therefore this is useful for obtaining information about authenticated user.
        Parameters:
        entity -
        group -
        profile -
        requester -
        protocol -
        protocolSubType -
        allowIdentityCreate -
        userImports -
        Returns:
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • getIdentity

        pl.edu.icm.unity.types.basic.IdentityParam getIdentity​(java.util.List<pl.edu.icm.unity.types.basic.IdentityParam> validIdentities,
                                                       java.lang.String selectedIdentity)
                                                throws pl.edu.icm.unity.exceptions.EngineException,
                                                       eu.unicore.samly2.exceptions.SAMLRequesterException
        Finds selected identity among validIdentities and returns it as IdentityParam. Argument must be given using comparable identity value.
        Parameters:
        validIdentities -
        selectedIdentity -
        Returns:
        Throws:
        pl.edu.icm.unity.exceptions.EngineException
        eu.unicore.samly2.exceptions.SAMLRequesterException