Deprecate old MD-SAL APIs for removal
[controller.git] / opendaylight / md-sal / sal-common-api / src / main / java / org / opendaylight / controller / md / sal / common / api / data / TransactionCommitDeadlockException.java
1 /*
2  * Copyright (c) 2014 Brocade Communications 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
9 package org.opendaylight.controller.md.sal.common.api.data;
10
11 import com.google.common.base.Supplier;
12 import org.opendaylight.yangtools.yang.common.RpcError;
13 import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
14 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
15
16 /**
17  * A type of TransactionCommitFailedException that indicates a situation that would result in a
18  * threading deadlock. This can occur if a caller that submits a write transaction tries to perform
19  * a blocking call via one of the <code>get</code> methods on the returned ListenableFuture. Callers
20  * should process the commit result asynchronously (via Futures#addCallback) to ensure deadlock
21  * won't occur.
22  *
23  * @author Thomas Pantelis
24  *
25  * @deprecated Use {@link org.opendaylight.mdsal.common.api.TransactionCommitDeadlockException} instead.
26  */
27 @Deprecated(forRemoval = true)
28 public class TransactionCommitDeadlockException extends TransactionCommitFailedException {
29     private static final long serialVersionUID = 1L;
30     private static final String DEADLOCK_MESSAGE =
31             "An attempt to block on a ListenableFuture via a get method from a write "
32             + "transaction submit was detected that would result in deadlock. The commit "
33             + "result must be obtained asynchronously, e.g. via Futures#addCallback, to avoid deadlock.";
34     private static final RpcError DEADLOCK_RPCERROR = RpcResultBuilder.newError(ErrorType.APPLICATION,
35             "lock-denied", DEADLOCK_MESSAGE);
36
37     public static final Supplier<Exception> DEADLOCK_EXCEPTION_SUPPLIER =
38         () -> new TransactionCommitDeadlockException(DEADLOCK_MESSAGE, DEADLOCK_RPCERROR);
39
40     public TransactionCommitDeadlockException(final String message, final RpcError... errors) {
41         super(message, errors);
42     }
43 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.