com.helger.config.source.AbstractConfigurationSource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-config Show documentation
General purpose configuration library with different sources
There is a newer version: 11.1.8
/*
 * Copyright (C) 2014-2024 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.helger.config.source;

import java.util.Iterator;
import java.util.Locale;
import java.util.Map;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;

import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.MustImplementEqualsAndHashcode;
import com.helger.commons.hashcode.HashCodeGenerator;
import com.helger.commons.string.StringHelper;
import com.helger.commons.string.ToStringGenerator;

/**
 * Abstract base class for any configuration source.
 *
 * @author Philip Helger
 */
@MustImplementEqualsAndHashcode
@Immutable
public abstract class AbstractConfigurationSource implements IConfigurationSource
{
  private final EConfigSourceType m_eSourceType;
  private final int m_nPriority;

  protected static final boolean hasTrailingWhitespace (@Nullable final String s)
  {
    return StringHelper.hasText (s) && Character.isWhitespace (s.charAt (s.length () - 1));
  }

  /**
   * Constructor
   *
   * @param eSourceType
   *        Configuration source type. May not be null.
   * @param nPriority
   *        The priority to use. The higher the more important.
   */
  protected AbstractConfigurationSource (@Nonnull final EConfigSourceType eSourceType, final int nPriority)
  {
    ValueEnforcer.notNull (eSourceType, "Type");
    m_eSourceType = eSourceType;
    m_nPriority = nPriority;
  }

  @Nonnull
  public final EConfigSourceType getSourceType ()
  {
    return m_eSourceType;
  }

  public final int getPriority ()
  {
    return m_nPriority;
  }

  // TODO for 11.2: make public
  protected static boolean isSecretKey (@Nonnull final String sKey)
  {
    // Bad heuristics but better then nothing
    final String sRealKey = sKey.toLowerCase (Locale.ROOT);
    return sRealKey.contains ("password") || sRealKey.contains ("passwd");
  }

  // TODO for 11.2: rename to mapToStringIgnoreSecrets
  @Nonnull
  protected static  String mapToStringNoSecrets (@Nullable final Map  aMap)
  {
    if (aMap == null)
      return "null";

    final Iterator > aIter = aMap.entrySet ().iterator ();
    if (!aIter.hasNext ())
      return "{}";

    final StringBuilder aSB = new StringBuilder ();
    aSB.append ('{');
    while (true)
    {
      final Map.Entry  aEntry = aIter.next ();
      final String sKey = aEntry.getKey ();
      aSB.append (sKey).append ('=');

      // Avoid logging passwords
      if (isSecretKey (sKey))
        aSB.append (ToStringGenerator.CONSTANT_PASSWORD);
      else
        aSB.append (aEntry.getValue ());

      if (!aIter.hasNext ())
        break;
      aSB.append (',').append (' ');
    }
    return aSB.append ('}').toString ();
  }

  @Override
  public boolean equals (final Object o)
  {
    if (o == this)
      return true;
    if (o == null || !getClass ().equals (o.getClass ()))
      return false;
    final AbstractConfigurationSource rhs = (AbstractConfigurationSource) o;
    return m_eSourceType.equals (rhs.m_eSourceType) && m_nPriority == rhs.m_nPriority;
  }

  @Override
  public int hashCode ()
  {
    return new HashCodeGenerator (this).append (m_eSourceType).append (m_nPriority).getHashCode ();
  }

  @Override
  public String toString ()
  {
    return new ToStringGenerator (this).append ("SourceType", m_eSourceType)
                                       .append ("Priority", m_nPriority)
                                       .getToString ();
  }
}