1 /*
2 * ModeShape (http://www.modeshape.org)
3 * See the COPYRIGHT.txt file distributed with this work for information
4 * regarding copyright ownership. Some portions may be licensed
5 * to Red Hat, Inc. under one or more contributor license agreements.
6 * See the AUTHORS.txt file in the distribution for a full listing of
7 * individual contributors.
8 *
9 * ModeShape is free software. Unless otherwise indicated, all code in ModeShape
10 * is licensed to you under the terms of the GNU Lesser General Public License as
11 * published by the Free Software Foundation; either version 2.1 of
12 * the License, or (at your option) any later version.
13 *
14 * ModeShape is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
18 *
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this software; if not, write to the Free
21 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
23 */
24 package org.modeshape.graph.search;
25
26 import org.modeshape.graph.ExecutionContext;
27 import org.modeshape.graph.observe.Observer;
28 import org.modeshape.graph.property.DateTime;
29 import org.modeshape.graph.request.processor.RequestProcessor;
30
31 /**
32 * The processor that is created by the provider whenever a logical set of activities needs to be performed.
33 */
34 public abstract class SearchEngineProcessor extends RequestProcessor {
35
36 protected boolean rollback = false;
37
38 /**
39 * @param sourceName
40 * @param context
41 * @param observer
42 * @param now
43 */
44 protected SearchEngineProcessor( String sourceName,
45 ExecutionContext context,
46 Observer observer,
47 DateTime now ) {
48 super(sourceName, context, observer, now);
49 }
50
51 public void markForRollback() {
52 rollback = true;
53 }
54
55 /**
56 * {@inheritDoc}
57 *
58 * @see org.modeshape.graph.request.processor.RequestProcessor#close()
59 */
60 @Override
61 public void close() {
62 try {
63 if (rollback) rollback();
64 else commit();
65 } finally {
66 // publish any changes to the observer ...
67 super.close();
68 }
69 }
70
71 /**
72 * Subclasses should implement this method to throw away any work that has been done with this processor.
73 */
74 protected abstract void rollback();
75
76 /**
77 * Subclasses should implement this method to commit and save any work that has been done with this processor.
78 */
79 protected abstract void commit();
80 }