Package org.forgerock.openam.core.realms

Interface Realm

public interface Realm
Models a valid realm within OpenAM.

On creation of a Realm instance the realm String will be validated and used to look up the realm.

Note: Realms are case-insensitive and therefore are compared ignoring case.

Since:
14.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    asDN()
    Returns the realm in DN format.
    String
    asPath()
    Returns the realm in path format.
    String
    asRoutingPath()
    Returns the realm in routing path format.
    default boolean
    isParentOf(Realm subRealm)
    Returns true if this realm is a parent of the provided sub realm.

  • Method Details

    • asPath

      String asPath()
      Returns the realm in path format. e.g. /realmA/realmB
      Returns:
      The realm path.

    • asRoutingPath

      String asRoutingPath()
      Returns the realm in routing path format. e.g. /realms/root/realms/realmA/realms/realmB
      Returns:
      The routing path.

    • asDN

      String asDN()
      Returns the realm in DN format. e.g. 'o=realmA,o=realmB,ou=services,dc=example,dc=com'.
      Returns:
      The realm DN.

    • isParentOf

      default boolean isParentOf(Realm subRealm)
      Returns true if this realm is a parent of the provided sub realm.
      Parameters:
      subRealm - The potential sub realm.
      Returns:
      true if this realm is a parent of the provided sub realm, otherwise false.
      Throws:
      NullPointerException - If subRealm is null.