Package org.apache.pulsar.client.api

Class PulsarClientException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

org.apache.pulsar.client.api.PulsarClientException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

PulsarClientException.AlreadyClosedException, PulsarClientException.AuthenticationException, PulsarClientException.AuthorizationException, PulsarClientException.BrokerMetadataException, PulsarClientException.BrokerPersistenceException, PulsarClientException.ChecksumException, PulsarClientException.ConnectException, PulsarClientException.ConsumerAssignException, PulsarClientException.ConsumerBusyException, PulsarClientException.CryptoException, PulsarClientException.GettingAuthenticationDataException, PulsarClientException.IncompatibleSchemaException, PulsarClientException.InvalidConfigurationException, PulsarClientException.InvalidMessageException, PulsarClientException.InvalidServiceURL, PulsarClientException.InvalidTopicNameException, PulsarClientException.LookupException, PulsarClientException.MemoryBufferIsFullError, PulsarClientException.MessageAcknowledgeException, PulsarClientException.NotAllowedException, PulsarClientException.NotConnectedException, PulsarClientException.NotFoundException, PulsarClientException.NotSupportedException, PulsarClientException.ProducerBlockedQuotaExceededError, PulsarClientException.ProducerBlockedQuotaExceededException, PulsarClientException.ProducerBusyException, PulsarClientException.ProducerFencedException, PulsarClientException.ProducerQueueIsFullError, PulsarClientException.TimeoutException, PulsarClientException.TopicDoesNotExistException, PulsarClientException.TopicTerminatedException, PulsarClientException.TransactionConflictException, PulsarClientException.UnsupportedAuthenticationException

@Public
@Stable
public class PulsarClientException
extends java.io.IOException

Base type of exception thrown by Pulsar client.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PulsarClientException.AlreadyClosedException	Already closed exception thrown by Pulsar client.
static class	PulsarClientException.AuthenticationException	Authentication exception thrown by Pulsar client.
static class	PulsarClientException.AuthorizationException	Authorization exception thrown by Pulsar client.
static class	PulsarClientException.BrokerMetadataException	Broker metadata exception thrown by Pulsar client.
static class	PulsarClientException.BrokerPersistenceException	Broker persistence exception thrown by Pulsar client.
static class	PulsarClientException.ChecksumException	Checksum exception thrown by Pulsar client.
static class	PulsarClientException.ConnectException	Connect exception thrown by Pulsar client.
static class	PulsarClientException.ConsumerAssignException	Consumer assign exception thrown by Pulsar client.
static class	PulsarClientException.ConsumerBusyException	Consumer busy exception thrown by Pulsar client.
static class	PulsarClientException.CryptoException	Crypto exception thrown by Pulsar client.
static class	PulsarClientException.GettingAuthenticationDataException	Getting authentication data exception thrown by Pulsar client.
static class	PulsarClientException.IncompatibleSchemaException	Incompatible schema exception thrown by Pulsar client.
static class	PulsarClientException.InvalidConfigurationException	Invalid Configuration exception thrown by Pulsar client.
static class	PulsarClientException.InvalidMessageException	Invalid message exception thrown by Pulsar client.
static class	PulsarClientException.InvalidServiceURL	Invalid Service URL exception thrown by Pulsar client.
static class	PulsarClientException.InvalidTopicNameException	Invalid topic name exception thrown by Pulsar client.
static class	PulsarClientException.LookupException	Lookup exception thrown by Pulsar client.
static class	PulsarClientException.MemoryBufferIsFullError	Memory buffer full error thrown by Pulsar client.
static class	PulsarClientException.MessageAcknowledgeException	Consumer assign exception thrown by Pulsar client.
static class	PulsarClientException.NotAllowedException	Not allowed exception thrown by Pulsar client.
static class	PulsarClientException.NotConnectedException	Not connected exception thrown by Pulsar client.
static class	PulsarClientException.NotFoundException	Not Found exception thrown by Pulsar client.
static class	PulsarClientException.NotSupportedException	Not supported exception thrown by Pulsar client.
static class	PulsarClientException.ProducerBlockedQuotaExceededError	Producer blocked quota exceeded error thrown by Pulsar client.
static class	PulsarClientException.ProducerBlockedQuotaExceededException	Producer blocked quota exceeded exception thrown by Pulsar client.
static class	PulsarClientException.ProducerBusyException	Producer busy exception thrown by Pulsar client.
static class	PulsarClientException.ProducerFencedException	Producer fenced exception thrown by Pulsar client.
static class	PulsarClientException.ProducerQueueIsFullError	Full producer queue error thrown by Pulsar client.
static class	PulsarClientException.TimeoutException	Timeout exception thrown by Pulsar client.
static class	PulsarClientException.TooManyRequestsException	Too many requests exception thrown by Pulsar client.
static class	PulsarClientException.TopicDoesNotExistException	Topic does not exist and cannot be created.
static class	PulsarClientException.TopicTerminatedException	Topic terminated exception thrown by Pulsar client.
static class	PulsarClientException.TransactionConflictException	Consumer assign exception thrown by Pulsar client.
static class	PulsarClientException.UnsupportedAuthenticationException	Unsupported authentication exception thrown by Pulsar client.

