Package org.forgerock.am.config

Interface RealmConfiguration<T>

  • Type Parameters:
    T - The annotated configuration class containing the service's realm attributes.
    All Known Subinterfaces:
    IotServiceConfig
    public interface RealmConfiguration<T>
    This interface identifies the ServiceComponentConfig as containing configuration that is applied to a realm.

    • Method Detail

      • realm

        Optional<T> realm​(Realm realm,
                  String id)
        Gets the configuration instance for the given realm with the given id.
        Parameters:
        realm - The Realm containing the configuration.
        id - The identify for the configuration instance.
        Returns:
        The configuration instance containing the realm service attributes.
        Throws:
        IllegalStateException - If the configuration does not adhere to the given service interface's types.
        ServiceConfigException - If the configuration could not be retrieved.

      • realmSingleton

        Optional<T> realmSingleton​(Realm realm)
        Gets the single configuration instance for the given realm.
        Parameters:
        realm - The Realm containing the configuration.
        Returns:
        The configuration instance containing the realm service attributes.
        Throws:
        IllegalStateException - If the configuration does not adhere to the given service interface's types.
        ServiceConfigException - If the configuration could not be retrieved.

      • realm

        Set<T> realm​(Realm realm)
        Gets the configuration instances for the given realm.
        Parameters:
        realm - The Realm containing the configuration.
        Returns:
        The collection of configuration instances present in the given realm.
        Throws:
        IllegalStateException - If the configuration does not adhere to the given service interface's types.
        ServiceConfigException - If the configuration could not be retrieved.

      • realmDefaults

        T realmDefaults()
        Gets the configurations realm defaults.
        Returns:
        The configuration instance containing the realm service attributes default values.
        Throws:
        IllegalStateException - If the configuration does not adhere to the given service interface's types.
        ServiceConfigException - If the configuration could not be retrieved.