File ObservedBeanFactoryBean.java

Branches:

Statements:

Methods:

Classes:

LOC:

248

NCLOC:

162

Total complexity:

Complexity density:

0.57

Statements/Method:

2.15

Methods/Class:

Average method complexity:

1.23

41.6% of code in this file is excluded from these metrics. Remove Filter

Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
ObservedBeanFactoryBean	79	28	41.6%	16	2	0.9555555695.6%

Class ObservedBeanFactoryBean

Class ObservedBeanFactoryBean	Line # 79	Total Statements 28	% Filtered 41.6%	Complexity 16	Uncovered Elements 2	TOTAL Coverage 0.9555555695.6%
getTargetClass() : Class<?> getTargetClass() : Class<?>	104104	2.02	0.00%	2.02	0.00	1.0 1.0100%
isStatic() : boolean isStatic() : boolean	110110	0.00	1.0100%	1.01	0.00	-1.0 -1.0 -
getTarget() : Object getTarget() : Object	115115	0.00	1.0100%	1.01	0.00	-1.0 -1.0 -
releaseTarget(Object) : void releaseTarget(Object) : void	120120	0.00	-1.0 -	1.01	0.00	-1.0 -1.0 -
ObservedBeanFactoryBean() ObservedBeanFactoryBean()	9999	2.02	0.00%	1.01	0.00	1.0 1.0100%
getDefaultClass() : Class<?> getDefaultClass() : Class<?>	126126	0.00	1.0100%	1.01	0.00	-1.0 -1.0 -
setDefaultClass(Class<?>) : void setDefaultClass(Class<?>) : void	130130	0.00	1.0100%	1.01	0.00	-1.0 -1.0 -
getRepository() : String getRepository() : String	134134	0.00	1.0100%	1.01	0.00	-1.0 -1.0 -
setRepository(String) : void setRepository(String) : void	139139	0.00	1.0100%	1.01	0.00	-1.0 -1.0 -
getWorkspace() : String getWorkspace() : String	144144	0.00	1.0100%	1.01	0.00	-1.0 -1.0 -
setWorkspace(String) : void setWorkspace(String) : void	148148	0.00	1.0100%	1.01	0.00	-1.0 -1.0 -
getPath() : String getPath() : String	152152	0.00	1.0100%	1.01	0.00	-1.0 -1.0 -
setPath(String) : void setPath(String) : void	156156	0.00	1.0100%	1.01	0.00	-1.0 -1.0 -
setMaxObservationDelay(int) : void setMaxObservationDelay(int) : void	160160	0.00	1.0100%	1.01	0.00	-1.0 -1.0 -
setObservationDelay(int) : void setObservationDelay(int) : void	164164	0.00	1.0100%	1.01	0.00	-1.0 -1.0 -
afterPropertiesSet() : void afterPropertiesSet() : void	168168	2.02	0.00%	1.01	0.00	1.0 1.0100%
destroy() : void destroy() : void	174174	4.04	0.00%	1.01	0.00	1.0 1.0100%
onEvent(EventIterator) : void onEvent(EventIterator) : void	182182	3.03	0.00%	2.02	1.01	0.6666667 0.666666766.7%
setApplicationContext(ApplicationContext) : void setApplicationContext(ApplicationContext) : void	191191	0.00	1.0100%	1.01	0.00	-1.0 -1.0 -
setBeanFactory(BeanFactory) : void setBeanFactory(BeanFactory) : void	196196	0.00	1.0100%	1.01	0.00	-1.0 -1.0 -
setApplicationEventPublisher(ApplicationEventPublisher) : void setApplicationEventPublisher(ApplicationEventPublisher) : void	201201	0.00	1.0100%	1.01	0.00	-1.0 -1.0 -
setBeanName(String) : void setBeanName(String) : void	206206	0.00	1.0100%	1.01	0.00	-1.0 -1.0 -
createInstance() : Object createInstance() : Object	211211	2.02	0.00%	1.01	0.00	1.0 1.0100%
destroyInstance(Object) : void destroyInstance(Object) : void	216216	2.02	0.00%	2.02	1.01	0.75 0.7575%
reloadInstance() : void reloadInstance() : void	222222	4.04	0.00%	1.01	0.00	1.0 1.0100%
transformNode(Node) : Object transformNode(Node) : Object	230230	4.04	0.00%	1.01	0.00	1.0 1.0100%
getConfigurationNode() : Node getConfigurationNode() : Node	237237	1.01	0.00%	1.01	0.00	1.0 1.0100%
startObservation() : void startObservation() : void	241241	1.01	0.00%	1.01	0.00	1.0 1.0100%
stopObservation() : void stopObservation() : void	245245	1.01	0.00%	1.01	0.00	1.0 1.0100%

Contributing tests

This file is covered by 3 tests. .

Contributing tests

Test contribution	Test	Result
0.95555556	info.magnolia.module.blossom.context.ObservedBeanFactoryBeanTest.testInstantiationInitializationReloadingAndDestructioninfo.magnolia.module.blossom.context.ObservedBeanFactoryBeanTest.testInstantiationInitializationReloadingAndDestruction	1PASS
0.53333336	info.magnolia.module.blossom.context.ObservedBeanFactoryBeanTest.testDefaultClassinfo.magnolia.module.blossom.context.ObservedBeanFactoryBeanTest.testDefaultClass	1PASS
0.51111114	info.magnolia.module.blossom.context.ObservedBeanFactoryBeanTest.testJdkProxyinfo.magnolia.module.blossom.context.ObservedBeanFactoryBeanTest.testJdkProxy	1PASS

Source view

