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