/*
 * Copyright (c) 2011-2017 Contributors to the Eclipse Foundation
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
 * which is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
 */

package io.vertx.core.net;

import io.vertx.core.Vertx;
import io.vertx.core.impl.VertxInternal;
import io.vertx.core.net.impl.KeyStoreHelper;

import javax.net.ssl.KeyManagerFactory;
import javax.net.ssl.X509KeyManager;
import java.util.function.Function;

Key/cert configuration options.
Author:
Julien Viet/**
 * Key/cert configuration options.
 *
 * @author <a href="mailto:julien@julienviet.com">Julien Viet</a>
 */
public interface KeyCertOptions {

  
Returns:
a copy of these options
Deprecated:
use copy() instead/**
   * @return a copy of these options
   * @deprecated use {@link #copy()} instead
   */
  @Deprecated
  KeyCertOptions clone();

  
Returns:
a copy of these options/**
   * @return a copy of these options
   */
  @SuppressWarnings("deprecation")
  default KeyCertOptions copy() {
    return clone();
  }

  
Create and return the key manager factory for these options.

The returned key manager factory should be already initialized and ready to use.
Params:
vertx – the vertx instance
Returns:
the key manager factory/**
   * Create and return the key manager factory for these options.
   * <p>
   * The returned key manager factory should be already initialized and ready to use.
   *
   * @param vertx the vertx instance
   * @return the key manager factory
   */
  default KeyManagerFactory getKeyManagerFactory(Vertx vertx) throws Exception {
    return KeyStoreHelper.create((VertxInternal) vertx, this).getKeyMgrFactory();
  }

  
Returns a function that maps SNI server names to X509KeyManager instance. The returned X509KeyManager must satisfies these rules: 

  
X509KeyManager.getPrivateKey(String) returns the private key for the indicated server name, the alias parameter will be null.
  
X509KeyManager.getCertificateChain(String) returns the certificate chain for the indicated server name, the alias parameter will be null.

The mapper is only used when the server has SNI enabled and the client indicated a server name.
 The returned function may return null in which case the default key manager provided by getKeyManagerFactory(Vertx) will be used. /**
   * Returns a function that maps SNI server names to {@link X509KeyManager} instance.
   *
   * The returned {@code X509KeyManager} must satisfies these rules:
   *
   * <ul>
   *   <li>{@link X509KeyManager#getPrivateKey(String)} returns the private key for the indicated server name,
   *   the {@code alias} parameter will be {@code null}.</li>
   *   <li>{@link X509KeyManager#getCertificateChain(String)} returns the certificate chain for the indicated server name,
   *   the {@code alias} parameter will be {@code null}.</li>
   * </ul>
   *
   * The mapper is only used when the server has SNI enabled and the client indicated a server name.
   * <p>
   * The returned function may return null in which case the default key manager provided by {@link #getKeyManagerFactory(Vertx)}
   * will be used.
   *
   */
  default Function<String, X509KeyManager> keyManagerMapper(Vertx vertx) throws Exception {
    KeyStoreHelper helper = KeyStoreHelper.create((VertxInternal) vertx, this);
    return helper::getKeyMgr;
  }
}