io.aeron.archive.client

Class ArchiveException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.aeron.exceptions.AeronException

io.aeron.archive.client.ArchiveException

All Implemented Interfaces:

Serializable

public class ArchiveException
extends AeronException

Exception raised when communicating with the AeronArchive.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.aeron.exceptions.AeronException

AeronException.Category

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTIVE_LISTING An active listing of recordings is currently in operation on the session.
static int	ACTIVE_RECORDING The recording is currently active so the requested operation is not valid.
static int	ACTIVE_SUBSCRIPTION A subscription is currently active for the requested channel and stream id which would clash.
static int	AUTHENTICATION_REJECTED The archive is rejecting the session because of failed authentication.
static int	GENERIC Generic archive error with detail likely in the message.
static int	INVALID_EXTENSION The extend recording operation is not valid for the existing recording.
static int	MAX_RECORDINGS The archive has reached its maximum concurrent recording sessions.
static int	MAX_REPLAYS The archive has reached its maximum concurrent replay sessions.
static int	UNKNOWN_RECORDING The recording identity for the operation is not know to the archive.
static int	UNKNOWN_REPLAY The replay identity for the operation is not know to the archive.
static int	UNKNOWN_SUBSCRIPTION The subscription for the requested operation is not known to the archive.

Constructor Summary

Constructors

Constructor and Description
ArchiveException() Default ArchiveException exception of AeronException.Category.ERROR and errorCode() = GENERIC.
ArchiveException(String message) ArchiveException exception of AeronException.Category.ERROR and errorCode() = GENERIC, plus detail.
ArchiveException(String message, AeronException.Category category) ArchiveException exception errorCode() = GENERIC, plus detail and AeronException.Category.
ArchiveException(String message, int errorCode) ArchiveException exception of AeronException.Category.ERROR, plus detail and error code.
ArchiveException(String message, int errorCode, long correlationId) ArchiveException exception of AeronException.Category.ERROR, plus detail, error code, and correlation if of the control request.
ArchiveException(String message, int errorCode, long correlationId, AeronException.Category category) ArchiveException exception, plus detail, error code, correlation id of control request, and AeronException.Category.
ArchiveException(String message, long correlationId, AeronException.Category category) ArchiveException exception errorCode() = GENERIC, plus detail, correlation id of control request, and AeronException.Category.
ArchiveException(String message, Throwable cause, int errorCode) ArchiveException exception of AeronException.Category.ERROR, plus detail, cause, and error code.

Method Summary

Modifier and Type	Method and Description
long	correlationId() Optional correlation-id associated with a control protocol request.
int	errorCode() Error code providing more detail into what went wrong.

Methods inherited from class io.aeron.exceptions.AeronException

category

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

Field Detail

GENERIC

public static final int GENERIC

Generic archive error with detail likely in the message.

See Also:

Constant Field Values

ACTIVE_LISTING

public static final int ACTIVE_LISTING

An active listing of recordings is currently in operation on the session.

See Also:

Constant Field Values

ACTIVE_RECORDING

public static final int ACTIVE_RECORDING

The recording is currently active so the requested operation is not valid.

See Also:

Constant Field Values

ACTIVE_SUBSCRIPTION

public static final int ACTIVE_SUBSCRIPTION

A subscription is currently active for the requested channel and stream id which would clash.

See Also:

Constant Field Values

UNKNOWN_SUBSCRIPTION

public static final int UNKNOWN_SUBSCRIPTION

The subscription for the requested operation is not known to the archive.

See Also:

Constant Field Values

UNKNOWN_RECORDING

public static final int UNKNOWN_RECORDING

The recording identity for the operation is not know to the archive.

See Also:

Constant Field Values

UNKNOWN_REPLAY

public static final int UNKNOWN_REPLAY

The replay identity for the operation is not know to the archive.

See Also:

Constant Field Values

MAX_REPLAYS

public static final int MAX_REPLAYS

The archive has reached its maximum concurrent replay sessions.

See Also:

Constant Field Values

MAX_RECORDINGS

public static final int MAX_RECORDINGS

The archive has reached its maximum concurrent recording sessions.

See Also:

Constant Field Values

INVALID_EXTENSION

public static final int INVALID_EXTENSION

The extend recording operation is not valid for the existing recording.

See Also:

Constant Field Values

AUTHENTICATION_REJECTED

public static final int AUTHENTICATION_REJECTED

The archive is rejecting the session because of failed authentication.

See Also:

Constant Field Values

Constructor Detail

ArchiveException

public ArchiveException()

Default ArchiveException exception of AeronException.Category.ERROR and errorCode() = GENERIC.

ArchiveException

public ArchiveException(String message)

ArchiveException exception of AeronException.Category.ERROR and errorCode() = GENERIC, plus detail.

Parameters:

message - providing detail.

ArchiveException

public ArchiveException(String message,
                        int errorCode)

ArchiveException exception of AeronException.Category.ERROR, plus detail and error code.

Parameters:

message - providing detail.

errorCode - for type.

ArchiveException

public ArchiveException(String message,
                        Throwable cause,
                        int errorCode)

ArchiveException exception of AeronException.Category.ERROR, plus detail, cause, and error code.

Parameters:

message - providing detail.

cause - of the error.

errorCode - for type.

ArchiveException

public ArchiveException(String message,
                        int errorCode,
                        long correlationId)

ArchiveException exception of AeronException.Category.ERROR, plus detail, error code, and correlation if of the control request.

Parameters:

message - providing detail.

errorCode - for type.

correlationId - of the control request.

ArchiveException

public ArchiveException(String message,
                        AeronException.Category category)

ArchiveException exception errorCode() = GENERIC, plus detail and AeronException.Category.

Parameters:

message - providing detail.

category - for type.

ArchiveException

public ArchiveException(String message,
                        long correlationId,
                        AeronException.Category category)

ArchiveException exception errorCode() = GENERIC, plus detail, correlation id of control request, and AeronException.Category.

Parameters:

message - providing detail.

correlationId - of the control request.

category - for type.

ArchiveException

public ArchiveException(String message,
                        int errorCode,
                        long correlationId,
                        AeronException.Category category)

ArchiveException exception, plus detail, error code, correlation id of control request, and AeronException.Category.

Parameters:

message - providing detail.

errorCode - for type.

correlationId - of the control request.

category - for type.

Method Detail

errorCode

public int errorCode()

Error code providing more detail into what went wrong.

Returns:

code providing more detail into what went wrong.

correlationId

public long correlationId()

Optional correlation-id associated with a control protocol request. Will be Aeron.NULL_VALUE if not set.

Returns:

correlation-id associated with a control protocol request.