org.opendaylight.controller.cluster.access.concepts

Class RequestFailure<T extends org.opendaylight.yangtools.concepts.WritableIdentifier,C extends RequestFailure<T,C>>

java.lang.Object

org.opendaylight.controller.cluster.access.concepts.Message<T,C>

org.opendaylight.controller.cluster.access.concepts.Response<T,C>

org.opendaylight.controller.cluster.access.concepts.RequestFailure<T,C>

Type Parameters:

T - Target identifier type

C - Message class

All Implemented Interfaces:

Serializable, org.opendaylight.yangtools.concepts.Immutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Immutable>

Direct Known Subclasses:

ConnectClientFailure, LocalHistoryFailure, TransactionFailure

@Beta
public abstract class RequestFailure<T extends org.opendaylight.yangtools.concepts.WritableIdentifier,C extends RequestFailure<T,C>>
extends Response<T,C>

A failure response to a Request. Contains a RequestException detailing the cause for this failure.

Author:

Robert Varga

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RequestFailure(C failure, @NonNull ABIVersion version)
protected	RequestFailure(T target, long sequence, @NonNull RequestException cause)

Method Summary

Modifier and Type	Method and Description
protected com.google.common.base.MoreObjects.ToStringHelper	addToStringAttributes(com.google.common.base.MoreObjects.ToStringHelper toStringHelper) Add attributes to the output of Message.toString().
protected abstract AbstractRequestFailureProxy<T,C>	externalizableProxy(ABIVersion version) Instantiate a serialization proxy for this object for the target ABI version.
@NonNull RequestException	getCause() Return the failure cause.
boolean	isHardFailure() Return an indication of whether this a hard failure.

Methods inherited from class org.opendaylight.controller.cluster.access.concepts.Message

cloneAsVersion, getSequence, getTarget, getVersion, toString, toVersion, writeReplace

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestFailure

protected RequestFailure(C failure,
                         @NonNull ABIVersion version)

RequestFailure

protected RequestFailure(T target,
                         long sequence,
                         @NonNull RequestException cause)

Method Detail

getCause

public final @NonNull RequestException getCause()

Return the failure cause.

Returns:

Failure cause.

isHardFailure

public final boolean isHardFailure()

Return an indication of whether this a hard failure. Hard failures must not be retried but need to be treated as authoritative response to a request.

Returns:

True if this represents a hard failure, false otherwise.

addToStringAttributes

protected com.google.common.base.MoreObjects.ToStringHelper addToStringAttributes(com.google.common.base.MoreObjects.ToStringHelper toStringHelper)

Description copied from class: Message

Add attributes to the output of Message.toString(). Subclasses wanting to contribute additional information should override this method. Any null attributes will be omitted from the output.

Overrides:

addToStringAttributes in class Message<T extends org.opendaylight.yangtools.concepts.WritableIdentifier,C extends RequestFailure<T,C>>

Parameters:

toStringHelper - a MoreObjects.ToStringHelper instance

Returns:

The MoreObjects.ToStringHelper passed in as argument

externalizableProxy

protected abstract AbstractRequestFailureProxy<T,C> externalizableProxy(ABIVersion version)

Description copied from class: Message

Instantiate a serialization proxy for this object for the target ABI version. Implementations should return different objects for incompatible ABIVersions. This method should never fail, as any compatibility checks should have been done by Message.cloneAsVersion(ABIVersion).

Parameters:

version - Requested ABI version

Returns:

Proxy for this object