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

Class ConnectClientRequest

java.lang.Object

org.opendaylight.controller.cluster.access.concepts.Message<ClientIdentifier,ConnectClientRequest>

org.opendaylight.controller.cluster.access.concepts.Request<ClientIdentifier,ConnectClientRequest>

org.opendaylight.controller.cluster.access.commands.ConnectClientRequest

All Implemented Interfaces:

Serializable, Immutable

public final class ConnectClientRequest
extends Request<ClientIdentifier,ConnectClientRequest>

Request to connect a frontend instance to the backend. It carries basic information about the frontend:

• its coordinates in Request.getReplyTo()
• its minimum supported ABI version
• its maximum supported ABI version

It also includes request stream sequencing information.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ConnectClientRequest(ClientIdentifier identifier, ActorRef replyTo, ABIVersion minVersion, ABIVersion maxVersion)

Method Summary

Modifier and Type	Method	Description
protected MoreObjects.ToStringHelper	addToStringAttributes(MoreObjects.ToStringHelper toStringHelper)	Add attributes to the output of Message.toString().
protected ConnectClientRequest	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.ConnectClientRequest.SerialForm	externalizableProxy(ABIVersion version)	Instantiate a serialization proxy for this object for the target ABI version.
ABIVersion	getMaxVersion()
ABIVersion	getMinVersion()
ConnectClientFailure	toRequestFailure(RequestException cause)	Return a RequestFailure for this request, caused by a RequestException.

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

getReplyTo

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

getSequence, getTarget, getVersion, throwNSE, toString, toVersion, writeReplace

Methods inherited from class java.lang.Object

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

Constructor Details

ConnectClientRequest

public ConnectClientRequest(ClientIdentifier identifier,
 ActorRef replyTo,
 ABIVersion minVersion,
 ABIVersion maxVersion)

Method Details

getMinVersion

public ABIVersion getMinVersion()

getMaxVersion

public ABIVersion getMaxVersion()

toRequestFailure

public ConnectClientFailure toRequestFailure(RequestException cause)

Description copied from class: Request

Return a RequestFailure for this request, caused by a RequestException.

Specified by:

toRequestFailure in class Request<ClientIdentifier,ConnectClientRequest>

Parameters:

cause - Failure cause

Returns:

RequestFailure corresponding to this request

externalizableProxy

protected org.opendaylight.controller.cluster.access.commands.ConnectClientRequest.SerialForm 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 Request<ClientIdentifier,ConnectClientRequest>

Parameters:

version - Requested ABI version

Returns:

Proxy for this object

cloneAsVersion

protected ConnectClientRequest 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,ConnectClientRequest>

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 Request<ClientIdentifier,ConnectClientRequest>

Parameters:

toStringHelper - a MoreObjects.ToStringHelper instance

Returns:

The MoreObjects.ToStringHelper passed in as argument