Package org.elasticsearch.xpack.security.authc.esnative

Class ReservedRealm

java.lang.Object
org.elasticsearch.xpack.core.security.authc.Realm
org.elasticsearch.xpack.security.authc.support.CachingUsernamePasswordRealm
org.elasticsearch.xpack.security.authc.esnative.ReservedRealm
All Implemented Interfaces:
Comparable<org.elasticsearch.xpack.core.security.authc.Realm>, org.elasticsearch.xpack.core.security.authc.support.CachingRealm
public class ReservedRealm extends CachingUsernamePasswordRealm
A realm for predefined users. These users can only be modified in terms of changing their passwords; no other modifications are allowed. This realm is always enabled.

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.elasticsearch.xpack.core.security.authc.Realm

    org.elasticsearch.xpack.core.security.authc.Realm.Factory

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.elasticsearch.common.settings.Setting<org.elasticsearch.common.settings.SecureString>
    AUTOCONFIG_ELASTIC_PASSWORD_HASH
     
    static final org.elasticsearch.common.settings.Setting<org.elasticsearch.common.settings.SecureString>
    BOOTSTRAP_ELASTIC_PASSWORD
     
    static final String
    NAME
     
    static final String
    TYPE
     

    Fields inherited from class org.elasticsearch.xpack.core.security.authc.Realm

    config, logger

  • Constructor Summary

    Constructors
    Constructor
    Description
    ReservedRealm(org.elasticsearch.env.Environment env, org.elasticsearch.common.settings.Settings settings, NativeUsersStore nativeUsersStore, org.elasticsearch.xpack.core.security.user.AnonymousUser anonymousUser, org.elasticsearch.threadpool.ThreadPool threadPool)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    addSettings(List<org.elasticsearch.common.settings.Setting<?>> settingsList)
     
    protected void
    doAuthenticate(org.elasticsearch.xpack.core.security.authc.support.UsernamePasswordToken token, org.elasticsearch.action.ActionListener<org.elasticsearch.xpack.core.security.authc.AuthenticationResult<org.elasticsearch.xpack.core.security.user.User>> listener)
     
    protected void
    doLookupUser(String username, org.elasticsearch.action.ActionListener<org.elasticsearch.xpack.core.security.user.User> listener)
     
    void
    users(org.elasticsearch.action.ActionListener<Collection<org.elasticsearch.xpack.core.security.user.User>> listener)
     

    Methods inherited from class org.elasticsearch.xpack.security.authc.support.CachingUsernamePasswordRealm

    authenticate, expire, expireAll, getCacheSize, handleCachedAuthentication, lookupUser, supports, token, usageStats

    Methods inherited from class org.elasticsearch.xpack.core.security.authc.Realm

    compareTo, domain, getAuthenticationFailureHeaders, initialize, name, order, toString, type

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.elasticsearch.xpack.core.security.authc.support.CachingRealm

    name

  • Field Details

    • TYPE

      public static final String TYPE
      See Also:

    • NAME

      public static final String NAME
      See Also:

    • BOOTSTRAP_ELASTIC_PASSWORD

      public static final org.elasticsearch.common.settings.Setting<org.elasticsearch.common.settings.SecureString> BOOTSTRAP_ELASTIC_PASSWORD

    • AUTOCONFIG_ELASTIC_PASSWORD_HASH

      public static final org.elasticsearch.common.settings.Setting<org.elasticsearch.common.settings.SecureString> AUTOCONFIG_ELASTIC_PASSWORD_HASH

  • Constructor Details

    • ReservedRealm

      public ReservedRealm(org.elasticsearch.env.Environment env, org.elasticsearch.common.settings.Settings settings, NativeUsersStore nativeUsersStore, org.elasticsearch.xpack.core.security.user.AnonymousUser anonymousUser, org.elasticsearch.threadpool.ThreadPool threadPool)

  • Method Details

    • doAuthenticate

      protected void doAuthenticate(org.elasticsearch.xpack.core.security.authc.support.UsernamePasswordToken token, org.elasticsearch.action.ActionListener<org.elasticsearch.xpack.core.security.authc.AuthenticationResult<org.elasticsearch.xpack.core.security.user.User>> listener)
      Specified by:
      doAuthenticate in class CachingUsernamePasswordRealm

    • doLookupUser

      protected void doLookupUser(String username, org.elasticsearch.action.ActionListener<org.elasticsearch.xpack.core.security.user.User> listener)
      Specified by:
      doLookupUser in class CachingUsernamePasswordRealm

    • users

      public void users(org.elasticsearch.action.ActionListener<Collection<org.elasticsearch.xpack.core.security.user.User>> listener)

    • addSettings

      public static void addSettings(List<org.elasticsearch.common.settings.Setting<?>> settingsList)