b7b2228e0f7e40e9935c7dffa2523b93ef11b5d1
[controller.git] / opendaylight / md-sal / cds-access-api / src / main / java / org / opendaylight / controller / cluster / access / commands / UnknownHistoryException.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.commands;
9
10 import java.io.Serial;
11 import org.opendaylight.controller.cluster.access.concepts.RequestException;
12
13 /**
14  * A {@link RequestException} indicating that the backend has received a request referencing an unknown history. This
15  * typically happens when the linear history ID is newer than the highest observed {@link CreateLocalHistoryRequest}.
16  */
17 public final class UnknownHistoryException extends RequestException {
18     @Serial
19     private static final long serialVersionUID = 1L;
20
21     public UnknownHistoryException(final Long lastSeenHistory) {
22         super("Last known history is " + historyToString(lastSeenHistory));
23     }
24
25     private static String historyToString(final Long history) {
26         return history == null ? "null" : Long.toUnsignedString(history);
27     }
28
29     @Override
30     public boolean isRetriable() {
31         return true;
32     }
33 }