com.opendxl.streaming.client.exception

Class ClientError

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.opendxl.streaming.client.exception.ClientError

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ConsumerError, PermanentError, TemporaryError

public abstract class ClientError
extends java.lang.Exception

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClientError(java.lang.String message, java.lang.Throwable cause)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApi() Gets the Channel method name in which the ConsumerError occurred.
abstract int	getStatusCode() Get the HTTP Status Code that caused the error.
void	setApi(java.lang.String api) Sets the Channel method name in which the ConsumerError occurred.

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

Constructor Detail

ClientError

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

Parameters:

message - error description

cause - if ClientError is thrown as consequence of another exception. If ClientError is not caused by another exception, then it set to null.

Method Detail

getApi

public java.lang.String getApi()

Gets the Channel method name in which the ConsumerError occurred.

Returns:

Channel API name, e.g.: create, subscribe, consume, commit, run

setApi

public void setApi(java.lang.String api)

Sets the Channel method name in which the ConsumerError occurred.

Parameters:

api - the Channel method name, e.g.: create, subscribe, consume, commit, run

getStatusCode

public abstract int getStatusCode()

Get the HTTP Status Code that caused the error.

Returns:

HTTP Status Code