dubbo-metadata/dubbo-metadata-report-failover/src/main/java/org/apache/dubbo/metadata/store/failover/FailoverCondition.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.dubbo.metadata.store.failover;

import org.apache.dubbo.common.URL;
import org.apache.dubbo.common.extension.SPI;

@SPI("failover")
public interface FailoverCondition {

    /**
     * Whether metadata should be reported.
     *
     * @param url registry url, eg: zookeeper://127.0.0.1:2181
     * @return true store metadata to the specified URL.
     */
    boolean shouldRegister(URL url);

    /**
     * Whether metadata should be read from specified url.
     *
     * @param url registry url, eg: zookeeper://127.0.0.1:2181
     * @return true read metadata from specified URL.
     */
    boolean shouldQuery(URL url);

    /**
     * Judge whether it is a local region or a local datacenter.
     * <p>
     * Allows the local region or datacenter to be read first.
     *
     * @param url
     * @return
     */
    boolean isLocalDataCenter(URL url);

}