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
|
/*
* 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.capability;
import com.amazon.carbonado.Repository;
import com.amazon.carbonado.RepositoryException;
import com.amazon.carbonado.Storable;
/**
* Capability of replicating repositories for re-synchronizing to the master
* repository. A re-sync operation can be used to fill up a fresh replication
* repository or to repair inconsistencies.
*
* @author Brian S O'Neill
*/
public interface ResyncCapability extends Capability {
/**
* Re-synchronizes replicated storables against the master repository.
*
* @param type type of storable to re-sync
* @param desiredSpeed throttling parameter - 1.0 = full speed, 0.5 = half
* speed, 0.1 = one-tenth speed, etc
* @param filter optional query filter to limit which objects get re-sync'ed
* @param filterValues filter values for optional filter
*/
<S extends Storable> void resync(Class<S> type,
double desiredSpeed,
String filter,
Object... filterValues)
throws RepositoryException;
/**
* Re-synchronizes replicated storables against the master repository.
*
* @param type type of storable to re-sync
* @param listener optional listener which gets notified as storables are re-sync'd
* @param desiredSpeed throttling parameter - 1.0 = full speed, 0.5 = half
* speed, 0.1 = one-tenth speed, etc
* @param filter optional query filter to limit which objects get re-sync'ed
* @param filterValues filter values for optional filter
* @since 1.2
*/
<S extends Storable> void resync(Class<S> type,
Listener<? super S> listener,
double desiredSpeed,
String filter,
Object... filterValues)
throws RepositoryException;
/**
* Returns the immediate master Repository, for manual comparison. Direct
* updates to the master will likely create inconsistencies.
*/
Repository getMasterRepository();
/**
* Defines callbacks which are invoked as storables get re-sync'd. The
* callback is invoked in the scope of the resync transaction. If any
* exception is thrown, the immediate changes are rolled back and the
* entire repository resync operation is aborted.
*
* <p>The listener implementation should return quickly from the callback
* methods, to avoid lingering transactions. If the listener is used to
* invoke special repair operations, they should be placed into a task
* queue. A separate thread can then perform the repairs outside the resync
* transaction.
*/
public static interface Listener<S> {
/**
* Called when a storable was inserted as part of a resync.
*
* @param newStorable storable which was inserted, never null
*/
void inserted(S newStorable);
/**
* Called when a storable was updated as part of a resync. Both old and
* new storables have a matching primary key.
*
* @param oldStorable storable which was deleted, never null
* @param newStorable storable which was inserted, never null
*/
void updated(S oldStorable, S newStorable);
/**
* Called when a storable was deleted as part of a resync.
*
* @param oldStorable storable which was deleted, never null
*/
void deleted(S oldStorable);
}
}
|
