001: /*
002: * Copyright 2002-2007 the original author or authors.
003: *
004: * Licensed under the Apache License, Version 2.0 (the "License");
005: * you may not use this file except in compliance with the License.
006: * You may obtain a copy of the License at
007: *
008: * http://www.apache.org/licenses/LICENSE-2.0
009: *
010: * Unless required by applicable law or agreed to in writing, software
011: * distributed under the License is distributed on an "AS IS" BASIS,
012: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013: * See the License for the specific language governing permissions and
014: * limitations under the License.
015: */
016:
017: package org.springframework.jca.support;
018:
019: import javax.resource.ResourceException;
020: import javax.resource.spi.BootstrapContext;
021: import javax.resource.spi.ResourceAdapter;
022: import javax.resource.spi.XATerminator;
023: import javax.resource.spi.work.WorkManager;
024:
025: import org.springframework.beans.BeanUtils;
026: import org.springframework.beans.factory.DisposableBean;
027: import org.springframework.beans.factory.FactoryBean;
028: import org.springframework.beans.factory.InitializingBean;
029: import org.springframework.util.Assert;
030:
031: /**
032: * {@link org.springframework.beans.factory.FactoryBean} that bootstraps
033: * the specified JCA 1.5 {@link javax.resource.spi.ResourceAdapter},
034: * starting it with a local {@link javax.resource.spi.BootstrapContext}
035: * and exposing it for bean references. It will also stop the ResourceAdapter
036: * on context shutdown. This corresponds to 'non-managed' bootstrap in a
037: * local environment, according to the JCA 1.5 specification.
038: *
039: * <p>This is essentially an adapter for bean-style bootstrapping of a
040: * JCA ResourceAdapter, allowing the BootstrapContext or its elements
041: * (such as the JCA WorkManager) to be specified through bean properties.
042: *
043: * @author Juergen Hoeller
044: * @since 2.0.3
045: * @see #setResourceAdapter
046: * @see #setBootstrapContext
047: * @see #setWorkManager
048: * @see javax.resource.spi.ResourceAdapter#start(javax.resource.spi.BootstrapContext)
049: * @see javax.resource.spi.ResourceAdapter#stop()
050: */
051: public class ResourceAdapterFactoryBean implements FactoryBean,
052: InitializingBean, DisposableBean {
053:
054: private ResourceAdapter resourceAdapter;
055:
056: private BootstrapContext bootstrapContext;
057:
058: private WorkManager workManager;
059:
060: private XATerminator xaTerminator;
061:
062: /**
063: * Specify the target JCA ResourceAdapter as class, to be instantiated
064: * with its default configuration.
065: * <p>Alternatively, specify a pre-configured ResourceAdapter instance
066: * through the "resourceAdapter" property.
067: * @see #setResourceAdapter
068: */
069: public void setResourceAdapterClass(Class resourceAdapterClass) {
070: Assert
071: .isAssignable(ResourceAdapter.class,
072: resourceAdapterClass);
073: this .resourceAdapter = (ResourceAdapter) BeanUtils
074: .instantiateClass(resourceAdapterClass);
075: }
076:
077: /**
078: * Specify the target JCA ResourceAdapter, passed in as configured instance
079: * which hasn't been started yet. This will typically happen as an
080: * inner bean definition, configuring the ResourceAdapter instance
081: * through its vendor-specific bean properties.
082: */
083: public void setResourceAdapter(ResourceAdapter resourceAdapter) {
084: this .resourceAdapter = resourceAdapter;
085: }
086:
087: /**
088: * Specify the JCA BootstrapContext to use for starting the ResourceAdapter.
089: * <p>Alternatively, you can specify the individual parts (such as the
090: * JCA WorkManager) as individual references.
091: * @see #setWorkManager
092: * @see #setXaTerminator
093: */
094: public void setBootstrapContext(BootstrapContext bootstrapContext) {
095: this .bootstrapContext = bootstrapContext;
096: }
097:
098: /**
099: * Specify the JCA WorkManager to use for bootstrapping the ResourceAdapter.
100: * @see #setBootstrapContext
101: */
102: public void setWorkManager(WorkManager workManager) {
103: this .workManager = workManager;
104: }
105:
106: /**
107: * Specify the JCA XATerminator to use for bootstrapping the ResourceAdapter.
108: * @see #setBootstrapContext
109: */
110: public void setXaTerminator(XATerminator xaTerminator) {
111: this .xaTerminator = xaTerminator;
112: }
113:
114: /**
115: * Builds the BootstrapContext and starts the ResourceAdapter with it.
116: * @see javax.resource.spi.ResourceAdapter#start(javax.resource.spi.BootstrapContext)
117: */
118: public void afterPropertiesSet() throws ResourceException {
119: if (this .resourceAdapter == null) {
120: throw new IllegalArgumentException(
121: "'resourceAdapter' or 'resourceAdapterClass' is required");
122: }
123: if (this .bootstrapContext == null) {
124: this .bootstrapContext = new SimpleBootstrapContext(
125: this .workManager, this .xaTerminator);
126: }
127: this .resourceAdapter.start(this .bootstrapContext);
128: }
129:
130: public Object getObject() {
131: return this .resourceAdapter;
132: }
133:
134: public Class getObjectType() {
135: return (this .resourceAdapter != null ? this .resourceAdapter
136: .getClass() : ResourceAdapter.class);
137: }
138:
139: public boolean isSingleton() {
140: return true;
141: }
142:
143: /**
144: * Stops the ResourceAdapter.
145: * @see javax.resource.spi.ResourceAdapter#stop()
146: */
147: public void destroy() {
148: this.resourceAdapter.stop();
149: }
150:
151: }
|