Spring Framework 6.1.4 · org.springframework.jca.support.ResourceAdapterFactoryBean

Modifier and Type	Field and Description
private BootstrapContext	bootstrapContext
private ResourceAdapter	resourceAdapter
private WorkManager	workManager
private XATerminator	xaTerminator

Access	Constructor and Description
public	ResourceAdapterFactoryBean()

Method Summary

Modifier and Type	Method and Description
public void	afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Builds the BootstrapContext and starts the ResourceAdapter with it.
public void	destroy() Implements org.springframework.beans.factory.DisposableBean.destroy. Stops the ResourceAdapter.
public ResourceAdapter	getObject() Implements org.springframework.beans.factory.FactoryBean.getObject. Return an instance (possibly shared or independent) of the object managed by this factory.
public Class<? extends ResourceAdapter>	getObjectType() Implements org.springframework.beans.factory.FactoryBean.getObjectType. Return the type of object that this FactoryBean creates, or `null` if not known in advance.
public boolean	isSingleton() Overrides default org.springframework.beans.factory.FactoryBean.isSingleton. Is the object managed by this factory a singleton?
public void	setBootstrapContext(BootstrapContext bootstrapContext) Specify the JCA BootstrapContext to use for starting the ResourceAdapter.
public void	setResourceAdapter(ResourceAdapter resourceAdapter) Specify the target JCA ResourceAdapter, passed in as configured instance which hasn't been started yet.
public void	setResourceAdapterClass(Class<? extends ResourceAdapter> resourceAdapterClass) Specify the target JCA ResourceAdapter as class, to be instantiated with its default configuration.
public void	setWorkManager(WorkManager workManager) Specify the JCA WorkManager to use for bootstrapping the ResourceAdapter.
public void	setXaTerminator(XATerminator xaTerminator) Specify the JCA XATerminator to use for bootstrapping the ResourceAdapter.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

bootstrapContext	back to summary
private BootstrapContext bootstrapContext Annotations @Nullable

resourceAdapter	back to summary
private ResourceAdapter resourceAdapter Annotations @Nullable

workManager	back to summary
private WorkManager workManager Annotations @Nullable

xaTerminator	back to summary
private XATerminator xaTerminator Annotations @Nullable

ResourceAdapterFactoryBean	back to summary
public ResourceAdapterFactoryBean()

Method Detail

afterPropertiesSet back to summary

afterPropertiesSet	back to summary
public void afterPropertiesSet() throws ResourceException Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Builds the BootstrapContext and starts the ResourceAdapter with it. Annotations @Override See Also `jakarta.resource.spi.ResourceAdapter#start(jakarta.resource.spi.BootstrapContext)`

public void afterPropertiesSet() throws ResourceException

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Builds the BootstrapContext and starts the ResourceAdapter with it.

Annotations

@Override

destroy back to summary

destroy	back to summary
public void destroy() Implements org.springframework.beans.factory.DisposableBean.destroy. Stops the ResourceAdapter. Annotations @Override See Also `jakarta.resource.spi.ResourceAdapter#stop()`

public void destroy()

Implements org.springframework.beans.factory.DisposableBean.destroy.

Stops the ResourceAdapter.

Annotations

@Override

getObject back to summary

getObject	back to summary
public ResourceAdapter getObject() Implements org.springframework.beans.factory.FactoryBean.getObject. Doc from org.springframework.beans.factory.FactoryBean.getObject. Return an instance (possibly shared or independent) of the object managed by this factory. As with a `BeanFactory`, this allows support for both the Singleton and Prototype design pattern. If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding `FactoryBeanNotInitializedException`. As of Spring 2.0, FactoryBeans are allowed to return `null` objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate. Returns:ResourceAdapter an instance of the bean (can be `null`) Annotations @Override @Nullable

public ResourceAdapter getObject()

Implements org.springframework.beans.factory.FactoryBean.getObject.

Doc from org.springframework.beans.factory.FactoryBean.getObject.

Return an instance (possibly shared or independent) of the object managed by this factory.

As with a BeanFactory, this allows support for both the Singleton and Prototype design pattern.

If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding FactoryBeanNotInitializedException.

As of Spring 2.0, FactoryBeans are allowed to return null objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate.

Returns:ResourceAdapter

an instance of the bean (can be null)

Annotations

@Override
@Nullable

getObjectType back to summary

getObjectType	back to summary
public Class<? extends ResourceAdapter> getObjectType() Implements org.springframework.beans.factory.FactoryBean.getObjectType. Doc from org.springframework.beans.factory.FactoryBean.getObjectType. Return the type of object that this FactoryBean creates, or `null` if not known in advance. This allows one to check for specific types of beans without instantiating objects, for example on autowiring. In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too. This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available. Note Autowiring will simply ignore FactoryBeans that return `null` here. Therefore, it is highly recommended to implement this method properly, using the current state of the FactoryBean. Returns:Class<? extends ResourceAdapter> the type of object that this FactoryBean creates, or `null` if not known at the time of the call Annotations @Override

public Class<? extends ResourceAdapter> getObjectType()

