com.hivemq.swarm.extension.sdk.security.SecurityProviderOutput Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2018-present HiveMQ GmbH
 *
 * 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.hivemq.swarm.extension.sdk.security;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import javax.net.ssl.HostnameVerifier;
import javax.net.ssl.KeyManagerFactory;
import javax.net.ssl.TrustManagerFactory;
import java.util.Collection;
import java.util.concurrent.TimeUnit;

/**
 * @author Silvio Giebl
 * @since 4.6.0
 */
public interface SecurityProviderOutput {

    /**
     * Configures username password authentication.
     *
     * @param username the username.
     * @param password the password.
     * @return this.
     * @since 4.6.0
     */
    @NotNull SecurityProviderOutput userNamePassword(@NotNull String username, byte @Nullable [] password);

    /**
     * Sets the optional user defined {@link KeyManagerFactory}.
     *
     * @param keyManagerFactory the key manager factory or null to remove any previously set key manager
     *                          factory.
     * @return this.
     * @since 4.6.0
     */
    @NotNull SecurityProviderOutput keyManagerFactory(@Nullable KeyManagerFactory keyManagerFactory);

    /**
     * Sets the optional user defined {@link TrustManagerFactory}.
     *
     * @param trustManagerFactory the trust manager factory or null to remove any previously set trust
     *                            manager factory.
     * @return this.
     * @since 4.6.0
     */
    @NotNull SecurityProviderOutput trustManagerFactory(@Nullable TrustManagerFactory trustManagerFactory);

    /**
     * Sets the optional user defined cipher suites.
     *
     * @param cipherSuites the cipher suites or null to use the default cipher suites of Netty (network
     *                     communication framework).
     * @return this.
     * @since 4.6.0
     */
    @NotNull SecurityProviderOutput cipherSuites(@Nullable Collection cipherSuites);

    /**
     * Sets the optional user defined protocols.
     *
     * @param protocols the protocols or null to use the default protocols of Netty (network communication
     *                  framework).
     * @return this.
     * @since 4.6.0
     */
    @NotNull SecurityProviderOutput protocols(@Nullable Collection protocols);

    /**
     * Sets the SSL/TLS handshake timeout.
     * 
     * The timeout in nanoseconds must be in the range: [0, {@link Integer#MAX_VALUE}].
     *
     * @param handshakeTimeout the time unit of the given timeout (this timeout only supports millisecond precision).
     * @return this.
     * @since 4.6.0
     */
    @NotNull SecurityProviderOutput handshakeTimeout(long handshakeTimeout, @NotNull TimeUnit timeUnit);

    /**
     * Sets the optional user defined hostname verifier.
     *
     * @param hostnameVerifier the {@link HostnameVerifier} or null to use https hostname verification.
     * @return this.
     * @since 4.6.0
     */
    @NotNull SecurityProviderOutput hostnameVerifier(@Nullable HostnameVerifier hostnameVerifier);
}