01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one
03: * or more contributor license agreements. See the NOTICE file
04: * distributed with this work for additional information
05: * regarding copyright ownership. The ASF licenses this file
06: * to you under the Apache License, Version 2.0 (the
07: * "License"); you may not use this file except in compliance
08: * with the License. You may obtain a copy of the License at
09: *
10: * http://www.apache.org/licenses/LICENSE-2.0
11: *
12: * Unless required by applicable law or agreed to in writing,
13: * software distributed under the License is distributed on an
14: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15: * KIND, either express or implied. See the License for the
16: * specific language governing permissions and limitations
17: * under the License.
18: */
19: package org.apache.openjpa.event;
20:
21: import org.apache.openjpa.lib.util.Closeable;
22:
23: /**
24: * An entity that wishes to be notified when Brokers
25: * associated with remote BrokerFactories commit.
26: * A RemoteCommitListener <b>is not</b> notified of commits that originated
27: * with a Broker created from the BrokerFactory that it is
28: * registered with. (Of course, if a listener is registered with multiple
29: * factories, this situation might be complicated a bit.)
30: * Usage:
31: * <code><pre> import org.apache.openjpa.event.*;
32: * import org.apache.openjpa.conf.*;
33: *
34: * {@link org.apache.openjpa.conf.OpenJPAConfiguration} conf = factory.getConfiguraiton ();
35: * RemoteCommitListener l = new RemoteCommitListener () {
36: * public void afterCommit ({@link RemoteCommitEvent} e) {
37: * // update a Swing widget when remote brokers make
38: * // changes to reference data }
39: * public void close () { } };
40: * conf.getRemoteCommitEventManager ().addListener (l);
41: * </pre></code>
42: *
43: *
44: * @author Patrick Linskey
45: * @since 0.2.5.0
46: */
47: public interface RemoteCommitListener extends Closeable {
48:
49: /**
50: * Notification that a transaction associated with a different
51: * BrokerFactory has successfully committed.
52: */
53: public void afterCommit(RemoteCommitEvent event);
54:
55: /**
56: * Free the resources used by this listener.
57: */
58: public void close();
59: }
|