com.hivemq.bootstrap.netty.ChannelInitializerFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hivemq-community-edition-embedded Show documentation

HiveMQ CE is a Java-based open source MQTT broker that fully supports MQTT 3.x and MQTT 5

The newest version!

/*
 * Copyright 2019-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.bootstrap.netty;

import com.hivemq.bootstrap.netty.initializer.AbstractChannelInitializer;
import com.hivemq.bootstrap.netty.initializer.TcpChannelInitializer;
import com.hivemq.bootstrap.netty.initializer.TlsTcpChannelInitializer;
import com.hivemq.bootstrap.netty.initializer.TlsWebsocketChannelInitializer;
import com.hivemq.bootstrap.netty.initializer.WebsocketChannelInitializer;
import com.hivemq.configuration.service.entity.Listener;
import com.hivemq.extension.sdk.api.annotations.NotNull;

/**
 * Interface for {@link ChannelInitializerFactoryImpl}
 *
 * @author Florian Limpöck
 * @since 4.0.0
 */
public interface ChannelInitializerFactory {

    /**
     * The returned channel initializer ca be:
     * 
     * {@link TcpChannelInitializer}
     * {@link TlsTcpChannelInitializer}
     * {@link WebsocketChannelInitializer}
     * {@link TlsWebsocketChannelInitializer}
     * 
     *
     * @param listener the listener to create a channel initializer for
     * @return a channel initializer for a specific listener.
     * @throws NullPointerException     If listener is null.
     * @throws IllegalArgumentException If listener type is unknown.
     */
    @NotNull AbstractChannelInitializer getChannelInitializer(final @NotNull Listener listener);

}