package com.trendmicro.grid.acl.l0;
   
   import org.slf4j.Logger;
   import org.slf4j.LoggerFactory;
   
   import javax.xml.bind.annotation.*;
   import javax.xml.ws.WebFault;
   
   /**
   * Defines a SOAP fault that is sent as reply for "batch" enabled service methods when the batch size inside the
   * request exceeds the configured limit.
   * <p/>
   * The exception contains the acceptable batch size as {@link #getAllowedBatchSize()} allowing clients to adaptively
   * choose the right batch size and retry a request that failed on this SOAP fault.
   *
   * @author Juergen_Kellerer, 2010-04-26
   */
  @XmlAccessorType(XmlAccessType.FIELD)
  @XmlType(namespace = Level0Constants.NAMESPACE)
  @WebFault(targetNamespace = Level0Constants.NAMESPACE)
  public class BatchSizeExceededException extends RuntimeException {
  
  	private static final long serialVersionUID = -5854824433574110209L;
  
  	private static final Logger log = LoggerFactory.getLogger(BatchSizeExceededException.class);
  	private static final String DEFAULT_MESSAGE = "This request exceeded the allowed batch size. " +
  			"Please retry in batches that fit into the allowed batch size.";
  
  	@XmlAttribute
  	private int allowedBatchSize;
  
  	@XmlElement
  	private String message = DEFAULT_MESSAGE;
  
  	public BatchSizeExceededException(int allowedBatchSize) {
  		super(DEFAULT_MESSAGE);
  		this.allowedBatchSize = allowedBatchSize;
  
  		if (log.isTraceEnabled()) {
  			log.trace("About to throw BatchSizeExceededException, AllowedBatchSize: {}, Message: {}", allowedBatchSize, message);
  		}
  	}
  
  	public int getAllowedBatchSize() {
  		return allowedBatchSize;
  	}
  }