com.helger.security.keystore.IKeyStoreDescriptor 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

The newest version!

/*
 * 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.keystore;

import java.security.Provider;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.annotation.Nonempty;

/**
 * Interface describing the parameters needed to reference a key store (without
 * a private key).
 *
 * @author Philip Helger
 * @since 11.1.10
 */
public interface IKeyStoreDescriptor
{
  /**
   * @return The type of the key store. May not be null.
   */
  @Nonnull
  IKeyStoreType getKeyStoreType ();

  /**
   * @return The path to the key store. May neither be null nor
   *         empty. The interpretation of the path is implementation dependent.
   */
  @Nonnull
  @Nonempty
  String getKeyStorePath ();

  /**
   * @return The password required to open the key store. May not be
   *         null but may be empty.
   */
  @Nonnull
  char [] getKeyStorePassword ();

  /**
   * @return The Java security provider for loading the key store. May be
   *         null.
   */
  @Nullable
  Provider getProvider ();

  /**
   * @return The loaded key store based on the parameters in this descriptor.
   *         Never null.
   */
  @Nonnull
  LoadedKeyStore loadKeyStore ();
}