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, org.opendaylight.yangtools.concepts.Immutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.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 and Description
ConnectClientSuccess(ClientIdentifier target, long sequence, akka.actor.ActorRef backend, List<akka.actor.ActorSelection> alternates, org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree dataTree, int maxMessages)

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 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) Instantiate a serialization proxy for this object for the target ABI version.
List<akka.actor.ActorSelection>	getAlternates() Return the list of known alternate backends.
akka.actor.ActorRef	getBackend()
Optional<org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree>	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
                            akka.actor.ActorRef backend,
                            @Nonnull
                            List<akka.actor.ActorSelection> alternates,
                            @Nonnull
                            org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree dataTree,
                            int maxMessages)

Method Detail

getAlternates

@Nonnull
public List<akka.actor.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

@Nonnull
public akka.actor.ActorRef getBackend()

getDataTree

public Optional<org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree> getDataTree()

getMaxMessages

public int getMaxMessages()

externalizableProxy

protected org.opendaylight.controller.cluster.access.commands.ConnectClientSuccessProxyV1 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).

Specified by:

externalizableProxy in class RequestSuccess<ClientIdentifier,ConnectClientSuccess>

Parameters:

version - Requested ABI version

Returns:

Proxy for this object

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(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 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<ClientIdentifier,ConnectClientSuccess>

Parameters:

toStringHelper - a MoreObjects.ToStringHelper instance

Returns:

The MoreObjects.ToStringHelper passed in as argument