/*
 * 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.zookeeper.server.quorum;

/**
 * Thrown when a {@link Leader} has too many concurrent syncs being sent
 * to observers.
 *
 * @see LearnerSyncThrottler
 *
 */
public class SyncThrottleException extends Exception {

    private static final long serialVersionUID = 1L;

    public SyncThrottleException(int concurrentSyncNumber, int throttleThreshold, LearnerSyncThrottler.SyncType syncType) {
        super(getMessage(concurrentSyncNumber, throttleThreshold, syncType));
    }

    private static String getMessage(int concurrentSyncNumber, int throttleThreshold, LearnerSyncThrottler.SyncType syncType) {
        return String.format("new %s sync would make %d concurrently in progress; maximum is %d",
                             syncType.toString().toLowerCase(),
                             concurrentSyncNumber,
                             throttleThreshold);
    }

}
