com.helger.security.password.hash.AbstractPasswordHashCreator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-security Show documentation

Special Java 1.8+ Library with security related functionality

There is a newer version: 11.1.11

/*
 * 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.security.password.hash;

import javax.annotation.Nonnull;

import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.Nonempty;
import com.helger.commons.string.ToStringGenerator;

/**
 * Abstract base class of {@link IPasswordHashCreator}.
 *
 * @author Philip Helger
 */
public abstract class AbstractPasswordHashCreator implements IPasswordHashCreator
{
  private final String m_sAlgorithmName;

  protected AbstractPasswordHashCreator (@Nonnull @Nonempty final String sAlgorithmName)
  {
    m_sAlgorithmName = ValueEnforcer.notEmpty (sAlgorithmName, "Algorithm");
  }

  @Nonnull
  @Nonempty
  public final String getAlgorithmName ()
  {
    return m_sAlgorithmName;
  }

  @Override
  public String toString ()
  {
    return new ToStringGenerator (this).append ("AlgorithmName", m_sAlgorithmName).getToString ();
  }
}