kv-3.5.2.src.oracle.kv.RequestLimitException Maven / Gradle / Ivy
Show all versions of oracle-nosql-client Show documentation
/*-
*
* This file is part of Oracle NoSQL Database
* Copyright (C) 2011, 2015 Oracle and/or its affiliates. All rights reserved.
*
* If you have received this file as part of Oracle NoSQL Database the
* following applies to the work as a whole:
*
* Oracle NoSQL Database server software is free software: you can
* redistribute it and/or modify it under the terms of the GNU Affero
* General Public License as published by the Free Software Foundation,
* version 3.
*
* Oracle NoSQL Database is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Affero General Public License for more details.
*
* If you have received this file as part of Oracle NoSQL Database Client or
* distributed separately the following applies:
*
* Oracle NoSQL Database client software is free software: you can
* redistribute it and/or modify it under the terms of the Apache License
* as published by the Apache Software Foundation, version 2.0.
*
* You should have received a copy of the GNU Affero General Public License
* and/or the Apache License in the LICENSE file along with Oracle NoSQL
* Database client or server distribution. If not, see
* .
*
* An active Oracle commercial licensing agreement for this product supersedes
* these licenses and in such case the license notices, but not the copyright
* notice, may be removed by you in connection with your distribution that is
* in accordance with the commercial licensing terms.
*
* For more information please contact:
*
* [email protected]
*
*/
package oracle.kv;
import oracle.kv.impl.topo.RepNodeId;
/**
* Thrown when a request cannot be processed because it would exceed the
* maximum number of active requests for a node as configured via
* {@link KVStoreConfig#setRequestLimit}.
*
* This exception may simply indicate that the request limits are too strict
* and need to be relaxed to more correctly reflect application behavior. It
* may also indicate that there is a network issue with the communications path
* to the node or that the node itself is having problems and needs attention.
* In most circumstances, the KVS request dispatcher itself will handle node
* failures automatically, so this exception should be pretty rare.
*
* When encountering this exception it's best for the application to abandon
* the request, and free up the thread, thus containing the failure and
* allowing for more graceful service degradation. Freeing up the thread makes
* it available for requests that can be processed by other healthy nodes.
*
* @see RequestLimitConfig
*/
public class RequestLimitException extends FaultException {
private static final long serialVersionUID = 1L;
/**
* For internal use only.
* @hidden
*/
private RequestLimitException(String msg, boolean isRemote) {
super(msg, isRemote);
}
/**
* For internal use only.
* @hidden
*/
public static RequestLimitException create(RequestLimitConfig config,
RepNodeId rnId,
int activeRequests,
int nodeRequests,
boolean isRemote) {
assert config != null;
String msg = "Node limit exceeded at:" + rnId +
" Active requests at node:" + nodeRequests +
" Total active requests:" + activeRequests +
" Request limit configuration:" + config.toString();
return new RequestLimitException(msg, isRemote);
}
}