Summary: Methods | [Expand All]

Also: SpringBeans

public interface

FactoryBean

org.springframework.beans.factory.FactoryBean<T>

Known Indirect Subclasses

AbstractEntityManagerFactoryBean, AbstractFactoryBean<T>, AbstractServiceLoaderBasedFactoryBean, AbstractSessionFactoryBean, AbstractSingletonProxyFactoryBean, AnnotationSessionFactoryBean, BeanReferenceFactoryBean, BurlapProxyFactoryBean, CacheProxyFactoryBean, CommonsLogFactoryBean, ConcurrentCacheFactoryBean<K, V>, ConnectorServerFactoryBean, ConversionServiceFactoryBean, EhCacheFactoryBean, EhCacheManagerFactoryBean, and 65 others.

AbstractEntityManagerFactoryBean	Abstract `FactoryBean` that creates a local JPA javax.persistence.EntityManagerFactory instance within a Spring application context.
AbstractFactoryBean<T>	Simple template superclass for `FactoryBean` implementations that creates a singleton or a prototype object, depending on a flag.
AbstractServiceLoaderBasedFactoryBean	Abstract base class for FactoryBeans operating on the JDK 1.6 java.util.ServiceLoader facility.
AbstractSessionFactoryBean	Abstract `FactoryBean` that creates a Hibernate org.hibernate.SessionFactory within a Spring application context, providing general infrastructure not related to Hibernate's specific configuration API.
AbstractSingletonProxyFactoryBean	Convenient proxy factory bean superclass for proxy factory beans that create only singletons.
AnnotationSessionFactoryBean	Subclass of Spring's standard LocalSessionFactoryBean for Hibernate, supporting JDK 1.5+ annotation metadata for mappings.
BeanReferenceFactoryBean	FactoryBean that exposes an arbitrary target bean under a different name.
BurlapProxyFactoryBean	`FactoryBean` for Burlap proxies.
CacheProxyFactoryBean	Proxy factory bean for simplified declarative caching handling.
CommonsLogFactoryBean	Factory bean for commons-logging org.apache.commons.logging.Log instances.
ConcurrentCacheFactoryBean<K, V>	Factory bean for easy configuration of `ConcurrentCache` through Spring.
ConnectorServerFactoryBean	`FactoryBean` that creates a JSR-160 JMXConnectorServer, optionally registers it with the MBeanServer and then starts it.
ConversionServiceFactoryBean	A factory providing convenient access to a ConversionService configured with converters appropriate for most environments.
EhCacheFactoryBean	`FactoryBean` that creates a named EHCache net.sf.ehcache.Cache instance (or a decorator that implements the net.sf.ehcache.Ehcache interface), representing a cache region within an EHCache net.sf.ehcache.CacheManager.
EhCacheManagerFactoryBean	`FactoryBean` that exposes an EHCache net.sf.ehcache.CacheManager instance (independent or shared), configured from a specified config location.
EmbeddedDatabaseFactoryBean	A subclass of `EmbeddedDatabaseFactory` that implements `FactoryBean` for registration as a Spring bean.
FieldRetrievingFactoryBean	`FactoryBean` which retrieves a static or non-static field value.
FilterDefinitionFactoryBean	Convenient FactoryBean for defining Hibernate FilterDefinitions.
FormattingConversionServiceFactoryBean	A factory providing convenient access to a `FormattingConversionService` configured with converters and formatters for common types such as numbers and datetimes.
FreeMarkerConfigurationFactoryBean	Factory bean that creates a FreeMarker Configuration and provides it as bean reference.
HessianProxyFactoryBean	`FactoryBean` for Hessian proxies.
HttpInvokerProxyFactoryBean	`FactoryBean` for HTTP invoker proxies.
JaxRpcPortProxyFactoryBean	This class is deprecated. in favor of JAX-WS support in `org.springframework.remoting.jaxws`
JaxWsPortProxyFactoryBean	`FactoryBean` for a specific port of a JAX-WS service.
JmsInvokerProxyFactoryBean	FactoryBean for JMS invoker proxies.
JndiObjectFactoryBean	`FactoryBean` that looks up a JNDI object.
JndiRmiProxyFactoryBean	`FactoryBean` for RMI proxies from JNDI.
ListFactoryBean	Simple factory for shared List instances.
LocalConnectionFactoryBean	`FactoryBean` that creates a local JCA connection factory in "non-managed" mode (as defined by the Java Connector Architecture specification).
LocalContainerEntityManagerFactoryBean	`FactoryBean` that creates a JPA javax.persistence.EntityManagerFactory according to JPA's standard container bootstrap contract.
LocalEntityManagerFactoryBean	`FactoryBean` that creates a JPA javax.persistence.EntityManagerFactory according to JPA's standard standalone bootstrap contract.
LocalJaxRpcServiceFactoryBean	This class is deprecated. in favor of JAX-WS support in `org.springframework.remoting.jaxws`
LocalJaxWsServiceFactoryBean	`FactoryBean` for locally defined JAX-WS Service references.
LocalPersistenceManagerFactoryBean	`FactoryBean` that creates a JDO javax.jdo.PersistenceManagerFactory.
LocalSessionFactoryBean	`FactoryBean` that creates a Hibernate org.hibernate.SessionFactory.
LocalStatelessSessionProxyFactoryBean	Convenient `FactoryBean` for local Stateless Session Bean (SLSB) proxies.
MBeanProxyFactoryBean	Creates a proxy to a managed resource running either locally or remotely.
MBeanServerConnectionFactoryBean	`FactoryBean` that creates a JMX 1.2 `MBeanServerConnection` to a remote `MBeanServer` exposed via a `JMXServerConnector`.
MBeanServerFactoryBean	`FactoryBean` that obtains an javax.management.MBeanServer reference through the standard JMX 1.2 javax.management.MBeanServerFactory API (which is available on JDK 1.5 or as part of a JMX 1.2 provider).
MapFactoryBean	Simple factory for shared Map instances.
MethodInvokingFactoryBean	`FactoryBean` which returns a value which is the result of a static or instance method invocation.
MethodInvokingJobDetailFactoryBean	`FactoryBean` that exposes a org.quartz.JobDetail object which delegates job execution to a specified (static or non-static) method.
MethodInvokingTimerTaskFactoryBean	This class is deprecated. as of Spring 3.0, in favor of the `scheduling.concurrent` package which is based on Java 5's `java.util.concurrent.ExecutorService`
MethodLocatingFactoryBean	`FactoryBean` implementation that locates a Method on a specified bean.
ObjectFactoryCreatingFactoryBean	A `FactoryBean` implementation that returns a value which is an `ObjectFactory` that in turn returns a bean sourced from a `BeanFactory`.
PropertiesFactoryBean	Allows for making a properties file from a classpath location available as Properties instance in a bean factory.
PropertyPathFactoryBean	`FactoryBean` that evaluates a property path on a given target object.
ProviderCreatingFactoryBean	A `FactoryBean` implementation that returns a value which is a JSR-330 javax.inject.Provider that in turn returns a bean sourced from a `BeanFactory`.
ProxyFactoryBean	`FactoryBean` implementation that builds an AOP proxy based on beans in Spring `BeanFactory`.
ResourceAdapterFactoryBean	`FactoryBean` that bootstraps the specified JCA 1.5 javax.resource.spi.ResourceAdapter, starting it with a local javax.resource.spi.BootstrapContext and exposing it for bean references.
RmiProxyFactoryBean	`FactoryBean` for RMI proxies, supporting both conventional RMI services and RMI invokers.
RmiRegistryFactoryBean	`FactoryBean` that locates a java.rmi.registry.Registry and exposes it for bean references.
ScheduledExecutorFactoryBean	`FactoryBean` that sets up a JDK 1.5 java.util.concurrent.ScheduledExecutorService (by default: a java.util.concurrent.ScheduledThreadPoolExecutor) and exposes it for bean references.
SchedulerFactoryBean	`FactoryBean` that creates and configures a Quartz org.quartz.Scheduler, manages its lifecycle as part of the Spring application context, and exposes the Scheduler as bean reference for dependency injection.
ScopedProxyFactoryBean	Convenient proxy factory bean for scoped objects.
ServiceFactoryBean	`FactoryBean` that exposes the 'primary' service for the configured service class, obtained through the JDK 1.6 java.util.ServiceLoader facility.
ServiceListFactoryBean	`FactoryBean` that exposes all services for the configured service class, represented as a List of service objects, obtained through the JDK 1.6 java.util.ServiceLoader facility.
ServiceLoaderFactoryBean	`FactoryBean` that exposes the JDK 1.6 java.util.ServiceLoader for the configured service class.
ServiceLocatorFactoryBean	A `FactoryBean` implementation that takes an interface which must have one or more methods with the signatures `MyType xxx()` or `MyType xxx(MyIdType id)` (typically, `MyService getService()` or `MyService getService(String id)`) and creates a dynamic proxy which implements that interface, delegating to an underlying `BeanFactory`.
ServletContextAttributeFactoryBean	`FactoryBean` that fetches a specific, existing ServletContext attribute.
ServletContextFactoryBean	This class is deprecated. as of Spring 3.0, since "servletContext" is now available as a default bean in every WebApplicationContext
ServletContextParameterFactoryBean	`FactoryBean` that retrieves a specific ServletContext init parameter (that is, a "context-param" defined in `web.xml`).
SetFactoryBean	Simple factory for shared Set instances.
SharedEntityManagerBean	`FactoryBean` that exposes a shared JPA javax.persistence.EntityManager reference for a given EntityManagerFactory.
SimpleHttpServerFactoryBean	`FactoryBean` that creates a simple HTTP server, based on the HTTP server that is included in Sun's JRE 1.6.
SimpleRemoteStatelessSessionProxyFactoryBean	Convenient `FactoryBean` for remote SLSB proxies.
SmartFactoryBean<T>	Extension of the `FactoryBean` interface.
SortedResourcesFactoryBean	`FactoryBean` implementation that takes a list of location Strings and creates a sorted array of `Resource` instances.
SpringPersistenceManagerProxyBean	Proxy that implements the javax.jdo.PersistenceManager interface, delegating to the current thread-bound PersistenceManager (the Spring-managed transactional PersistenceManager or the single OpenPersistenceManagerInView PersistenceManager, if any) on each invocation.
SqlMapClientFactoryBean	`FactoryBean` that creates an iBATIS com.ibatis.sqlmap.client.SqlMapClient.
StandardPersistenceManagerProxyBean	Proxy that implements the javax.jdo.PersistenceManager interface, delegating to a thread-bound PersistenceManager on each invocation - as defined by the JDO 2.1 specification.
TaskExecutorFactoryBean	FactoryBean for creating ThreadPoolTaskExecutor instances, choosing between the standard concurrent and the backport-concurrent variant.
ThreadPoolExecutorFactoryBean	JavaBean that allows for configuring a JDK 1.5 java.util.concurrent.ThreadPoolExecutor in bean style (through its "corePoolSize", "maxPoolSize", "keepAliveSeconds", "queueCapacity" properties) and exposing it as a bean reference of its native java.util.concurrent.ExecutorService type.
TimerFactoryBean	This class is deprecated. as of Spring 3.0, in favor of the `scheduling.concurrent` package which is based on Java 5's `java.util.concurrent.ExecutorService`
TimerManagerFactoryBean	`FactoryBean` that retrieves a CommonJ commonj.timers.TimerManager and exposes it for bean references.
TransactionAwarePersistenceManagerFactoryProxy	Proxy for a target JDO javax.jdo.PersistenceManagerFactory, returning the current thread-bound PersistenceManager (the Spring-managed transactional PersistenceManager or the single OpenPersistenceManagerInView PersistenceManager) on `getPersistenceManager()`, if any.
TransactionProxyFactoryBean	Proxy factory bean for simplified declarative transaction handling.
VelocityEngineFactoryBean	Factory bean that configures a VelocityEngine and provides it as bean reference.
WebSphereMBeanServerFactoryBean	`FactoryBean` that obtains a WebSphere javax.management.MBeanServer reference through WebSphere's proprietary `AdminServiceFactory` API, available on WebSphere 5.1 and higher.
XmlOptionsFactoryBean	`FactoryBean` that configures an XMLBeans `XmlOptions` object and provides it as a bean reference.

