opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/concepts/Envelope.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 static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.base.MoreObjects;
  13 import java.io.Serializable;
  14 import org.opendaylight.yangtools.concepts.Immutable;
  15
  16 public abstract class Envelope<T extends Message<?, ?>> implements Immutable, Serializable {
  17     private static final long serialVersionUID = 1L;
  18
  19     private final T message;
  20     private final long txSequence;
  21     private final long sessionId;
  22
  23     Envelope(final T message, final long sessionId, final long txSequence) {
  24         this.message = requireNonNull(message);
  25         this.sessionId = sessionId;
  26         this.txSequence = txSequence;
  27     }
  28
  29     /**
  30      * Get the enclosed message.
  31      *
  32      * @return enclose message
  33      */
  34     public T getMessage() {
  35         return message;
  36     }
  37
  38     /**
  39      * Get the message transmission sequence of this envelope.
  40      *
  41      * @return Message sequence
  42      */
  43     public long getTxSequence() {
  44         return txSequence;
  45     }
  46
  47     /**
  48      * Get the session identifier.
  49      *
  50      * @return Session identifier
  51      */
  52     public long getSessionId() {
  53         return sessionId;
  54     }
  55
  56     @Override
  57     public String toString() {
  58         return MoreObjects.toStringHelper(Envelope.class).add("sessionId", Long.toHexString(sessionId))
  59                 .add("txSequence", Long.toHexString(txSequence)).add("message", message).toString();
  60     }
  61
  62     final Object writeReplace() {
  63         return createProxy();
  64     }
  65
  66     abstract AbstractEnvelopeProxy<T> createProxy();
  67 }