/**

* This file is dual-licensed under both the Magnolia

* Network Agreement and the GNU General Public License.

* You may elect to use one or the other of these licenses.

* This file is distributed in the hope that it will be

* useful, but AS-IS and WITHOUT ANY WARRANTY; without even the

* implied warranty of MERCHANTABILITY or FITNESS FOR A

* PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.

* Redistribution, except as permitted by whichever of the GPL

* or MNA you select, is prohibited.

* 1. For the GPL license (GPL), you can redistribute and/or

* modify this file under the terms of the GNU General

* Public License, Version 3, as published by the Free Software

* Foundation. You should have received a copy of the GNU

* General Public License, Version 3 along with this program;

* if not, write to the Free Software Foundation, Inc., 51

* Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

* 2. For the Magnolia Network Agreement (MNA), this file

* and the accompanying materials are made available under the

* terms of the MNA which accompanies this distribution, and

* is available at http://www.magnolia-cms.com/mna.html

* Any modifications to this file must keep this entire header

* intact.

package info.magnolia.module.blossom.context;

import javax.jcr.Node;

import javax.jcr.RepositoryException;

import javax.jcr.observation.EventIterator;

import javax.jcr.observation.EventListener;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.springframework.aop.TargetSource;

import org.springframework.aop.framework.ProxyFactoryBean;

import org.springframework.beans.factory.BeanFactory;

import org.springframework.beans.factory.BeanFactoryAware;

import org.springframework.beans.factory.BeanNameAware;

import org.springframework.beans.factory.DisposableBean;

import org.springframework.beans.factory.InitializingBean;

import org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory;

import org.springframework.context.ApplicationContext;

import org.springframework.context.ApplicationContextAware;

import org.springframework.context.ApplicationEventPublisher;

import org.springframework.context.ApplicationEventPublisherAware;

import info.magnolia.cms.util.ObservationUtil;

import info.magnolia.context.SystemContext;

import info.magnolia.jcr.node2bean.Node2BeanException;

import info.magnolia.jcr.node2bean.Node2BeanProcessor;

import info.magnolia.module.blossom.node2bean.SpringNode2BeanTransformer;

import info.magnolia.module.blossom.support.BeanFactoryUtils;

import info.magnolia.objectfactory.Components;

import info.magnolia.repository.RepositoryConstants;

/**

* FactoryBean that creates a bean and populates its properties with values from the repository and reloads the bean

* automatically when the repository is updated.

* The returned instance is a proxy that delegates calls to the instance created from the repository. The instance

* delegated to is transparently swapped. The proxy is by default a JDK dynamic proxy proxying all the objects

* interfaces. This can be changed to a cglib proxy by setting the property proxyTargetClass to true.

* There is a delay mechanism in place that aggregates events in order to postpone reloading while the repository is

* being updated. By default any change postpones reloading by 15 seconds but no longer than 60 seconds. These values

* can be configured.

* @since 1.2

public class ObservedBeanFactoryBean extends ProxyFactoryBean implements InitializingBean, BeanNameAware, ApplicationContextAware, BeanFactoryAware, EventListener, DisposableBean, ApplicationEventPublisherAware {

private static final Logger logger = LoggerFactory.getLogger(ObservedBeanFactoryBean.class);

private static final String DEFAULT_WORKSPACE = RepositoryConstants.CONFIG;

private static final int DEFAULT_MAX_DELAY = 60000;

private static final int DEFAULT_DELAY = 15000;

private ApplicationContext applicationContext;

private ApplicationEventPublisher applicationEventPublisher;

private AbstractAutowireCapableBeanFactory beanFactory;

private String beanName;

private String workspace = DEFAULT_WORKSPACE;

private String path;

private int maxObservationDelay = DEFAULT_MAX_DELAY;

private int observationDelay = DEFAULT_DELAY;

private Class<?> defaultClass;

private volatile Object target;

public ObservedBeanFactoryBean() {

100

super.setSingleton(true);

101

102

super.setTargetSource(new TargetSource() {

103

104

@Override

105

public Class<?> getTargetClass() {

106

Object local = target;

107

return local != null ? local.getClass() : null;

}

@Override

public boolean isStatic() {

return false;

}

@Override

public Object getTarget() throws Exception {

return target;

}

@Override

public void releaseTarget(Object target) throws Exception {

}

});

}

public Class<?> getDefaultClass() {

return defaultClass;

}

public void setDefaultClass(Class<?> defaultClass) {

131

this.defaultClass = defaultClass;

}

@Deprecated

public String getRepository() {

return workspace;

}

@Deprecated

public void setRepository(String repository) {

141

this.workspace = repository;

142

}

143

144

public String getWorkspace() {

return workspace;

}

public void setWorkspace(String workspace) {

149

this.workspace = workspace;

150

}

151

152

public String getPath() {

return path;

}

public void setPath(String path) {

this.path = path;

}

public void setMaxObservationDelay(int maxObservationDelay) {

161

this.maxObservationDelay = maxObservationDelay;

162

}

163

164

public void setObservationDelay(int observationDelay) {

165

this.observationDelay = observationDelay;

}

@Override

public void afterPropertiesSet() throws Exception {

170

this.target = createInstance();

startObservation();

}

@Override

public void destroy() throws Exception {

176

stopObservation();

177

Object instance = target;

178

target = null;

179

destroyInstance(instance);

}

@Override

public void onEvent(EventIterator events) {

184

try {

185

reloadInstance();

186

} catch (Exception e) {

187

logger.error("Failed to reload observed bean [" + beanName + "] configured at path [" + path + "] in workspace [" + workspace + "] on change event", e);

188

}

189

}

190