2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.cluster.datastore.persisted;
10 import com.google.common.io.ByteArrayDataOutput;
11 import com.google.common.io.ByteStreams;
12 import java.io.DataInput;
13 import java.io.IOException;
14 import org.opendaylight.controller.cluster.access.concepts.LocalHistoryIdentifier;
15 import org.slf4j.Logger;
16 import org.slf4j.LoggerFactory;
19 * Payload persisted when a local history is completely purged, i.e. the frontend has removed it from its tracking.
20 * It contains a {@link LocalHistoryIdentifier}.
22 * @author Robert Varga
24 public final class PurgeLocalHistoryPayload extends AbstractIdentifiablePayload<LocalHistoryIdentifier> {
25 private static final class Proxy extends AbstractProxy<LocalHistoryIdentifier> {
26 private static final long serialVersionUID = 1L;
28 // checkstyle flags the public modifier as redundant which really doesn't make sense since it clearly isn't
29 // redundant. It is explicitly needed for Java serialization to be able to create instances via reflection.
30 @SuppressWarnings("checkstyle:RedundantModifier")
35 Proxy(final byte[] serialized) {
40 protected LocalHistoryIdentifier readIdentifier(final DataInput in) throws IOException {
41 return LocalHistoryIdentifier.readFrom(in);
45 protected PurgeLocalHistoryPayload createObject(final LocalHistoryIdentifier identifier,
46 final byte[] serialized) {
47 return new PurgeLocalHistoryPayload(identifier, serialized);
51 private static final Logger LOG = LoggerFactory.getLogger(PurgeLocalHistoryPayload.class);
52 private static final long serialVersionUID = 1L;
54 PurgeLocalHistoryPayload(final LocalHistoryIdentifier historyId, final byte[] serialized) {
55 super(historyId, serialized);
58 public static PurgeLocalHistoryPayload create(final LocalHistoryIdentifier historyId,
59 final int initialSerializedBufferCapacity) {
60 final ByteArrayDataOutput out = ByteStreams.newDataOutput(initialSerializedBufferCapacity);
62 historyId.writeTo(out);
63 } catch (IOException e) {
64 // This should never happen
65 LOG.error("Failed to serialize {}", historyId, e);
66 throw new RuntimeException("Failed to serialize " + historyId, e);
68 return new PurgeLocalHistoryPayload(historyId, out.toByteArray());
72 protected Proxy externalizableProxy(final byte[] serialized) {
73 return new Proxy(serialized);