org.apache.flink.runtime.highavailability.ClientHighAvailabilityServicesFactory Maven / Gradle / Ivy

Go to download
/*
 * 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.flink.runtime.highavailability;

import org.apache.flink.configuration.Configuration;
import org.apache.flink.runtime.rpc.FatalErrorHandler;

/** Factory interface for {@link ClientHighAvailabilityServices}. */
public interface ClientHighAvailabilityServicesFactory {

    /**
     * Creates a {@link ClientHighAvailabilityServices} instance.
     *
     * @param configuration Flink configuration
     * @param fatalErrorHandler {@link FatalErrorHandler} fatalErrorHandler to handle unexpected
     *     errors
     * @return instance of {@link ClientHighAvailabilityServices}
     * @throws Exception when HA services can not be created.
     */
    ClientHighAvailabilityServices create(
            Configuration configuration, FatalErrorHandler fatalErrorHandler) throws Exception;
}