network/client/TransportClientBootstrap.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.client;
0019
0020 import io.netty.channel.Channel;
0021
0022 /**
0023  * A bootstrap which is executed on a TransportClient before it is returned to the user.
0024  * This enables an initial exchange of information (e.g., SASL authentication tokens) on a once-per-
0025  * connection basis.
0026  *
0027  * Since connections (and TransportClients) are reused as much as possible, it is generally
0028  * reasonable to perform an expensive bootstrapping operation, as they often share a lifespan with
0029  * the JVM itself.
0030  */
0031 public interface TransportClientBootstrap {
0032   /** Performs the bootstrapping operation, throwing an exception on failure. */
0033   void doBootstrap(TransportClient client, Channel channel) throws RuntimeException;
0034 }