com.attivio.sdk

Class AttivioException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.attivio.sdk.AttivioException

All Implemented Interfaces:

AttivioThrowable, Serializable

@WebFault
public class AttivioException
extends Exception
implements AttivioThrowable

The base class for general Attivio generated exceptions.

Contains the underlying ErrorCode that may explain the cause of the exception.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AttivioException()
	AttivioException(ErrorCode code, String message, Object... params) Constructs an AttivioException with the error code.
	AttivioException(ErrorCode code, Throwable cause, String message, Object... params) Constructs an AttivioException with the error code.
	AttivioException(String context, ErrorCode code, Throwable cause, String message, Object... params) Constructs an AttivioException with the error code.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
static String	formatLogMessage(String msg, Object... params) Safely formats a log message handling null input as well as returning a warning message if message formatting failed.
ErrorCode	getErrorCode() Get the ErrorCode for this exception.
String	getErrorContext() Get the context for this error.
String	getMessage()
String	getOriginalMessage() Get the original message without ErrorCode.
int	hashCode()
AttivioException	toRemoteException() Convert this exception to be a remote exception.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.attivio.sdk.AttivioThrowable

getCause, getStackTrace

Constructor Detail

AttivioException

protected AttivioException()

AttivioException

public AttivioException(ErrorCode code,
                        String message,
                        Object... params)

Constructs an AttivioException with the error code. Note: parameters are used as an argument to a String format on the message argument.

Parameters:

code - the error code

message - the error message

params - any error message parameters

AttivioException

public AttivioException(ErrorCode code,
                        Throwable cause,
                        String message,
                        Object... params)

Constructs an AttivioException with the error code. Note: parameters are used as an argument to a String format on the message argument.

Parameters:

code - the error code

cause - the error cause

message - the error message

params - any error message parameters

AttivioException

public AttivioException(String context,
                        ErrorCode code,
                        Throwable cause,
                        String message,
                        Object... params)

Constructs an AttivioException with the error code. Note: parameters are used as an argument to a String format on the message argument.

Parameters:

code - the error code

context - the context for this error (field name, docid, etc)

cause - the error cause

message - the error message

params - any error message parameters

Method Detail

getErrorCode

public ErrorCode getErrorCode()

Get the ErrorCode for this exception.

Specified by:

getErrorCode in interface AttivioThrowable

getErrorContext

public String getErrorContext()

Get the context for this error.

This context is specific to the error code and will typically consist of things such as field names, document ids, etc.

Specified by:

getErrorContext in interface AttivioThrowable

getOriginalMessage

public String getOriginalMessage()

Get the original message without ErrorCode.

Specified by:

getOriginalMessage in interface AttivioThrowable

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

toRemoteException

public AttivioException toRemoteException()

Convert this exception to be a remote exception.

This converts this exception to a representation that a client can receive.

Specified by:

toRemoteException in interface AttivioThrowable

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

formatLogMessage

public static final String formatLogMessage(String msg,
                                            Object... params)

Safely formats a log message handling null input as well as returning a warning message if message formatting failed.