org.springframework.orm.toplink
Class LocalSessionFactoryBean

java.lang.Object
  org.springframework.orm.toplink.LocalSessionFactory
      org.springframework.orm.toplink.LocalSessionFactoryBean

All Implemented Interfaces:

DisposableBean, FactoryBean, InitializingBean

public class LocalSessionFactoryBean
extends LocalSessionFactory
implements FactoryBean, InitializingBean, DisposableBean

Factory bean that configures a TopLink SessionFactory and provides it as bean reference. This is the usual way to define a TopLink SessionFactory in a Spring application context, allowing to pass it to TopLink DAOs as bean reference.

See the base class LocalSessionFactory for configuration details.

If your DAOs expect to receive a raw TopLink Session, consider defining a TransactionAwareSessionAdapter in front of this bean. This adapter will provide a TopLink Session rather than a SessionFactory as bean reference. Your DAOs can then, for example, access the currently active Session and UnitOfWork via Session.getActiveSession() and Session.getActiveUnitOfWork(), respectively. Note that you can still access the SessionFactory too, by defining a bean reference that points directly at the LocalSessionFactoryBean.

Since:

1.2

Author:

Juergen Hoeller

See Also:

LocalSessionFactory, TransactionAwareSessionAdapter

Field Summary

Fields inherited from class org.springframework.orm.toplink.LocalSessionFactory

DEFAULT_SESSION_NAME, DEFAULT_SESSIONS_XML, logger

Constructor Summary

LocalSessionFactoryBean()

Method Summary

void	afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
void	destroy() Invoked by a BeanFactory on destruction of a singleton.
Object	getObject() Return an instance (possibly shared or independent) of the object managed by this factory.
Class	getObjectType() Return the type of object that this FactoryBean creates, or null if not known in advance.
boolean	isSingleton() Is the bean managed by this factory a singleton or a prototype?

Methods inherited from class org.springframework.orm.toplink.LocalSessionFactory

createSessionFactory, getSessionManager, loadDatabaseSession, newSessionFactory, setConfigLocation, setDatabaseLogin, setDatabasePlatform, setDataSource, setSessionClassLoader, setSessionLog, setSessionName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LocalSessionFactoryBean

public LocalSessionFactoryBean()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws oracle.toplink.exceptions.TopLinkException

Description copied from interface: InitializingBean

Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

oracle.toplink.exceptions.TopLinkException

getObject

public Object getObject()

Description copied from interface: FactoryBean

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 method returns null, the factory will consider the FactoryBean as not fully initialized and throw a corresponding FactoryBeanNotInitializedException.

Specified by:

getObject in interface FactoryBean

Returns:

an instance of the bean (should not be null; a null value will be considered as an indication of incomplete initialization)

See Also:

FactoryBeanNotInitializedException

getObjectType

public Class getObjectType()

Description copied from interface: FactoryBean

Return the type of object that this FactoryBean creates, or null if not known in advance. This allows to check for specific types of beans without instantiating objects, for example on autowiring.

For a singleton, this 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.

Specified by:

getObjectType in interface FactoryBean

Returns:

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

See Also:

ListableBeanFactory.getBeansOfType(java.lang.Class)

isSingleton

public boolean isSingleton()

Description copied from interface: FactoryBean

Is the bean managed by this factory a singleton or a prototype? 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.

Specified by:

isSingleton in interface FactoryBean

Returns:

if this bean is a singleton

See Also:

FactoryBean.getObject()

destroy

public void destroy()

Description copied from interface: DisposableBean

Invoked by a BeanFactory on destruction of a singleton.

Specified by:

destroy in interface DisposableBean