Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 405a528806217e7131f3c06c799fe9f1570850d0 (plain) (blame)
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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
package org.eclipse.emf.internal.cdo;

import org.eclipse.emf.cdo.CDOState;
import org.eclipse.emf.cdo.eresource.CDOResource;
import org.eclipse.emf.cdo.internal.protocol.model.CDOClassImpl;
import org.eclipse.emf.cdo.internal.protocol.revision.CDORevisionImpl;
import org.eclipse.emf.cdo.protocol.CDOID;
import org.eclipse.emf.cdo.protocol.util.TransportException;
import org.eclipse.emf.cdo.util.CDOUtil;
import org.eclipse.emf.cdo.util.ServerException;

import org.eclipse.net4j.internal.util.om.trace.ContextTracer;
import org.eclipse.net4j.util.fsm.FiniteStateMachine;
import org.eclipse.net4j.util.fsm.ITransition;

import org.eclipse.emf.internal.cdo.bundle.OM;
import org.eclipse.emf.internal.cdo.protocol.CommitTransactionResult;
import org.eclipse.emf.internal.cdo.protocol.ResourceIDRequest;
import org.eclipse.emf.internal.cdo.util.FSMUtil;

import java.text.MessageFormat;
import java.util.Iterator;
import java.util.Map;

/**
 * @author Eike Stepper
 */
public final class CDOStateMachine extends FiniteStateMachine<CDOState, CDOEvent, InternalCDOObject>
{
  // @Singleton
  public static final CDOStateMachine INSTANCE = new CDOStateMachine();

  private static final ContextTracer TRACER = new ContextTracer(OM.DEBUG_OBJECT, CDOStateMachine.class);

