kv-3.5.2.src.oracle.kv.lob.PartialLOBException 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.lob;
import oracle.kv.FaultException;
import oracle.kv.impl.util.ObjectUtil;
import oracle.kv.lob.KVLargeObject.LOBState;
/**
* Thrown when {@link KVLargeObject#getLOB} is invoked on a partial LOB. A
* partial LOB is typically the result of an incomplete deleteLOB
* or putLOB operation.
*
*
* The application can handle this exception and resume the incomplete
* operation. For example, it can invoke deleteLOB, to delete a
* LOB in the {@link LOBState#PARTIAL_DELETE} state or it can resume the failed
* putLOB operation for a LOB in the {@link LOBState#PARTIAL_PUT} state.
*
* @see KVLargeObject
*
* @since 2.0
*/
public class PartialLOBException extends FaultException {
private static final long serialVersionUID = 1L;
private final LOBState partialState;
/**
* @hidden
*/
public PartialLOBException(String msg,
LOBState partialState,
boolean isRemote) {
super(msg, isRemote);
ObjectUtil.checkNull("partialState", partialState);
if (partialState == LOBState.COMPLETE) {
final String emsg = "The value of partialState must denote a " +
"partial state not " + partialState;
throw new IllegalArgumentException(emsg);
}
this.partialState = partialState;
}
/**
* Returns the state associated with the LOB. The state returned is one of
* the partial states: {@link LOBState#PARTIAL_PUT},
* {@link LOBState#PARTIAL_DELETE} or
* {@link LOBState#PARTIAL_APPEND}.
*
* @since 2.1.55
*/
public LOBState getPartialState() {
return partialState;
}
/**
* Returns true only if the exception resulted from a partially deleted LOB.
*
* @deprecated Use the getPartialStateMethod() instead
*/
@Deprecated
public boolean isPartiallyDeleted() {
return LOBState.PARTIAL_DELETE == partialState;
}
}