Package akka.cluster

Class JoinConfigCompatChecker$


  • public class JoinConfigCompatChecker$
    extends java.lang.Object
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static JoinConfigCompatChecker$ MODULE$
      Static reference to the singleton instance of this Scala object.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ConfigValidation exists​(scala.collection.immutable.Seq<java.lang.String> requiredKeys, com.typesafe.config.Config toCheck)
      Checks that all requiredKeys are available in toCheck Config.
      com.typesafe.config.Config filterWithKeys​(scala.collection.immutable.Seq<java.lang.String> requiredKeys, com.typesafe.config.Config config)
      INTERNAL API Builds a new Config object containing only the required entries defined by requiredKeys
      ConfigValidation fullMatch​(scala.collection.immutable.Seq<java.lang.String> requiredKeys, com.typesafe.config.Config toCheck, com.typesafe.config.Config actualConfig)
      Checks that all requiredKeys are available in toCheck Config and its values match exactly the values in currentConfig.
      JoinConfigCompatChecker load​(ExtendedActorSystem system, ClusterSettings clusterSettings)
      INTERNAL API
      scala.collection.immutable.Seq<java.lang.String> removeSensitiveKeys​(com.typesafe.config.Config config, ClusterSettings clusterSettings)
      INTERNAL API Builds a Seq of keys using the passed Config not including any sensitive keys, as defined in 'akka.cluster.configuration-compatibility-check.sensitive-config-paths'.
      scala.collection.immutable.Seq<java.lang.String> removeSensitiveKeys​(scala.collection.immutable.Seq<java.lang.String> requiredKeys, ClusterSettings clusterSettings)
      INTERNAL API Removes sensitive keys, as defined in 'akka.cluster.configuration-compatibility-check.sensitive-config-paths', from the passed requiredKeys Seq.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • MODULE$

        public static final JoinConfigCompatChecker$ MODULE$
        Static reference to the singleton instance of this Scala object.
    • Constructor Detail

      • JoinConfigCompatChecker$

        public JoinConfigCompatChecker$()
    • Method Detail

      • exists

        public ConfigValidation exists​(scala.collection.immutable.Seq<java.lang.String> requiredKeys,
                                       com.typesafe.config.Config toCheck)
        Checks that all requiredKeys are available in toCheck Config.

        Parameters:
        requiredKeys - - a Seq of required keys
        toCheck - - the Config instance to be checked
        Returns:
        (undocumented)
      • fullMatch

        public ConfigValidation fullMatch​(scala.collection.immutable.Seq<java.lang.String> requiredKeys,
                                          com.typesafe.config.Config toCheck,
                                          com.typesafe.config.Config actualConfig)
        Checks that all requiredKeys are available in toCheck Config and its values match exactly the values in currentConfig.

        Parameters:
        requiredKeys - - a Seq of required keys
        toCheck - - the Config instance to be checked
        actualConfig - - the Config instance containing the expected values
        Returns:
        (undocumented)
      • filterWithKeys

        public com.typesafe.config.Config filterWithKeys​(scala.collection.immutable.Seq<java.lang.String> requiredKeys,
                                                         com.typesafe.config.Config config)
        INTERNAL API Builds a new Config object containing only the required entries defined by requiredKeys

        This method is used from the joining side to prepare the Config instance that will be sent over the wire. We don't send the full config to avoid unnecessary data transfer, but also to avoid leaking any sensitive information that users may have added to their configuration.

        Parameters:
        requiredKeys - (undocumented)
        config - (undocumented)
        Returns:
        (undocumented)
      • removeSensitiveKeys

        public scala.collection.immutable.Seq<java.lang.String> removeSensitiveKeys​(scala.collection.immutable.Seq<java.lang.String> requiredKeys,
                                                                                    ClusterSettings clusterSettings)
        INTERNAL API Removes sensitive keys, as defined in 'akka.cluster.configuration-compatibility-check.sensitive-config-paths', from the passed requiredKeys Seq.
        Parameters:
        requiredKeys - (undocumented)
        clusterSettings - (undocumented)
        Returns:
        (undocumented)
      • removeSensitiveKeys

        public scala.collection.immutable.Seq<java.lang.String> removeSensitiveKeys​(com.typesafe.config.Config config,
                                                                                    ClusterSettings clusterSettings)
        INTERNAL API Builds a Seq of keys using the passed Config not including any sensitive keys, as defined in 'akka.cluster.configuration-compatibility-check.sensitive-config-paths'.
        Parameters:
        config - (undocumented)
        clusterSettings - (undocumented)
        Returns:
        (undocumented)