org.apache.jackrabbit.oak.api

Class CommitFailedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.apache.jackrabbit.oak.api.CommitFailedException

All Implemented Interfaces:

java.io.Serializable

public class CommitFailedException
extends java.lang.Exception

Main exception thrown by methods defined on the ContentSession interface indicating that committing a given set of changes failed.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACCESS Type name for access violation (i.e.
static java.lang.String	ACCESS_CONTROL Type name for access control violation errors.
static java.lang.String	CONSTRAINT Type name for constraint violation errors.
static java.lang.String	INTEGRITY Type name for referential integrity violation errors.
static java.lang.String	LABEL_EXISTS Type name for label exists version errors.
static java.lang.String	LOCK Type name for lock violation errors.
static java.lang.String	MERGE Type name for merge errors.
static java.lang.String	NAME Type name for name violation errors.
static java.lang.String	NAMESPACE Type name for namespace violation errors.
static java.lang.String	NODE_TYPE Type name for node type violation errors.
static java.lang.String	OAK Source name for exceptions thrown by components in the Oak project.
static java.lang.String	STATE Type name for state violation errors.
static java.lang.String	UNSUPPORTED Unsupported operation or feature
static java.lang.String	VERSION Type name for version violation errors.

Constructor Summary

Constructors

Constructor and Description
CommitFailedException(java.lang.String type, int code, java.lang.String message)
CommitFailedException(java.lang.String type, int code, java.lang.String message, java.lang.Throwable cause)
CommitFailedException(java.lang.String source, java.lang.String type, int code, java.lang.String message, java.lang.Throwable cause)

Method Summary

Modifier and Type	Method and Description
RepositoryException	asRepositoryException() Wraps the given CommitFailedException instance using the appropriate RepositoryException subclass based on the type of the given exception.
RepositoryException	asRepositoryException(@NotNull java.lang.String message) Wraps the given CommitFailedException instance using the appropriate RepositoryException subclass based on the type of the given exception.
int	getCode() Returns the type-specific error code of this exception.
java.lang.String	getSource() Returns the name of the source of this exception.
java.lang.String	getType() Return the name of the type of this exception.
boolean	isAccessControlViolation() Checks whether this is an access control violation exception.
boolean	isAccessViolation() Checks whether this is an access violation exception.
boolean	isConstraintViolation() Checks whether this is a constraint violation exception.
boolean	isOfType(java.lang.String type) Checks whether this exception is of the given type.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

OAK

public static final java.lang.String OAK

Source name for exceptions thrown by components in the Oak project.

See Also:

Constant Field Values

ACCESS

public static final java.lang.String ACCESS

Type name for access violation (i.e. permission denied) errors.

See Also:

Constant Field Values

ACCESS_CONTROL

public static final java.lang.String ACCESS_CONTROL

Type name for access control violation errors.

See Also:

Constant Field Values

CONSTRAINT

public static final java.lang.String CONSTRAINT

Type name for constraint violation errors.

See Also:

Constant Field Values

INTEGRITY

public static final java.lang.String INTEGRITY

Type name for referential integrity violation errors.

See Also:

Constant Field Values

LOCK

public static final java.lang.String LOCK

Type name for lock violation errors.

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

Type name for name violation errors.

See Also:

Constant Field Values

NAMESPACE

public static final java.lang.String NAMESPACE

Type name for namespace violation errors.

See Also:

Constant Field Values

NODE_TYPE

public static final java.lang.String NODE_TYPE

Type name for node type violation errors.

See Also:

Constant Field Values

STATE

public static final java.lang.String STATE

Type name for state violation errors.

See Also:

Constant Field Values

VERSION

public static final java.lang.String VERSION

Type name for version violation errors.

See Also:

Constant Field Values

LABEL_EXISTS

public static final java.lang.String LABEL_EXISTS

Type name for label exists version errors.

See Also:

Constant Field Values

MERGE

public static final java.lang.String MERGE

Type name for merge errors.

See Also:

Constant Field Values

UNSUPPORTED

public static final java.lang.String UNSUPPORTED

Unsupported operation or feature

See Also:

Constant Field Values

Constructor Detail

CommitFailedException

public CommitFailedException(java.lang.String source,
                             java.lang.String type,
                             int code,
                             java.lang.String message,
                             java.lang.Throwable cause)

CommitFailedException

public CommitFailedException(java.lang.String type,
                             int code,
                             java.lang.String message,
                             java.lang.Throwable cause)

CommitFailedException

public CommitFailedException(java.lang.String type,
                             int code,
                             java.lang.String message)

Method Detail

isOfType

public boolean isOfType(java.lang.String type)

Checks whether this exception is of the given type.

Parameters:

type - type name

Returns:

true iff this exception is of the given type

isAccessViolation

public boolean isAccessViolation()

Checks whether this is an access violation exception.

Returns:

true iff this is an access violation exception

isAccessControlViolation

public boolean isAccessControlViolation()

Checks whether this is an access control violation exception.

Returns:

true iff this is an access control violation exception

isConstraintViolation

public boolean isConstraintViolation()

Checks whether this is a constraint violation exception.

Returns:

true iff this is a constraint violation exception

getSource

public java.lang.String getSource()

Returns the name of the source of this exception.

Returns:

source name

getType

public java.lang.String getType()

Return the name of the type of this exception.

Returns:

type name

getCode

public int getCode()

Returns the type-specific error code of this exception.

Returns:

error code

asRepositoryException

public RepositoryException asRepositoryException()

Wraps the given CommitFailedException instance using the appropriate RepositoryException subclass based on the type of the given exception.

Returns:

matching repository exception

asRepositoryException

public RepositoryException asRepositoryException(@NotNull
                                                 @NotNull java.lang.String message)

Wraps the given CommitFailedException instance using the appropriate RepositoryException subclass based on the type of the given exception.

Parameters:

message - The exception message.

Returns:

matching repository exception