Package com.azure.core.amqp.exception

Class LinkErrorContext

java.lang.Object

com.azure.core.amqp.exception.AmqpErrorContext

com.azure.core.amqp.exception.SessionErrorContext

com.azure.core.amqp.exception.LinkErrorContext

All Implemented Interfaces:

Serializable

public class LinkErrorContext
extends SessionErrorContext

Represents the context for an AMQP link when an AmqpException occurs.

See Also:

AmqpException, AmqpErrorContext, Serialized Form

Constructor Summary

Constructors

Constructor	Description
LinkErrorContext(String namespace, String entityPath, String trackingId, Integer linkCredit)	Creates a new instance with the AMQP link's namespace and entityPath information.

Method Summary

Modifier and Type	Method	Description
Integer	getLinkCredit()	Gets the number of credits on the link when the error occurred.
String	getTrackingId()	Gets the unique tracking identifier for this error.
String	toString()	Creates a string representation of this ErrorContext.

Methods inherited from class com.azure.core.amqp.exception.SessionErrorContext

getEntityPath

Methods inherited from class com.azure.core.amqp.exception.AmqpErrorContext

getErrorInfo, getNamespace

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkErrorContext

public LinkErrorContext(String namespace,
                        String entityPath,
                        String trackingId,
                        Integer linkCredit)

Creates a new instance with the AMQP link's namespace and entityPath information. Allows for optional information about the link if it was successfully opened such as linkCredit and trackingId.

Parameters:

namespace - The service namespace of the error context.

entityPath - The remote container the AMQP receive link is fetching messages from.

trackingId - The tracking id for the error. Tracking id can be null if the error was not thrown from the remote AMQP message broker.

linkCredit - the number of link credits the current AMQP link has when this error occurred, can be null if the receive link has not opened yet.

Throws:

IllegalArgumentException - if namespace or entityPath is null or empty.

Method Detail

getTrackingId

public String getTrackingId()

Gets the unique tracking identifier for this error. It is possible to be null if the error was not thrown from the AMQP message broker.

Returns:

The unique tracking identifier for this error.

getLinkCredit

public Integer getLinkCredit()

Gets the number of credits on the link when the error occurred. Can be null if the link is not opened.

Returns:

The number of credits on the link when the error occurred.

toString

public String toString()

Creates a string representation of this ErrorContext.

Overrides:

toString in class SessionErrorContext

Returns:

A string representation of this ErrorContext.