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

Interface RealmsManagement

  • public interface RealmsManagement
    Authentication realm is a group of endpoints which share the same authentication context: in the first place login session. Also other artifacts can have realm scope, for instance the transient identities.
    Author:
    K. Benedyczak

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addRealm​(pl.edu.icm.unity.types.authn.AuthenticationRealm realm)
      Creates a new realm
      pl.edu.icm.unity.types.authn.AuthenticationRealm getRealm​(java.lang.String name)
      Returns a realm by name
      java.util.Collection<pl.edu.icm.unity.types.authn.AuthenticationRealm> getRealms()
      Returns all defined realms
      void removeRealm​(java.lang.String name)
      Remove realm
      void updateRealm​(pl.edu.icm.unity.types.authn.AuthenticationRealm realm)
      Update realm

    • Method Detail

      • addRealm

        void addRealm​(pl.edu.icm.unity.types.authn.AuthenticationRealm realm)
       throws pl.edu.icm.unity.exceptions.EngineException
        Creates a new realm
        Parameters:
        realm -
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • getRealm

        pl.edu.icm.unity.types.authn.AuthenticationRealm getRealm​(java.lang.String name)
                                                   throws pl.edu.icm.unity.exceptions.WrongArgumentException,
                                                          pl.edu.icm.unity.exceptions.EngineException
        Returns a realm by name
        Parameters:
        name -
        Returns:
        Throws:
        pl.edu.icm.unity.exceptions.WrongArgumentException
        pl.edu.icm.unity.exceptions.EngineException

      • getRealms

        java.util.Collection<pl.edu.icm.unity.types.authn.AuthenticationRealm> getRealms()
                                                                          throws pl.edu.icm.unity.exceptions.EngineException
        Returns all defined realms
        Returns:
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • updateRealm

        void updateRealm​(pl.edu.icm.unity.types.authn.AuthenticationRealm realm)
          throws pl.edu.icm.unity.exceptions.EngineException
        Update realm
        Parameters:
        realm -
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • removeRealm

        void removeRealm​(java.lang.String name)
          throws pl.edu.icm.unity.exceptions.EngineException
        Remove realm
        Parameters:
        name -
        Throws:
        pl.edu.icm.unity.exceptions.EngineException