263664bd06e839147628965b8ec903e362ee5fd6
[controller.git] / opendaylight / md-sal / cds-access-api / src / main / java / org / opendaylight / controller / cluster / access / concepts / RequestEnvelope.java
1 /*
2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.controller.cluster.access.concepts;
9
10 import akka.actor.ActorRef;
11
12 public final class RequestEnvelope extends Envelope<Request<?, ?>> {
13     private static final long serialVersionUID = 1L;
14
15     public RequestEnvelope(final Request<?, ?> message, final long sequence, final long retry) {
16         super(message, sequence, retry);
17     }
18
19     @Override
20     RequestEnvelopeProxy createProxy() {
21         return new RequestEnvelopeProxy(this);
22     }
23
24     /**
25      * Respond to this envelope with a {@link RequestFailure} caused by specified {@link RequestException}.
26      *
27      * @param cause Cause of this {@link RequestFailure}
28      * @throws NullPointerException if cause is null
29      */
30     public void sendFailure(final RequestException cause) {
31         sendResponse(new FailureEnvelope(getMessage().toRequestFailure(cause), getSequence(), getRetry()));
32     }
33
34     /**
35      * Respond to this envelope with a {@link RequestSuccess}.
36      *
37      * @param success Successful response
38      * @throws NullPointerException if success is null
39      */
40     public void sendSuccess(final RequestSuccess<?, ?> success) {
41         sendResponse(new SuccessEnvelope(success, getSequence(), getRetry()));
42     }
43
44     private void sendResponse(final ResponseEnvelope<?> envelope) {
45         getMessage().getReplyTo().tell(envelope, ActorRef.noSender());
46     }
47 }