kv-3.5.2.src.oracle.kv.ConsistencyException 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;
/**
* Thrown when a single or multiple-operation transaction fails because the
* specified {@link Consistency} could not be met, within the allowed timeout
* period.
*
* The likelihood of this exception being thrown depends on the specified
* {@code Consistency} and the general health of the KVStore system. The
* default consistency policy (specified by {@link
* KVStoreConfig#getConsistency}) is {@link Consistency#NONE_REQUIRED}. With
* {@link Consistency#NONE_REQUIRED} (the default), {@link
* Consistency#NONE_REQUIRED_NO_MASTER}, or {@link Consistency#ABSOLUTE}, this
* exception will never be thrown.
*
* If the client overrides the default and specifies a {@link
* Consistency.Time} or {@link Consistency.Version} setting, then this
* exception will be thrown when the specified consistency requirement cannot
* be satisfied within the timeout period associated with the consistency
* setting. If this exception is encountered frequently, it indicates that the
* consistency policy requirements are too strict and cannot be met routinely
* given the load being placed on the system and the hardware resources that
* are available to service the load.
*
* Depending on the nature of the application, when this exception is thrown
* the client may wish to
*
* - retry the read operation,
* - fall back to using a larger timeout or a less restrictive consistency
* setting (for example, {@link Consistency#NONE_REQUIRED}), and resume using
* the original consistency setting at a later time, or
* - give up and report an error at a higher level.
*
*
*/
public class ConsistencyException extends FaultException {
private static final long serialVersionUID = 1L;
private final Consistency consistency;
/**
* For internal use only.
* @hidden
*/
public ConsistencyException(Throwable cause, Consistency consistency) {
super(cause, true /*isRemote*/);
this.consistency = consistency;
}
/**
* Returns the consistency policy that could not be satisfied.
*/
public Consistency getConsistency() {
return consistency;
}
}