org.apache.chemistry.opencmis.commons.exceptions

Class CmisBaseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apache.chemistry.opencmis.commons.exceptions.CmisBaseException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CmisConnectionException, CmisConstraintException, CmisContentAlreadyExistsException, CmisFilterNotValidException, CmisInvalidArgumentException, CmisNameConstraintViolationException, CmisNotSupportedException, CmisObjectNotFoundException, CmisPermissionDeniedException, CmisRuntimeException, CmisStorageException, CmisStreamNotSupportedException, CmisUpdateConflictException, CmisVersioningException

public abstract class CmisBaseException
extends RuntimeException

Base exception class for all CMIS exceptions.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CmisBaseException() Default constructor.
protected	CmisBaseException(String message) Constructor.
protected	CmisBaseException(String message, BigInteger code) Constructor.
protected	CmisBaseException(String message, BigInteger code, String errorContent) Constructor.
protected	CmisBaseException(String message, BigInteger code, String errorContent, Map<String,String> additionalData) Constructor.
protected	CmisBaseException(String message, BigInteger code, Throwable cause) Constructor.
protected	CmisBaseException(String message, String errorContent) Constructor.
protected	CmisBaseException(String message, String errorContent, Map<String,String> additionalData, Throwable cause) Constructor.
protected	CmisBaseException(String message, String errorContent, Throwable cause) Constructor.
protected	CmisBaseException(String message, Throwable cause) Constructor.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getAdditionalData() Returns additional data, if available.
String	getAdditionalData(String key) Returns additional data, if available.
BigInteger	getCode() Returns the error code sent by the CMIS repository (Web Services binding only).
String	getErrorContent() Returns the content of the error page sent by the web server.
abstract String	getExceptionName() Returns the name of the exception as defined in the CMIS specification.
void	setAdditionalData(Map<String,String> data) Sets additional data.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CmisBaseException

protected CmisBaseException()

Default constructor.

CmisBaseException

protected CmisBaseException(String message,
                            BigInteger code,
                            Throwable cause)

Constructor.

Parameters:

message - error message

code - error code

cause - the cause

CmisBaseException

protected CmisBaseException(String message,
                            String errorContent,
                            Map<String,String> additionalData,
                            Throwable cause)

Constructor.

Parameters:

message - error message

errorContent - error page content

additionalData - additional data

cause - the cause

CmisBaseException

protected CmisBaseException(String message,
                            String errorContent,
                            Throwable cause)

Constructor.

Parameters:

message - error message

errorContent - error page content

cause - the cause

CmisBaseException

protected CmisBaseException(String message,
                            BigInteger code)

Constructor.

Parameters:

message - error message

code - error code

CmisBaseException

protected CmisBaseException(String message,
                            BigInteger code,
                            String errorContent)

Constructor.

Parameters:

message - error message

code - error code

errorContent - error page content

CmisBaseException

protected CmisBaseException(String message,
                            BigInteger code,
                            String errorContent,
                            Map<String,String> additionalData)

Constructor.

Parameters:

message - error message

code - error code

errorContent - error page content

additionalData - additional data

CmisBaseException

protected CmisBaseException(String message,
                            String errorContent)

Constructor.

Parameters:

message - error message

errorContent - error page content

CmisBaseException

protected CmisBaseException(String message,
                            Throwable cause)

Constructor.

Parameters:

message - error message

cause - the cause

CmisBaseException

protected CmisBaseException(String message)

Constructor.

Parameters:

message - error message

Method Detail

getCode

public BigInteger getCode()

Returns the error code sent by the CMIS repository (Web Services binding only).

Returns:

error code or null if the CMIS repository didn't send an error code or the binding doesn't support error codes.

getErrorContent

public String getErrorContent()

Returns the content of the error page sent by the web server.

Returns:

the content of the error page or null if the server didn't send text content.

getAdditionalData

public Map<String,String> getAdditionalData()

Returns additional data, if available.

Returns:

additional data, can be null

getAdditionalData

public String getAdditionalData(String key)

Returns additional data, if available.

Parameters:

key - the data key

Returns:

additional data, can be null

setAdditionalData

public void setAdditionalData(Map<String,String> data)

Sets additional data.

Parameters:

data - the data

getExceptionName

public abstract String getExceptionName()

Returns the name of the exception as defined in the CMIS specification.

Returns:

the exception name