Class Overview

Interface to be implemented by objects used within a BeanFactory which are themselves factories. If a bean implements this interface, it is used as a factory for an object to expose, not directly as a bean instance that will be exposed itself.

NB: A bean that implements this interface cannot be used as a normal bean. A FactoryBean is defined in a bean style, but the object exposed for bean references (getObject() is always the object that it creates.

FactoryBeans can support singletons and prototypes, and can either create objects lazily on demand or eagerly on startup. The SmartFactoryBean interface allows for exposing more fine-grained behavioral metadata.

This interface is heavily used within the framework itself, for example for the AOP ProxyFactoryBean or the JndiObjectFactoryBean. It can be used for application components as well; however, this is not common outside of infrastructure code.

NOTE: FactoryBean objects participate in the containing BeanFactory's synchronization of bean creation. There is usually no need for internal synchronization other than for purposes of lazy initialization within the FactoryBean itself (or the like).

Summary

Public Methods
abstract T	getObject() Return an instance (possibly shared or independent) of the object managed by this factory.
abstract Class<?>	getObjectType() Return the type of object that this FactoryBean creates, or `null` if not known in advance.
abstract boolean	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.

Public Methods

public abstract T getObject ()

Also: SpringBeans

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

an instance of the bean (can be null)

Throws

Exception	in case of creation errors

public abstract Class<?> getObjectType ()

Also: SpringBeans

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

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

public abstract boolean isSingleton ()

Also: SpringBeans

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 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.

Returns

whether the exposed object is a singleton

Interfaces

Classes

Exceptions

FactoryBean

Class Overview

See Also

Summary

Public Methods

public abstract T getObject ()

Returns

Throws

See Also

public abstract Class<?> getObjectType ()

Returns

See Also

public abstract boolean isSingleton ()

Returns

See Also