Constructor Summary

Constructors

Constructor	Description
PulsarClientException(java.lang.String msg)	Constructs an PulsarClientException with the specified detail message.
PulsarClientException(java.lang.String msg, long sequenceId)	Constructs an PulsarClientException with the specified detail message.
PulsarClientException(java.lang.String msg, java.lang.Throwable t)	Constructs an PulsarClientException with the specified cause.
PulsarClientException(java.lang.Throwable t)	Constructs an PulsarClientException with the specified cause.
PulsarClientException(java.lang.Throwable t, long sequenceId)	Constructs an PulsarClientException with the specified cause.

Method Summary

Modifier and Type	Method	Description
java.util.Collection<java.lang.Throwable>	getPreviousExceptions()	Get the collection of previous exceptions which have caused retries for this operation.
static java.util.Collection<java.lang.Throwable>	getPreviousExceptions(java.lang.Throwable t)
long	getSequenceId()
static boolean	isRetriableError(java.lang.Throwable t)
static void	setPreviousExceptions(java.lang.Throwable t, java.util.Collection<java.lang.Throwable> previous)
void	setPreviousExceptions(java.util.Collection<java.lang.Throwable> previous)	Add a list of previous exception which occurred for the same operation and have been retried.
void	setSequenceId(long sequenceId)
java.lang.String	toString()
static PulsarClientException	unwrap(java.lang.Throwable t)
static java.lang.Throwable	wrap(java.lang.Throwable t, java.lang.String msg)

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PulsarClientException

public PulsarClientException(java.lang.String msg)

Constructs an PulsarClientException with the specified detail message.

Parameters:

msg - The detail message (which is saved for later retrieval by the Throwable.getMessage() method)

PulsarClientException

public PulsarClientException(java.lang.String msg,
                             long sequenceId)

Constructs an PulsarClientException with the specified detail message.

Parameters:

msg - The detail message (which is saved for later retrieval by the Throwable.getMessage() method)

sequenceId - The sequenceId of the message

PulsarClientException

public PulsarClientException(java.lang.Throwable t)

Constructs an PulsarClientException with the specified cause.

Parameters:

t - The cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

PulsarClientException

public PulsarClientException(java.lang.String msg,
                             java.lang.Throwable t)

Constructs an PulsarClientException with the specified cause.

Parameters:

msg - The detail message (which is saved for later retrieval by the Throwable.getMessage() method)

t - The cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

PulsarClientException

public PulsarClientException(java.lang.Throwable t,
                             long sequenceId)

Constructs an PulsarClientException with the specified cause.

Parameters:

t - The cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

sequenceId - The sequenceId of the message

Method Detail

setPreviousExceptions

public void setPreviousExceptions(java.util.Collection<java.lang.Throwable> previous)

Add a list of previous exception which occurred for the same operation and have been retried.

Parameters:

previous - A collection of throwables that triggered retries

getPreviousExceptions

public java.util.Collection<java.lang.Throwable> getPreviousExceptions()

Get the collection of previous exceptions which have caused retries for this operation.

Returns:

a collection of exception, ordered as they occurred

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Throwable

wrap

public static java.lang.Throwable wrap(java.lang.Throwable t,
                                       java.lang.String msg)

unwrap

public static PulsarClientException unwrap(java.lang.Throwable t)

getPreviousExceptions

public static java.util.Collection<java.lang.Throwable> getPreviousExceptions(java.lang.Throwable t)

setPreviousExceptions

public static void setPreviousExceptions(java.lang.Throwable t,
                                         java.util.Collection<java.lang.Throwable> previous)

getSequenceId

public long getSequenceId()

setSequenceId

public void setSequenceId(long sequenceId)

isRetriableError

public static boolean isRetriableError(java.lang.Throwable t)