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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
/**
* Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Eike Stepper - initial API and implementation
*/
package org.eclipse.emf.cdo.common;
import org.eclipse.emf.cdo.common.id.CDOID;
import org.eclipse.emf.cdo.common.util.CDOTimeProvider;
import org.eclipse.net4j.util.event.IEvent;
import java.util.Set;
/**
* Abstracts the information about CDO repositories that is common to both client and server side.
* <p>
* A CDOCommonRepository can fire the following events:
* <ul>
* <li> {@link TypeChangedEvent} after the {@link #getType() repository type} has changed in a fail-over cluster.
* <li> {@link StateChangedEvent} after the {@link #getState() repository state} has changed in a replicating deployment.
* </ul>
*
* @author Eike Stepper
* @since 3.0
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
* @apiviz.landmark
* @apiviz.has {@link CDOCommonRepository.IDGenerationLocation}
* @apiviz.has {@link CDOCommonRepository.Type}
* @apiviz.has {@link CDOCommonRepository.State}
* @apiviz.uses {@link CDOCommonRepository.TypeChangedEvent} - - fires
* @apiviz.uses {@link CDOCommonRepository.StateChangedEvent} - - fires
*/
public interface CDOCommonRepository extends CDOTimeProvider
{
/**
* Returns the name of this repository.
*/
public String getName();
/**
* Returns the UUID of this repository.
*/
public String getUUID();
/**
* Returns the type of this repository.
*/
public Type getType();
/**
* Returns the state of this repository.
*/
public State getState();
/**
* Returns the creation time of this repository.
*/
public long getCreationTime();
/**
* Returns the type of the store of this repository.
*/
public String getStoreType();
/**
* Returns the type of CDOIDs created by the store of this repository.
*/
public Set<CDOID.ObjectType> getObjectIDTypes();
/**
* @since 4.1
*/
public IDGenerationLocation getIDGenerationLocation();
/**
* Returns the ID of the root resource of this repository.
*/
public CDOID getRootResourceID();
/**
* Returns <code>true</code> if this repository supports auditing, <code>false</code> otherwise.
*/
public boolean isSupportingAudits();
/**
* Returns <code>true</code> if this repository supports branching, <code>false</code> otherwise.
*/
public boolean isSupportingBranches();
/**
* Returns <code>true</code> if this repository supports instances of Ecore, <code>false</code> otherwise.
*
* @since 4.0
*/
public boolean isSupportingEcore();
/**
* Returns <code>true</code> if this repository ensures referential integrity, <code>false</code> otherwise.
*
* @since 4.0
*/
public boolean isEnsuringReferentialIntegrity();
/**
* Enumerates the possible {@link CDOCommonRepository#getIDGenerationLocation() ID generation locations} of a CDO
* repository.
*
* @author Eike Stepper
* @since 4.1
*/
public enum IDGenerationLocation
{
STORE, CLIENT
}
/**
* Enumerates the possible {@link CDOCommonRepository#getType() types} of a CDO repository.
*
* @author Eike Stepper
*/
public enum Type
{
MASTER, BACKUP, CLONE
}
/**
* Enumerates the possible {@link CDOCommonRepository#getState() states} of a CDO repository.
*
* @author Eike Stepper
*/
public static enum State
{
INITIAL, OFFLINE, SYNCING, ONLINE;
public boolean isConnected()
{
return this == SYNCING || this == ONLINE;
}
}
/**
* An {@link IEvent event} fired when the {@link Type type} of a CDO repository has changed. This usually happens only
* for repository fail-over participants.
*
* @author Eike Stepper
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface TypeChangedEvent extends IEvent
{
public Type getOldType();
public Type getNewType();
}
/**
* An {@link IEvent event} fired when the {@link State state} of a CDO repository has changed.
*
* @author Eike Stepper
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface StateChangedEvent extends IEvent
{
public State getOldState();
public State getNewState();
}
}
|
