Package org.apache.bookkeeper.net

Class AbstractDNSToSwitchMapping

  • All Implemented Interfaces:
    Configurable, DNSToSwitchMapping
    Direct Known Subclasses:
    CachedDNSToSwitchMapping
    public abstract class AbstractDNSToSwitchMapping
extends java.lang.Object
implements DNSToSwitchMapping, Configurable
    This is a base class for DNS to Switch mappings.

    It is not mandatory to derive DNSToSwitchMapping implementations from it, but it is strongly recommended, as it makes it easy for the Hadoop developers to add new methods to this base class that are automatically picked up by all implementations.

    This class does not extend the Configured base class, and should not be changed to do so, as it causes problems for subclasses. The constructor of the Configured calls the setConf(Configuration) method, which will call into the subclasses before they have been fully constructed.

    • Constructor Detail

      • AbstractDNSToSwitchMapping

        protected AbstractDNSToSwitchMapping()
        Create an unconfigured instance.

      • AbstractDNSToSwitchMapping

        protected AbstractDNSToSwitchMapping​(org.apache.commons.configuration.Configuration conf)
        Create an instance, caching the configuration file. This constructor does not call setConf(Configuration); if a subclass extracts information in that method, it must call it explicitly.
        Parameters:
        conf - the configuration

    • Method Detail

      • getConf

        public org.apache.commons.configuration.Configuration getConf()
        Description copied from interface: Configurable
        Return the configuration used by this object.
        Specified by:
        getConf in interface Configurable
        Returns:
        configuration used by this object.

      • setConf

        public void setConf​(org.apache.commons.configuration.Configuration conf)
        Description copied from interface: Configurable
        Set the configuration to be used by this object.
        Specified by:
        setConf in interface Configurable
        Parameters:
        conf - Configuration object to use

      • isSingleSwitch

        public boolean isSingleSwitch()
        Predicate that indicates that the switch mapping is known to be single-switch. The base class returns false: it assumes all mappings are multi-rack. Subclasses may override this with methods that are more aware of their topologies.

        This method is used when parts of Hadoop need know whether to apply single rack vs multi-rack policies, such as during block placement. Such algorithms behave differently if they are on multi-switch systems.

        Returns:
        true if the mapping thinks that it is on a single switch

      • getSwitchMap

        public java.util.Map<java.lang.String,​java.lang.String> getSwitchMap()
        Get a copy of the map (for diagnostics).
        Returns:
        a clone of the map or null for none known

      • dumpTopology

        public java.lang.String dumpTopology()
        Generate a string listing the switch mapping implementation, the mapping for every known node and the number of nodes and unique switches known about -each entry to a separate line.
        Returns:
        a string that can be presented to the ops team or used in debug messages.

      • isSingleSwitchByScriptPolicy

        protected boolean isSingleSwitchByScriptPolicy()

      • isMappingSingleSwitch

        public static boolean isMappingSingleSwitch​(DNSToSwitchMapping mapping)
        Query for a DNSToSwitchMapping instance being on a single switch.

        This predicate simply assumes that all mappings not derived from this class are multi-switch.

        Parameters:
        mapping - the mapping to query
        Returns:
        true if the base class says it is single switch, or the mapping is not derived from this class.

      • validateConf

        protected void validateConf()
        when setConf is called it should do sanity checking of the conf/env. and throw RuntimeException if things are not valid.