Implements org.springframework.beans.factory.FactoryBean.getObjectType.

Doc from org.springframework.beans.factory.FactoryBean.getObjectType.

Return the type of object that this FactoryBean creates, or null if not known in advance.

This allows one to check for specific types of beans without instantiating objects, for example on autowiring.

In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.

This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.

Note

Autowiring will simply ignore FactoryBeans that return null here. Therefore, it is highly recommended to implement this method properly, using the current state of the FactoryBean.

Returns:Class<? extends ResourceAdapter>

the type of object that this FactoryBean creates, or null if not known at the time of the call

Annotations

@Override

isSingleton back to summary

isSingleton	back to summary
public boolean isSingleton() Overrides default org.springframework.beans.factory.FactoryBean.isSingleton. Doc from org.springframework.beans.factory.FactoryBean.isSingleton. Is the object managed by this factory a singleton? That is, will `getObject()` always return the same object (a reference that can be cached)? Note If a FactoryBean indicates to hold a singleton object, the object returned from `getObject()` might get cached by the owning BeanFactory. Hence, do not return `true` unless the FactoryBean always exposes the same reference. The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there. Note This method returning `false` does not necessarily indicate that returned objects are independent instances. An implementation of the extended `SmartFactoryBean` interface may explicitly indicate independent instances through its `SmartFactoryBean#isPrototype()` method. Plain `FactoryBean` implementations which do not implement this extended interface are simply assumed to always return independent instances if the `isSingleton()` implementation returns `false`. The default implementation returns `true`, since a `FactoryBean` typically manages a singleton instance. Returns:boolean whether the exposed object is a singleton Annotations @Override

public boolean isSingleton()

Overrides default org.springframework.beans.factory.FactoryBean.isSingleton.

Doc from org.springframework.beans.factory.FactoryBean.isSingleton.

Is the object managed by this factory a singleton? That is, will getObject() always return the same object (a reference that can be cached)?

Note

If a FactoryBean indicates to hold a singleton object, the object returned from getObject() might get cached by the owning BeanFactory. Hence, do not return true unless the FactoryBean always exposes the same reference.

The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.

Note

This method returning false does not necessarily indicate that returned objects are independent instances. An implementation of the extended SmartFactoryBean interface may explicitly indicate independent instances through its SmartFactoryBean#isPrototype() method. Plain FactoryBean implementations which do not implement this extended interface are simply assumed to always return independent instances if the isSingleton() implementation returns false.

The default implementation returns true, since a FactoryBean typically manages a singleton instance.

Returns:boolean

whether the exposed object is a singleton

Annotations

@Override

setBootstrapContext back to summary

setBootstrapContext	back to summary
public void setBootstrapContext(BootstrapContext bootstrapContext) Specify the JCA BootstrapContext to use for starting the ResourceAdapter. Alternatively, you can specify the individual parts (such as the JCA WorkManager) as individual references. See Also `setWorkManager`, `setXaTerminator`

public void setBootstrapContext(BootstrapContext bootstrapContext)

Specify the JCA BootstrapContext to use for starting the ResourceAdapter.

Alternatively, you can specify the individual parts (such as the JCA WorkManager) as individual references.

See Also: setWorkManager, setXaTerminator

setResourceAdapter	back to summary
public void setResourceAdapter(ResourceAdapter resourceAdapter) Specify the target JCA ResourceAdapter, passed in as configured instance which hasn't been started yet. This will typically happen as an inner bean definition, configuring the ResourceAdapter instance through its vendor-specific bean properties.

setResourceAdapterClass back to summary

setResourceAdapterClass	back to summary
public void setResourceAdapterClass(Class<? extends ResourceAdapter> resourceAdapterClass) Specify the target JCA ResourceAdapter as class, to be instantiated with its default configuration. Alternatively, specify a pre-configured ResourceAdapter instance through the "resourceAdapter" property. See Also `setResourceAdapter`

public void setResourceAdapterClass(Class<? extends ResourceAdapter> resourceAdapterClass)

Specify the target JCA ResourceAdapter as class, to be instantiated with its default configuration.

Alternatively, specify a pre-configured ResourceAdapter instance through the "resourceAdapter" property.

See Also: setResourceAdapter

setWorkManager back to summary

setWorkManager	back to summary
public void setWorkManager(WorkManager workManager) Specify the JCA WorkManager to use for bootstrapping the ResourceAdapter. See Also `setBootstrapContext`

public void setWorkManager(WorkManager workManager)

Specify the JCA WorkManager to use for bootstrapping the ResourceAdapter.

See Also: setBootstrapContext

setXaTerminator back to summary

setXaTerminator	back to summary
public void setXaTerminator(XATerminator xaTerminator) Specify the JCA XATerminator to use for bootstrapping the ResourceAdapter. See Also `setBootstrapContext`

public void setXaTerminator(XATerminator xaTerminator)

Specify the JCA XATerminator to use for bootstrapping the ResourceAdapter.

See Also: setBootstrapContext

public Class ResourceAdapterFactoryBean

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail