Package org.opendaylight.controller.cluster.access.commands

Class ConnectClientSuccess

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.RequestSuccess<ClientIdentifier,ConnectClientSuccess>

org.opendaylight.controller.cluster.access.commands.ConnectClientSuccess

All Implemented Interfaces:

Serializable, Immutable, MutationBehaviour<Immutable>

@Beta
public final class ConnectClientSuccess
extends RequestSuccess<ClientIdentifier,ConnectClientSuccess>

Successful reply to an ConnectClientRequest. Client actor which initiated this connection should use the version reported via Message.getVersion() of this message to communicate with this backend. Should this backend fail, the client can try accessing the provided alternates.

Author:

Robert Varga

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ConnectClientSuccess(@NonNull ClientIdentifier target, long sequence, @NonNull ActorRef backend, @NonNull List<ActorSelection> alternates, @NonNull ReadOnlyDataTree dataTree, int maxMessages)

Method Summary

Modifier and Type	Method	Description
protected MoreObjects.ToStringHelper	addToStringAttributes(MoreObjects.ToStringHelper toStringHelper)	Add attributes to the output of Message.toString().
protected ConnectClientSuccess	cloneAsVersion(ABIVersion version)	Create a copy of this message which will serialize to a stream corresponding to the specified method.
protected org.opendaylight.controller.cluster.access.commands.ConnectClientSuccessProxyV1	externalizableProxy(ABIVersion version)
@NonNull List<ActorSelection>	getAlternates()	Return the list of known alternate backends.
@NonNull ActorRef	getBackend()
Optional<ReadOnlyDataTree>	getDataTree()
int	getMaxMessages()

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

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

ConnectClientSuccess

public ConnectClientSuccess(@NonNull ClientIdentifier target,
                            long sequence,
                            @NonNull ActorRef backend,
                            @NonNull List<ActorSelection> alternates,
                            @NonNull ReadOnlyDataTree dataTree,
                            int maxMessages)

Method Detail

getAlternates

public @NonNull List<ActorSelection> getAlternates()

Return the list of known alternate backends. The client can use this list to perform recovery procedures.

Returns:

a list of known backend alternates

getBackend

public @NonNull ActorRef getBackend()

getDataTree

public Optional<ReadOnlyDataTree> getDataTree()

getMaxMessages

public int getMaxMessages()

externalizableProxy

protected org.opendaylight.controller.cluster.access.commands.ConnectClientSuccessProxyV1 externalizableProxy(ABIVersion version)

Specified by:

externalizableProxy in class RequestSuccess<ClientIdentifier,ConnectClientSuccess>

cloneAsVersion

protected ConnectClientSuccess cloneAsVersion(ABIVersion version)

Description copied from class: Message

Create a copy of this message which will serialize to a stream corresponding to the specified method. This method should be implemented by the concrete final message class and should invoke the equivalent of Message(Message, ABIVersion).

Specified by:

cloneAsVersion in class Message<ClientIdentifier,ConnectClientSuccess>

Parameters:

version - target ABI version

Returns:

A message with the specified serialization stream

addToStringAttributes

protected MoreObjects.ToStringHelper addToStringAttributes(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<ClientIdentifier,ConnectClientSuccess>

Parameters:

toStringHelper - a MoreObjects.ToStringHelper instance

Returns:

The MoreObjects.ToStringHelper passed in as argument