  private CDOStateMachine()
  {
    super(CDOState.class, CDOEvent.class);

    transit(CDOState.TRANSIENT, CDOEvent.ATTACH, new AttachTransition());
    transit(CDOState.TRANSIENT, CDOEvent.DETACH, FAIL);
    transit(CDOState.TRANSIENT, CDOEvent.READ, IGNORE);
    transit(CDOState.TRANSIENT, CDOEvent.WRITE, IGNORE);
    transit(CDOState.TRANSIENT, CDOEvent.COMMIT, FAIL);
    transit(CDOState.TRANSIENT, CDOEvent.ROLLBACK, FAIL);
    transit(CDOState.TRANSIENT, CDOEvent.INVALIDATE, FAIL);
    transit(CDOState.TRANSIENT, CDOEvent.FINALIZE_ATTACH, FAIL);

    transit(CDOState.PREPARED_ATTACH, CDOEvent.ATTACH, FAIL);
    transit(CDOState.PREPARED_ATTACH, CDOEvent.DETACH, FAIL);
    transit(CDOState.PREPARED_ATTACH, CDOEvent.READ, FAIL);
    transit(CDOState.PREPARED_ATTACH, CDOEvent.WRITE, FAIL);
    transit(CDOState.PREPARED_ATTACH, CDOEvent.COMMIT, FAIL);
    transit(CDOState.PREPARED_ATTACH, CDOEvent.ROLLBACK, FAIL);
    transit(CDOState.PREPARED_ATTACH, CDOEvent.INVALIDATE, FAIL);
    transit(CDOState.PREPARED_ATTACH, CDOEvent.FINALIZE_ATTACH, new FinalizeAttachTransition());

    transit(CDOState.NEW, CDOEvent.ATTACH, FAIL);
    transit(CDOState.NEW, CDOEvent.DETACH, FAIL);
    transit(CDOState.NEW, CDOEvent.READ, IGNORE);
    transit(CDOState.NEW, CDOEvent.WRITE, IGNORE);
    transit(CDOState.NEW, CDOEvent.COMMIT, new CommitTransition());
    transit(CDOState.NEW, CDOEvent.ROLLBACK, FAIL);
    transit(CDOState.NEW, CDOEvent.INVALIDATE, FAIL);
    transit(CDOState.NEW, CDOEvent.FINALIZE_ATTACH, FAIL);

    transit(CDOState.CLEAN, CDOEvent.ATTACH, FAIL);
    transit(CDOState.CLEAN, CDOEvent.DETACH, FAIL);
    transit(CDOState.CLEAN, CDOEvent.READ, IGNORE);
    transit(CDOState.CLEAN, CDOEvent.WRITE, new WriteTransition());
    transit(CDOState.CLEAN, CDOEvent.COMMIT, FAIL);
    transit(CDOState.CLEAN, CDOEvent.ROLLBACK, FAIL);
    transit(CDOState.CLEAN, CDOEvent.INVALIDATE, new InvalidateTransition());
    transit(CDOState.CLEAN, CDOEvent.FINALIZE_ATTACH, FAIL);

    transit(CDOState.DIRTY, CDOEvent.ATTACH, FAIL);
    transit(CDOState.DIRTY, CDOEvent.DETACH, FAIL);
    transit(CDOState.DIRTY, CDOEvent.READ, IGNORE);
    transit(CDOState.DIRTY, CDOEvent.WRITE, IGNORE);
    transit(CDOState.DIRTY, CDOEvent.COMMIT, new CommitTransition());
    transit(CDOState.DIRTY, CDOEvent.ROLLBACK, FAIL);
    transit(CDOState.DIRTY, CDOEvent.INVALIDATE, FAIL);
    transit(CDOState.DIRTY, CDOEvent.FINALIZE_ATTACH, FAIL);

    transit(CDOState.PROXY, CDOEvent.ATTACH, new LoadResourceTransition());
    transit(CDOState.PROXY, CDOEvent.DETACH, new DetachTransition());
    transit(CDOState.PROXY, CDOEvent.READ, new LoadTransition(false));
    transit(CDOState.PROXY, CDOEvent.WRITE, new LoadTransition(true));
    transit(CDOState.PROXY, CDOEvent.COMMIT, FAIL);
    transit(CDOState.PROXY, CDOEvent.ROLLBACK, FAIL);
    transit(CDOState.PROXY, CDOEvent.INVALIDATE, IGNORE);
    transit(CDOState.PROXY, CDOEvent.FINALIZE_ATTACH, IGNORE);

    transit(CDOState.CONFLICT, CDOEvent.ATTACH, FAIL);
    transit(CDOState.CONFLICT, CDOEvent.DETACH, FAIL);
    transit(CDOState.CONFLICT, CDOEvent.READ, FAIL);
    transit(CDOState.CONFLICT, CDOEvent.WRITE, FAIL);
    transit(CDOState.CONFLICT, CDOEvent.COMMIT, FAIL);
    transit(CDOState.CONFLICT, CDOEvent.ROLLBACK, FAIL);
    transit(CDOState.CONFLICT, CDOEvent.INVALIDATE, FAIL);
    transit(CDOState.CONFLICT, CDOEvent.FINALIZE_ATTACH, FAIL);
  }

  public void attach(InternalCDOObject object, CDOResource resource, CDOViewImpl view)
  {
    ResourceAndView data = new ResourceAndView();
    data.resource = resource;
    data.view = view;

    // TRANSIENT --> PREPARED_ATTACH
    if (TRACER.isEnabled())
      TRACER.format("ATTACH: {0} --> {1}", object, view);
    process(object, CDOEvent.ATTACH, data);

    // PREPARED_ATTACH --> NEW
    if (TRACER.isEnabled())
      TRACER.format("FINALIZE_ATTACH: {0} --> {1}", object, view);
    process(object, CDOEvent.FINALIZE_ATTACH, data);
  }

  public void detach(InternalCDOObject object, CDOResource resource, CDOViewImpl view)
  {
    // TODO Implement method CDOStateMachine.detach()
    throw new UnsupportedOperationException("Not yet implemented");
  }

  public void read(InternalCDOObject object)
  {
    if (TRACER.isEnabled())
      TRACER.format("READ: {0}", object);
    process(object, CDOEvent.READ, null);
  }

