elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/base/ElectionCandidate.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.shardingsphere.elasticjob.cloud.reg.base;

/**
 * Election candidate.
 *
 * <p>
 *     Guarantee {@link #startLeadership()} and {@link #stopLeadership()} method run in same thread.
 * </p>
 */
public interface ElectionCandidate {

    /**
     * Start leadership.
     *
     * @throws Exception exception
     */
    void startLeadership() throws Exception;

    /**
     * Stop leadership.
     *
     * <p>Should not throw any exception for the implementation class.</p>
     */
    void stopLeadership();
}