01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * published by the Free Software Foundation; either version 2.1 of
10: * the License, or (at your option) any later version.
11: *
12: * This software is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this software; if not, write to the Free
19: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21: */
22: package javax.resource.spi;
23:
24: import java.io.Serializable;
25:
26: import javax.resource.ResourceException;
27:
28: /**
29: * The ConnectionManager interface provides the hook which allows a resource
30: * adapter to pass a connection to the Application Server. The Application
31: * Server implements this interface in order to control QoS services to the
32: * resource adapter for connection pools.
33: */
34:
35: public interface ConnectionManager extends Serializable {
36: /**
37: * Gets called by the resource adapter's connection factory. The resource adapter
38: * uses this method to pass its managed connection factory to the connection manager.
39: *
40: * @param mcf the managed connection factory
41: * @param cxRequestInfo the connection request info
42: * @return the connection handle
43: * @throws ResourceException for an generic error
44: * @throws ApplicationServerInternalException for problems in the application server
45: * @throws SecurityException for security problems
46: * @throws ResourceAllocationException for problems allocating resources
47: * @throws ResourceAdapterInternalException for errors from the resource adapter
48: */
49: public Object allocateConnection(ManagedConnectionFactory mcf,
50: ConnectionRequestInfo cxRequestInfo)
51: throws ResourceException;
52: }
|