  public void write(InternalCDOObject object)
  {
    if (TRACER.isEnabled())
      TRACER.format("WRITE: {0}", object);
    process(object, CDOEvent.WRITE, null);
  }

  public void invalidate(InternalCDOObject object, long timeStamp)
  {
    if (TRACER.isEnabled())
      TRACER.format("INVALIDATE: {0}", object);
    process(object, CDOEvent.INVALIDATE, timeStamp);
  }

  public void commit(InternalCDOObject object, CommitTransactionResult result)
  {
    if (TRACER.isEnabled())
      TRACER.format("COMMIT: {0}", object);
    process(object, CDOEvent.COMMIT, result);
  }

  public void rollback(InternalCDOObject object)
  {
    if (TRACER.isEnabled())
      TRACER.format("ROLLBACK: {0}", object);
    process(object, CDOEvent.ROLLBACK, null);
  }

  @Override
  protected CDOState getState(InternalCDOObject object)
  {
    return object.cdoState();
  }

  /**
   * @author Eike Stepper
   */
  private static final class ResourceAndView
  {
    public CDOResource resource;

    public CDOViewImpl view;

    @Override
    public String toString()
    {
      return MessageFormat.format("ResourceAndView({0}, {1})", resource, view);
    }
  }

  /**
   * @author Eike Stepper
   */
  private static final class AttachTransition implements
      ITransition<CDOState, CDOEvent, InternalCDOObject, ResourceAndView>
  {
    public void execute(InternalCDOObject object, CDOState state, CDOEvent event, ResourceAndView data)
    {
      CDOTransactionImpl transaction = data.view.toTransaction();

      // Prepare object
      CDOID id = transaction.getNextTemporaryID();
      object.cdoInternalSetID(id);
      object.cdoInternalSetResource(data.resource);
      object.cdoInternalSetView(data.view);
      object.cdoInternalSetState(CDOState.PREPARED_ATTACH);

      // Create new revision
      CDORevisionImpl revision = new CDORevisionImpl((CDOClassImpl)object.cdoClass(), id);
      revision.setVersion(1);
      revision.setResourceID(data.resource.cdoID());
      object.cdoInternalSetRevision(revision);

      // Register object
      data.view.registerObject(object);
      transaction.registerNew(object);

      // Attach content tree
      for (Iterator it = FSMUtil.iterator(object.eContents(), transaction); it.hasNext();)
      {
        InternalCDOObject content = (InternalCDOObject)it.next();
        INSTANCE.process(content, CDOEvent.ATTACH, data);
      }
    }
  }

  /**
   * @author Eike Stepper
   */
  private static final class FinalizeAttachTransition implements
      ITransition<CDOState, CDOEvent, InternalCDOObject, Object>
  {
    public void execute(InternalCDOObject object, CDOState state, CDOEvent event, Object data)
    {
      CDOTransactionImpl transaction = (CDOTransactionImpl)object.cdoView();
      object.cdoInternalPostAttach();
      object.cdoInternalSetState(CDOState.NEW);

      // Finalize content tree
      for (Iterator it = FSMUtil.iterator(object.eContents(), transaction); it.hasNext();)
      {
        InternalCDOObject content = (InternalCDOObject)it.next();
        INSTANCE.process(content, CDOEvent.FINALIZE_ATTACH, data);
      }
    }
  }

  /**
   * @author Eike Stepper
   */
  private static final class DetachTransition implements ITransition<CDOState, CDOEvent, InternalCDOObject, Object>
  {
    public void execute(InternalCDOObject object, CDOState state, CDOEvent event, Object data)
    {
      // TODO Implement method DetachTransition.execute()
      throw new UnsupportedOperationException("Not yet implemented");
    }
  }

