com.helger.security.keystore.LoadedKey Maven / Gradle / Ivy

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: 9.5.5

/**
 * Copyright (C) 2014-2016 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.keystore;

import java.security.KeyStore;

import javax.annotation.Nullable;

import com.helger.commons.collection.ArrayHelper;
import com.helger.commons.state.ISuccessIndicator;

/**
 * This class contains the result of loading the configured private key as
 * configured in the configuration file.
 *
 * @author Philip Helger
 * @param 
 *        The keystore entry type loaded.
 */
public final class LoadedKey  implements ISuccessIndicator
{
  private final T m_aKeyEntry;
  private final EKeyStoreLoadError m_eError;
  private final String [] m_aErrorParams;

  LoadedKey (@Nullable final T aKeyEntry,
             @Nullable final EKeyStoreLoadError eError,
             @Nullable final String... aErrorParams)
  {
    m_aKeyEntry = aKeyEntry;
    m_eError = eError;
    m_aErrorParams = aErrorParams;
  }

  public boolean isSuccess ()
  {
    return m_aKeyEntry != null;
  }

  /**
   * @return The loaded key entry. Never null in case of success.
   *         Always null in case of failure.
   */
  @Nullable
  public T getKeyEntry ()
  {
    return m_aKeyEntry;
  }

  /**
   * @return The error code. Never null in case of failure. Always
   *         null in case of success.
   * @deprecated Use {@link #getError()} instead
   */
  @Deprecated
  @Nullable
  public EKeyStoreLoadError getErrorMessage ()
  {
    return getError ();
  }

  /**
   * @return The error code. Never null in case of failure. Always
   *         null in case of success.
   */
  @Nullable
  public EKeyStoreLoadError getError ()
  {
    return m_eError;
  }

  /**
   * @return The error parameters. Never null in case of failure.
   *         Always null in case of success.
   */
  @Nullable
  public String [] getErrorParams ()
  {
    return m_eError == null ? null : ArrayHelper.getCopy (m_aErrorParams);
  }
}