Interface ReloadableSecurityComponent

All Known Implementing Classes:
JwtRealm, LdapRealm, LdapSessionFactory, Realms, SessionFactory

public interface ReloadableSecurityComponent
This interface allows adding support for reload operations (on secure settings change) in a generic way for security components. The implementors of this interface will be called when the values of SecureSettings should be reloaded by security plugin. For more information about reloading plugin secure settings, see ReloadablePlugin.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    reload(Settings settings)
    Called when a reload security settings action is executed.
  • Method Details

    • reload

      void reload(Settings settings)
      Called when a reload security settings action is executed. The reload operation must be completed when this method returns. Strictly speaking, the settings argument should not be accessed outside of this method's call stack, as any values stored in the node's keystore (see SecureSetting) will not otherwise be retrievable.

      There is no guarantee that the secure setting's values have actually changed. Hence, it's up to implementor to detect if the actual internal reloading is necessary.

      Any failure during the reloading should be signaled by raising an exception.

      For additional info, see also: ReloadablePlugin.reload(Settings).

      Parameters:
      settings - Settings include the initial node's settings and all decrypted secure settings from the keystore. Absence of a particular secure setting may mean that the setting was either never configured or that it was simply removed.