  /**
   * @author Eike Stepper
   */
  private static final class CommitTransition implements
      ITransition<CDOState, CDOEvent, InternalCDOObject, CommitTransactionResult>
  {
    public void execute(InternalCDOObject object, CDOState state, CDOEvent event, CommitTransactionResult data)
    {
      CDOViewImpl view = (CDOViewImpl)object.cdoView();
      Map<CDOID, CDOID> idMappings = data.getIDMappings();

      // Adjust object
      CDOID id = object.cdoID();
      CDOID newID = idMappings.get(id);
      if (newID != null)
      {
        object.cdoInternalSetID(newID);
        view.remapObject(id);
        id = newID;
      }

      // Adjust revision
      CDORevisionImpl revision = (CDORevisionImpl)object.cdoRevision();
      revision.setID(id);
      revision.setCreated(data.getTimeStamp());
      revision.adjustReferences(idMappings);
      view.getSession().getRevisionManager().addRevision(revision);

      object.cdoInternalSetState(CDOState.CLEAN);
    }
  }

  /**
   * @author Eike Stepper
   */
  private static final class WriteTransition implements ITransition<CDOState, CDOEvent, InternalCDOObject, Object>
  {
    public void execute(InternalCDOObject object, CDOState state, CDOEvent event, Object data)
    {
      // Copy revision
      CDORevisionImpl revision = new CDORevisionImpl((CDORevisionImpl)object.cdoRevision());
      object.cdoInternalSetRevision(revision);
      revision.increaseVersion();

      CDOViewImpl view = (CDOViewImpl)object.cdoView();
      CDOTransactionImpl transaction = view.toTransaction();
      transaction.registerDirty(object);

      object.cdoInternalSetState(CDOState.DIRTY);
    }
  }

  /**
   * @author Eike Stepper
   */
  private static final class InvalidateTransition implements ITransition<CDOState, CDOEvent, InternalCDOObject, Long>
  {
    public void execute(InternalCDOObject object, CDOState state, CDOEvent event, Long timeStamp)
    {
      ((CDORevisionImpl)object.cdoRevision()).setRevised(timeStamp - 1);
      object.cdoInternalSetState(CDOState.PROXY);
    }
  }

  /**
   * @author Eike Stepper
   */
  private static final class LoadTransition implements ITransition<CDOState, CDOEvent, InternalCDOObject, Object>
  {
    private boolean forWrite;

    public LoadTransition(boolean forWrite)
    {
      this.forWrite = forWrite;
    }

    public void execute(InternalCDOObject object, CDOState state, CDOEvent event, Object data)
    {
      CDOID id = object.cdoID();
      CDOViewImpl view = (CDOViewImpl)object.cdoView();
      CDORevisionImpl revision = view.lookupRevision(id);
      object.cdoInternalSetRevision(revision);
      object.cdoInternalSetState(CDOState.CLEAN);
      object.cdoInternalPostLoad();

      if (forWrite)
      {
        INSTANCE.write(object);
      }
    }
  }

  /**
   * @author Eike Stepper
   */
  private static final class LoadResourceTransition implements
      ITransition<CDOState, CDOEvent, InternalCDOObject, ResourceAndView>
  {
    public void execute(InternalCDOObject object, CDOState state, CDOEvent event, ResourceAndView data)
    {
      CDOID id = requestID(data.resource, data.view);
      if (id == CDOID.NULL)
      {
        throw new ServerException("Resource not available: " + data.resource.getPath());
      }

      // Prepare object
      object.cdoInternalSetID(id);
      object.cdoInternalSetResource(data.resource);
      object.cdoInternalSetView(data.view);

      // Register object
      data.view.registerObject(object);
    }

    private CDOID requestID(CDOResource resource, CDOViewImpl view)
    {
      String path = CDOUtil.extractPath(resource.getURI());
      ResourceIDRequest signal = new ResourceIDRequest(view.getSession().getChannel(), path);

      try
      {
        return signal.send();
      }
      catch (RuntimeException ex)
      {
        throw ex;
      }
      catch (Exception ex)
      {
        throw new TransportException(ex);
      }
    }
  }
}

/**
 * @author Eike Stepper
 */
enum CDOEvent
{
  ATTACH, DETACH, READ, WRITE, COMMIT, ROLLBACK, INVALIDATE, FINALIZE_ATTACH
}

Back to the top