com.exalead.papi.helper

Class DocumentsPushAPIException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.exalead.papi.helper.PushAPIException

com.exalead.papi.helper.DocumentsPushAPIException

All Implemented Interfaces:

java.io.Serializable

public class DocumentsPushAPIException
extends PushAPIException

Base class for exceptions that can be thrown by push calls.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentsPushAPIException.Entry Simple implementation of a Map.Entry used for DocumentsPushAPIException.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Vector<DocumentsPushAPIException.Entry>	errors
protected boolean	serverSideError

Constructor Summary

Constructors

Constructor and Description
DocumentsPushAPIException(java.lang.String message) Constructor specifying the exception message.
DocumentsPushAPIException(java.lang.String message, java.lang.Throwable cause) Constructor specifying the exception message and the exception cause.
DocumentsPushAPIException(java.lang.Throwable cause) Constructor specifying the exception cause.

Method Summary

Modifier and Type	Method and Description
void	add(Document doc, java.lang.Exception exception) Add a new server-side error
void	add(Document doc, java.lang.Exception exception, boolean serverSideError) Add a new error
void	add(java.lang.String uri, java.lang.Exception exception, boolean serverSideError) Add a new error
java.util.Enumeration<DocumentsPushAPIException.Entry>	elements() Enumerate errors.
DocumentsPushAPIException.Entry	get(int i) Get the Nth error.
java.lang.String	getMessage()
java.lang.StackTraceElement[]	getStackTrace()
boolean	isServerSideError() Return true if the errors list contains one or more server-side error.
int	size() Return the number of errors

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

errors

protected java.util.Vector<DocumentsPushAPIException.Entry> errors

serverSideError

protected boolean serverSideError

Constructor Detail

DocumentsPushAPIException

public DocumentsPushAPIException(java.lang.String message)

Constructor specifying the exception message.

Parameters:

message - The exception message.

DocumentsPushAPIException

public DocumentsPushAPIException(java.lang.Throwable cause)

Constructor specifying the exception cause.

Parameters:

cause - The exception cause.

DocumentsPushAPIException

public DocumentsPushAPIException(java.lang.String message,
                                 java.lang.Throwable cause)

Constructor specifying the exception message and the exception cause.

Parameters:

message - The exception message.

e - The exception cause.

Method Detail

add

public void add(Document doc,
                java.lang.Exception exception,
                boolean serverSideError)

Add a new error

Parameters:

doc - The document which caused the error

exception - The thrown exception

serverSideError - If true, this was a server-side (fatal) error

add

public void add(Document doc,
                java.lang.Exception exception)

Add a new server-side error

Parameters:

doc - The document which caused the error

exception - The thrown exception

add

public void add(java.lang.String uri,
                java.lang.Exception exception,
                boolean serverSideError)

Add a new error

Parameters:

uri - The URI which caused the error

exception - The thrown exception

serverSideError - If true, this was a server-side (fatal) error

size

public int size()

Return the number of errors

get

public DocumentsPushAPIException.Entry get(int i)

Get the Nth error.

elements

public java.util.Enumeration<DocumentsPushAPIException.Entry> elements()

Enumerate errors.

isServerSideError

public boolean isServerSideError()

Return true if the errors list contains one or more server-side error. Return false if all errors are all client-side errors (ie. not server-side connectivity issues).

Returns:

true if all errors are all client-side errors.

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

getStackTrace

public java.lang.StackTraceElement[] getStackTrace()

Overrides:

getStackTrace in class java.lang.Throwable