ServerInitializerFactory.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.camel.component.netty4;

import io.netty.channel.Channel;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelPipeline;


/**
 * Factory to create {@link ChannelPipeline} for servers, eg {@link NettyConsumer}.
 * <p/>
 * Implementators must support creating a new instance of this factory which is associated
 * to the given {@link NettyConsumer} using the {@link #createPipelineFactory(NettyConsumer)}
 * method.
 *
 * @see ChannelInitializer
 */
public abstract class ServerInitializerFactory extends ChannelInitializer<Channel> {

    /**
     * Creates a new {@link ServerInitializerFactory} using the given {@link NettyConsumer}
     *
     * @param consumer the associated consumer
     * @return the {@link ServerInitializerFactory} associated to the given consumer.
     */
    public abstract ServerInitializerFactory createPipelineFactory(NettyConsumer consumer);

}