processing/src/main/java/org/apache/druid/query/ResourceLimitExceededException.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.druid.query;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import org.apache.druid.java.util.common.StringUtils;

/**
 * Exception indicating that an operation failed because it exceeded some configured resource limit.
 *
 * This is a {@link BadQueryException} because it likely indicates a user's misbehavior when this exception is thrown.
 * The resource limitations set by Druid cluster operators are typically less flexible than the parameters of
 * a user query, so when a user query requires too many resources, the likely remedy is that the user query
 * should be modified to use fewer resources, or to reduce query volume.
 */
public class ResourceLimitExceededException extends BadQueryException
{
  public static final String ERROR_CODE = "Resource limit exceeded";

  public static ResourceLimitExceededException withMessage(String message, Object... arguments)
  {
    return new ResourceLimitExceededException(StringUtils.nonStrictFormat(message, arguments));
  }

  public ResourceLimitExceededException(String errorCode, String message, String errorClass, String host)
  {
    super(errorCode, message, errorClass, host);
  }

  public ResourceLimitExceededException(String message)
  {
    this(ERROR_CODE, message, ResourceLimitExceededException.class.getName());
  }

  @JsonCreator
  private ResourceLimitExceededException(
      @JsonProperty("error") String errorCode,
      @JsonProperty("errorMessage") String errorMessage,
      @JsonProperty("errorClass") String errorClass
  )
  {
    this(errorCode, errorMessage, errorClass, resolveHostname());
  }
}