Package org.mycore.user2

Class MCRRealm

java.lang.Object
org.mycore.user2.MCRRealm
public class MCRRealm extends Object
Represents a realm of users. Each user belongs to a realm. Realms are configured in the file realms.xml. A realm determines the method that is used to login the user. There is always a local default realm, which is defined by the attribute local in realms.xml.
Author:
Frank Lützenkirchen, Thomas Scheffler (yagee)

  • Field Details

  • Method Details

    • getID

      public String getID()
      Returns the unique ID of the realm.
      Returns:
      the unique ID of the realm.

    • getLabel

      public String getLabel()
      Returns the label in the current language

    • getPasswordChangeURL

      public String getPasswordChangeURL()
      Returns the URL where users from this realm can change their password

    • getLoginURL

      public String getLoginURL()
      Returns the URL where users from this realm can login

    • getCreateURL

      public String getCreateURL()
      Returns:
      the createURL

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getLoginURL

      public String getLoginURL(String redirectURL)
      Returns the URL where users from this realm can login with redirect URL attached. If this realm has a attribut redirectParameter defined this method returns a complete login URL with redirectURL properly configured.
      Parameters:
      redirectURL - URL where to redirect to after login succeeds.
      Returns:
      the same as getLoginURL() if redirectParameter is undefined for this realm

    • getRealmParameter

      public String getRealmParameter()

    • setRealmParameter

      public void setRealmParameter(String realmParameter)