Package org.opendaylight.controller.cluster.access.concepts

Class RequestEnvelope

java.lang.Object

org.opendaylight.controller.cluster.access.concepts.Envelope<Request<?,?>>

org.opendaylight.controller.cluster.access.concepts.RequestEnvelope

All Implemented Interfaces:

Serializable, Immutable, MutationBehaviour<Immutable>

public final class RequestEnvelope
extends Envelope<Request<?,?>>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
RequestEnvelope(Request<?,?> message, long sessionId, long txSequence)

Method Summary

Modifier and Type	Method	Description
ResponseEnvelope<?>	newSuccessEnvelope(RequestSuccess<?,?> success, long executionTimeNanos)	Creates a successful ResponseEnvelope that wraps the given successful Request response message.
void	sendFailure(RequestException cause, long executionTimeNanos)	Respond to this envelope with a RequestFailure caused by specified RequestException.
void	sendSuccess(RequestSuccess<?,?> success, long executionTimeNanos)	Respond to this envelope with a RequestSuccess.

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

getMessage, getSessionId, getTxSequence, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestEnvelope

public RequestEnvelope(Request<?,?> message,
                       long sessionId,
                       long txSequence)

Method Detail

sendFailure

public void sendFailure(RequestException cause,
                        long executionTimeNanos)

Respond to this envelope with a RequestFailure caused by specified RequestException.

Parameters:

cause - Cause of this RequestFailure

executionTimeNanos - Time to execute the request, in nanoseconds

Throws:

NullPointerException - if cause is null

sendSuccess

public void sendSuccess(RequestSuccess<?,?> success,
                        long executionTimeNanos)

Respond to this envelope with a RequestSuccess.

Parameters:

success - Successful response

Throws:

NullPointerException - if success is null

newSuccessEnvelope

public ResponseEnvelope<?> newSuccessEnvelope(RequestSuccess<?,?> success,
                                              long executionTimeNanos)

Creates a successful ResponseEnvelope that wraps the given successful Request response message.

Parameters:

success - the successful Request response message

executionTimeNanos - the execution time of the request

Returns:

a ResponseEnvelope instance