public class ConcurrentMapCacheFactoryBean extends java.lang.Object implements FactoryBean<ConcurrentMapCache>, BeanNameAware, InitializingBean
FactoryBean
for easy configuration of a ConcurrentMapCache
when used within a Spring container. Can be configured through bean properties;
uses the assigned Spring bean name as the default cache name.
Useful for testing or simple caching scenarios, typically in combination
with SimpleCacheManager
or
dynamically through ConcurrentMapCacheManager
.
Modifier and Type | Field and Description |
---|---|
private boolean |
allowNullValues |
private ConcurrentMapCache |
cache |
private java.lang.String |
name |
private java.util.concurrent.ConcurrentMap<java.lang.Object,java.lang.Object> |
store |
Constructor and Description |
---|
ConcurrentMapCacheFactoryBean() |
Modifier and Type | Method and Description |
---|---|
void |
afterPropertiesSet()
Invoked by a BeanFactory after it has set all bean properties supplied
(and satisfied BeanFactoryAware and ApplicationContextAware).
|
ConcurrentMapCache |
getObject()
Return an instance (possibly shared or independent) of the object
managed by this factory.
|
java.lang.Class<?> |
getObjectType()
Return the type of object that this FactoryBean creates,
or
null if not known in advance. |
boolean |
isSingleton()
Is the object managed by this factory a singleton? That is,
will
FactoryBean.getObject() always return the same object
(a reference that can be cached)? |
void |
setAllowNullValues(boolean allowNullValues)
Set whether to allow
null values
(adapting them to an internal null holder value). |
void |
setBeanName(java.lang.String beanName)
Set the name of the bean in the bean factory that created this bean.
|
void |
setName(java.lang.String name)
Specify the name of the cache.
|
void |
setStore(java.util.concurrent.ConcurrentMap<java.lang.Object,java.lang.Object> store)
Specify the ConcurrentMap to use as an internal store
(possibly pre-populated).
|
private java.lang.String name
private java.util.concurrent.ConcurrentMap<java.lang.Object,java.lang.Object> store
private boolean allowNullValues
private ConcurrentMapCache cache
public void setName(java.lang.String name)
Default is "" (empty String).
public void setStore(java.util.concurrent.ConcurrentMap<java.lang.Object,java.lang.Object> store)
Default is a standard ConcurrentHashMap
.
public void setAllowNullValues(boolean allowNullValues)
null
values
(adapting them to an internal null holder value).
Default is "true".
public void setBeanName(java.lang.String beanName)
BeanNameAware
Invoked after population of normal bean properties but before an
init callback such as InitializingBean.afterPropertiesSet()
or a custom init-method.
setBeanName
in interface BeanNameAware
beanName
- the name of the bean in the factory.
Note that this name is the actual bean name used in the factory, which may
differ from the originally specified name: in particular for inner bean
names, the actual bean name might have been made unique through appending
"#..." suffixes. Use the BeanFactoryUtils.originalBeanName(String)
method to extract the original bean name (without suffix), if desired.public void afterPropertiesSet()
InitializingBean
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.
afterPropertiesSet
in interface InitializingBean
public ConcurrentMapCache getObject()
FactoryBean
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.
getObject
in interface FactoryBean<ConcurrentMapCache>
null
)FactoryBeanNotInitializedException
public java.lang.Class<?> getObjectType()
FactoryBean
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.
getObjectType
in interface FactoryBean<ConcurrentMapCache>
null
if not known at the time of the callListableBeanFactory.getBeansOfType(java.lang.Class<T>)
public boolean isSingleton()
FactoryBean
FactoryBean.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
.
isSingleton
in interface FactoryBean<ConcurrentMapCache>
FactoryBean.getObject()
,
SmartFactoryBean.isPrototype()