api/plugin/SparkPlugin.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.api.plugin;
0019
0020 import org.apache.spark.annotation.DeveloperApi;
0021
0022 /**
0023  * :: DeveloperApi ::
0024  * A plugin that can be dynamically loaded into a Spark application.
0025  * <p>
0026  * Plugins can be loaded by adding the plugin's class name to the appropriate Spark configuration.
0027  * Check the Spark monitoring guide for details.
0028  * <p>
0029  * Plugins have two optional components: a driver-side component, of which a single instance is
0030  * created per application, inside the Spark driver. And an executor-side component, of which one
0031  * instance is created in each executor that is started by Spark. Details of each component can be
0032  * found in the documentation for {@link DriverPlugin} and {@link ExecutorPlugin}.
0033  *
0034  * @since 3.0.0
0035  */
0036 @DeveloperApi
0037 public interface SparkPlugin {
0038
0039   /**
0040    * Return the plugin's driver-side component.
0041    *
0042    * @return The driver-side component, or null if one is not needed.
0043    */
0044   DriverPlugin driverPlugin();
0045
0046   /**
0047    * Return the plugin's executor-side component.
0048    *
0049    * @return The executor-side component, or null if one is not needed.
0050    */
0051   ExecutorPlugin executorPlugin();
0052
0053 }