network/server/TransportServerBootstrap.java

0001 /*
0002  * Licensed to the Apache Software Foundation (ASF) under one or more
0003  * contributor license agreements.  See the NOTICE file distributed with
0004  * this work for additional information regarding copyright ownership.
0005  * The ASF licenses this file to You under the Apache License, Version 2.0
0006  * (the "License"); you may not use this file except in compliance with
0007  * the License.  You may obtain a copy of the License at
0008  *
0009  *    http://www.apache.org/licenses/LICENSE-2.0
0010  *
0011  * Unless required by applicable law or agreed to in writing, software
0012  * distributed under the License is distributed on an "AS IS" BASIS,
0013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0014  * See the License for the specific language governing permissions and
0015  * limitations under the License.
0016  */
0017
0018 package org.apache.spark.network.server;
0019
0020 import io.netty.channel.Channel;
0021
0022 /**
0023  * A bootstrap which is executed on a TransportServer's client channel once a client connects
0024  * to the server. This allows customizing the client channel to allow for things such as SASL
0025  * authentication.
0026  */
0027 public interface TransportServerBootstrap {
0028   /**
0029    * Customizes the channel to include new features, if needed.
0030    *
0031    * @param channel The connected channel opened by the client.
0032    * @param rpcHandler The RPC handler for the server.
0033    * @return The RPC handler to use for the channel.
0034    */
0035   RpcHandler doBootstrap(Channel channel, RpcHandler rpcHandler);
0036 }