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

    Modifier and Type
    Method
    Description
    void
    addRealm(pl.edu.icm.unity.base.authn.AuthenticationRealm realm)
    Creates a new realm
    pl.edu.icm.unity.base.authn.AuthenticationRealm
    getRealm(String name)
    Returns a realm by name
    Collection<pl.edu.icm.unity.base.authn.AuthenticationRealm>
    getRealms()
    Returns all defined realms
    void
    removeRealm(String name)
    Remove realm
    void
    updateRealm(pl.edu.icm.unity.base.authn.AuthenticationRealm realm)
    Update realm

  • Method Details

    • addRealm

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

    • getRealm

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

    • getRealms

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

    • updateRealm

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

    • removeRealm

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