com.helger.http.tls.ITLSConfigurationMode Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2014-2020 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.http.tls;

import java.io.Serializable;

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

import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.collection.impl.ICommonsList;

/**
 * TLS Configuration mode read-only interface.
 *
 * @author Philip Helger
 * @since 9.0.5
 */
public interface ITLSConfigurationMode extends Serializable
{
  /**
   * @return A list of supported TLS versions in the correct order. May not be
   *         null.
   */
  @Nonnull
  @ReturnsMutableCopy
  ICommonsList  getAllTLSVersions ();

  /**
   * @return A list of the IDs of the supported TLS versions in the correct order.
   *         May not be null.
   */
  @Nonnull
  @ReturnsMutableCopy
  default ICommonsList  getAllTLSVersionIDs ()
  {
    return getAllTLSVersions ().getAllMapped (ETLSVersion::getID);
  }

  /**
   * @return A list of the IDs of the supported TLS versions in the correct order.
   *         May be null if no TLS versions are defined.
   */
  @Nullable
  default String [] getAllTLSVersionIDsAsArray ()
  {
    final ICommonsList  aList = getAllTLSVersionIDs ();
    return aList.isEmpty () ? null : aList.toArray (new String [aList.size ()]);
  }

  /**
   * @return All cipher suites in the correct order. May not be null.
   */
  @Nonnull
  @ReturnsMutableCopy
  ICommonsList  getAllCipherSuites ();

  /**
   * @return All cipher suites in the correct order. May be null if
   *         no cipher suite is defined.
   */
  @Nullable
  default String [] getAllCipherSuitesAsArray ()
  {
    final ICommonsList  aList = getAllCipherSuites ();
    return aList.isEmpty () ? null : aList.toArray (new String [aList.size ()]);
  }
}