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 javax.resource.ResourceException;
25: import javax.resource.spi.endpoint.MessageEndpointFactory;
26: import javax.transaction.xa.XAResource;
27:
28: /**
29: * Operations for lifecycle management and message endpoint configuration.
30: * Implementations of this interface must be javabeans
31: */
32: public interface ResourceAdapter {
33: /**
34: * Used to bootstrap the resource adapter
35: *
36: * @param ctx the bootstrap context
37: * @throws ResourceAdapterInternalException for a bootstrap failure
38: */
39: void start(BootstrapContext ctx)
40: throws ResourceAdapterInternalException;
41:
42: /**
43: * Used to stop the resource adapter
44: */
45: void stop();
46:
47: /**
48: * Activates the endpoint factory
49: *
50: * @param endpointFactory the endpoint factory
51: * @param spec the activation spec
52: * @throws ResourceException for a generic error
53: * @throws NotSupportedException for incorrect activation
54: */
55: void endpointActivation(MessageEndpointFactory endpointFactory,
56: ActivationSpec spec) throws ResourceException;
57:
58: /**
59: * Deactivates the endpoint
60: *
61: * @param endpointFactory the endpoint factory
62: * @param spec the activation spec
63: */
64: void endpointDeactivation(MessageEndpointFactory endpointFactory,
65: ActivationSpec spec);
66:
67: /**
68: * Called by the application server during recovery
69: *
70: * @param specs the activation specs
71: * @return the XAResources used to perform the recovery
72: * @throws ResourceException for a generic error
73: */
74: XAResource[] getXAResources(ActivationSpec[] specs)
75: throws ResourceException;
76: }
|