summaryrefslogtreecommitdiff
path: root/src/main/java/com/amazon/carbonado/OptimisticLockException.java
blob: 03004c21577b41166caaa43266f4ed96651b67e2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
/*
 * Copyright 2006 Amazon Technologies, Inc. or its affiliates.
 * Amazon, Amazon.com and Carbonado are trademarks or registered trademarks
 * of Amazon Technologies, Inc. or its affiliates.  All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.amazon.carbonado;

/**
 * An OptimisticLockException is thrown if the {@link Repository} is using
 * optimistic locking for concurrency control, and lock aquisition failed.
 * This exception may also be thrown if multiversion concurrency control (MVCC)
 * is being used and the commit fails.
 *
 * @author Brian S O'Neill
 */
public class OptimisticLockException extends PersistException {

    private static final long serialVersionUID = 4081788711829580886L;

    private final transient Storable mStorable;

    public OptimisticLockException() {
        super();
        mStorable = null;
    }

    public OptimisticLockException(String message) {
        super(message);
        mStorable = null;
    }

    public OptimisticLockException(String message, Throwable cause) {
        super(message, cause);
        mStorable = null;
    }

    public OptimisticLockException(Throwable cause) {
        super(cause);
        mStorable = null;
    }

    /**
     * @param expectedVersion version number that was expected for persistent
     * record when update was executed
     */
    public OptimisticLockException(long expectedVersion) {
        this((Long) expectedVersion);
    }

    /**
     * @param expectedVersion version number that was expected for persistent
     * record when update was executed
     */
    public OptimisticLockException(Object expectedVersion) {
        this(expectedVersion, null);
    }

    /**
     * @param expectedVersion version number that was expected for persistent
     * record when update was executed
     * @param savedVersion actual persistent version number of storable
     */
    public OptimisticLockException(Object expectedVersion, Object savedVersion) {
        this(expectedVersion, savedVersion, null);
    }

    /**
     * @param expectedVersion version number that was expected for persistent
     * record when update was executed
     * @param savedVersion actual persistent version number of storable
     * @param s Storable which was acted upon
     */
    public OptimisticLockException(Object expectedVersion, Object savedVersion, Storable s) {
        super(makeMessage(expectedVersion, savedVersion, s));
        mStorable = s;
    }

    /**
     * Construct exception for when new version was expected to have increased.
     *
     * @param savedVersion actual persistent version number of storable
     * @param s Storable which was acted upon
     * @param newVersion new version which was provided
     */
    public OptimisticLockException(Object savedVersion, Storable s, Object newVersion) {
        super(makeMessage(savedVersion, s, newVersion));
        mStorable = s;
    }

    /**
     * Returns the Storable which was acted upon, or null if not available.
     */
    public Storable getStorable() {
        return mStorable;
    }

    private static String makeMessage(Object expectedVersion, Object savedVersion, Storable s) {
        String message;
        if (expectedVersion == null && savedVersion == null) {
            message = null;
        } else {
            message = "Update acted on version " + expectedVersion +
                ", but canonical version is " + savedVersion;
        }

        if (s != null) {
            if (message == null) {
                message = s.toStringKeyOnly();
            } else {
                message = message + ": " + s.toStringKeyOnly();
            }
        }

        return message;
    }

    private static String makeMessage(Object savedVersion, Storable s, Object newVersion) {
        String message;
        if (savedVersion == null && newVersion == null) {
            message = "New version is not larger than existing version";
        } else {
            message = "New version of " + newVersion +
                " is not larger than existing version of " + savedVersion;
        }

        if (s != null) {
            if (message == null) {
                message = s.toStringKeyOnly();
            } else {
                message = message + ": " + s.toStringKeyOnly();
            }
        }

        return message;
    }
}