01: /**********************************************************************
02: Copyright (c) 2007 Erik Bengtson and others. All rights reserved.
03: Licensed under the Apache License, Version 2.0 (the "License");
04: you may not use this file except in compliance with the License.
05: You may obtain a copy of the License at
06:
07: http://www.apache.org/licenses/LICENSE-2.0
08:
09: Unless required by applicable law or agreed to in writing, software
10: distributed under the License is distributed on an "AS IS" BASIS,
11: WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12: See the License for the specific language governing permissions and
13: limitations under the License.
14:
15: Contributors:
16: ...
17: **********************************************************************/package org.jpox;
18:
19: import java.util.Map;
20:
21: /**
22: * Factory for connections to the datastore.
23: * To be implemented by all StoreManagers.
24: *
25: * @version $Revision: 1.13 $
26: */
27: public interface ConnectionFactory {
28: /**
29: * Obtain a connection from the Factory. The connection will be enlisted within the {@link org.jpox.Transaction}
30: * associated to the {@link org.jpox.ObjectManager} <code>om</code> if "enlist" is set to true.
31: * @param om the {@link org.jpox.ObjectManager} or null
32: * @param options Any options for then creating the connection
33: * @return the {@link org.jpox.ManagedConnection}
34: */
35: ManagedConnection getConnection(ObjectManager om, Map options);
36:
37: /**
38: * Create the ManagedConnection.
39: * Only used by ConnectionManager so do not call this.
40: * @param om ObjectManager (if any)
41: * @param transactionOptions the Transaction options this connection will be enlisted to, null if non existent
42: * @return The ManagedConnection.
43: */
44: ManagedConnection createManagedConnection(ObjectManager om,
45: Map transactionOptions);
46: }
|