Class ObjectFactory<O,P>

java.lang.Object

org.frankframework.jdbc.datasource.ObjectFactory<O,P>

Type Parameters:

O - Object class used by clients

All Implemented Interfaces:

org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

AmqpConnectionFactoryFactory, JmsConnectionFactoryFactory, MongoClientFactoryFactory, MqttClientFactoryFactory, NonTransactionalDataSourceFactory

public abstract class ObjectFactory<O,P>
extends Object
implements org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean

Baseclass for Object lookups. Already created Objects are stored in a ConcurrentHashMap. Objects will be searched in all available IObjectLocators. If it cannot find the object in the first locator, it will attempt to do so in the next available one. Every Objects can be augmented before it is added.

Author:

Gerrit van Brakel, Niels Meijer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ObjectFactory.ObjectInfo

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.apache.logging.log4j.Logger	log

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ObjectFactory(Class<P> lookupClass, String resourcePrefix, String displayName)

Method Summary

Modifier and Type	Method	Description
@NonNull O	add(@NonNull P object, @NonNull String name)	Add and augment an Object to this factory so it can be used without the need of a lookup.
void	afterPropertiesSet()
protected @NonNull O	augment(@NonNull P object, @NonNull String objectName)	Allow implementing classes to augment the looked up object class 'O'.
final void	destroy()
protected void	destroyObject(O object)	This method is called when the objects stored in this Factory are removed.
protected final @NonNull O	get(@NonNull String name, @Nullable Properties environment)	Returns the object matching the name and return type.
@NonNull List<ObjectFactory.ObjectInfo>	getObjectInfo()
protected @NonNull List<String>	getObjectNames()
protected void	postDestroy()	Subclasses which need to do their own work on destruction of this bean should override this method, which will be called after all factory objects have been closed.
protected @NonNull ObjectFactory.ObjectInfo	toObjectInfo(String name)	Mapping from to a information object, used for logging and console actions.

Methods inherited from class Object

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

Field Details

log

protected final org.apache.logging.log4j.Logger log

Constructor Details

ObjectFactory

protected ObjectFactory(Class<P> lookupClass,
 String resourcePrefix,
 String displayName)

Method Details

augment

protected @NonNull O augment(@NonNull P object,
 @NonNull String objectName)

Allow implementing classes to augment the looked up object class 'O'. Allows the originally created object to be mutated to another object. Useful to generate an object from a filled DTO.

get

protected final @NonNull O get(@NonNull String name,
 @Nullable Properties environment)
                        throws NoSuchElementException,
IllegalStateException

Returns the object matching the name and return type. If not cached yet, attempts to traverse all IObjectLocators to do so. If a new instance is created, augment(Object, String) is called to allow subclasses to wrap or modify the object.

When using a JNDI environment it allows initial properties to use for JNDI lookups.

Throws:

NoSuchElementException - when the object cannot be found

IllegalStateException - when an object definition can be found, but the object instance cannot be created

add

public @NonNull O add(@NonNull P object,
 @NonNull String name)

Add and augment an Object to this factory so it can be used without the need of a lookup. Should only be called during jUnit Tests or when registering an Object through Spring. Never through a lookup.

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

getObjectNames

protected @NonNull List<String> getObjectNames()

getObjectInfo

public @NonNull List<ObjectFactory.ObjectInfo> getObjectInfo()

toObjectInfo

protected @NonNull ObjectFactory.ObjectInfo toObjectInfo(String name)

Mapping from to a information object, used for logging and console actions.

destroy

public final void destroy()
                   throws Exception

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

Exception

postDestroy

protected void postDestroy()
                    throws Exception

Subclasses which need to do their own work on destruction of this bean should override this method, which will be called after all factory objects have been closed.

Throws:

Exception

destroyObject

protected void destroyObject(O object)
                      throws Exception

This method is called when the objects stored in this Factory are removed. It allows implementations to handle their own close actions.

Throws:

Exception