inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-07-31 17:39:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

RM-1668 (Move BeanExtender into Core)

Browse Source 
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/modules/recordsmanagement/HEAD@83469 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Tuna Aksoy
2014-09-05 16:12:39 +00:00
parent e40704f7a1
commit f65d037d94
7 changed files with 13 additions and 362 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
rm-server/config/alfresco/module/org_alfresco_module_rm/extended-repository-context.xml
View File

@@ -5,23 +5,23 @@
<!-- extend node service security to report capability details on failure -->
<bean id="rm.NodeService_security" abstract="true" class="org.alfresco.module.org_alfresco_module_rm.security.RMMethodSecurityInterceptor"/>
<bean class="org.alfresco.module.org_alfresco_module_rm.util.BeanExtender">
<bean class="org.alfresco.util.BeanExtender">
<property name="beanName" value="NodeService_security" />
<property name="extendingBeanName" value="rm.NodeService_security" />
</bean>
<!-- extended file folder bean definition -->
<bean id="rm.fileFolderService" abstract="true" class="org.alfresco.repo.model.filefolder.ExtendedFileFolderServiceImpl">
<property name="recordService" ref="RecordService" />
</bean>
<bean class="org.alfresco.module.org_alfresco_module_rm.util.BeanExtender">
</bean>
<bean class="org.alfresco.util.BeanExtender">
<property name="beanName" value="fileFolderService" />
<property name="extendingBeanName" value="rm.fileFolderService" />
</bean>
<!-- extend file folder service security to report capability details on failure -->
<bean id="rm.FileFolderService_security" abstract="true" class="org.alfresco.module.org_alfresco_module_rm.security.RMMethodSecurityInterceptor"/>
<bean class="org.alfresco.module.org_alfresco_module_rm.util.BeanExtender">
<bean class="org.alfresco.util.BeanExtender">
<property name="beanName" value="FileFolderService_security" />
<property name="extendingBeanName" value="rm.FileFolderService_security" />
</bean>

2
rm-server/config/alfresco/module/org_alfresco_module_rm/rm-ui-evaluators-context.xml
View File

@@ -13,7 +13,7 @@
</bean>
<!-- extends core bean with RM extensions -->
<bean class="org.alfresco.module.org_alfresco_module_rm.util.BeanExtender">
<bean class="org.alfresco.util.BeanExtender">
<property name="beanName" value="jsonConversionComponent" />
<property name="extendingBeanName" value="rm.jsonConversionComponent" />
</bean>

10
rm-server/config/alfresco/module/org_alfresco_module_rm/rm-version-context.xml
View File

@@ -20,17 +20,17 @@
<property name="ownableService" ref="OwnableService" />
<property name="extendedSecurityService" ref="ExtendedSecurityService" />
<property name="authenticationUtil" ref="rm.authenticationUtil" />
</bean>
<bean class="org.alfresco.module.org_alfresco_module_rm.util.BeanExtender">
</bean>
<bean class="org.alfresco.util.BeanExtender">
<property name="beanName" value="versionService" />
<property name="extendingBeanName" value="rm.versionService" />
</bean>
<!-- extended version node service bean definition -->
<bean id="rm.versionNodeService" abstract="true" class="org.alfresco.module.org_alfresco_module_rm.version.RecordableVersionNodeServiceImpl">
<property name="recordService" ref="RecordService" />
</bean>
<bean class="org.alfresco.module.org_alfresco_module_rm.util.BeanExtender">
</bean>
<bean class="org.alfresco.util.BeanExtender">
<property name="beanName" value="versionNodeService" />
<property name="extendingBeanName" value="rm.versionNodeService" />
</bean>

102
rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/util/BeanExtender.java
View File

@@ -1,102 +0,0 @@
/*
* Copyright (C) 2005-2014 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.module.org_alfresco_module_rm.util;
import org.alfresco.util.ParameterCheck;
import org.apache.commons.lang.StringUtils;
import org.springframework.beans.MutablePropertyValues;
import org.springframework.beans.PropertyValue;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
/**
* Extends the definition of a bean with another.
* <p>
* Implements bean factory post processor.
*
* @author Roy Wetherall
* @since 2.2
*/
public class BeanExtender implements BeanFactoryPostProcessor
{
/** name of bean to extend */
private String beanName;
/** extending bean name */
private String extendingBeanName;
/**
* @param beanName bean name
*/
public void setBeanName(String beanName)
{
this.beanName = beanName;
}
/**
* @param extendingBeanName extending bean name
*/
public void setExtendingBeanName(String extendingBeanName)
{
this.extendingBeanName = extendingBeanName;
}
/**
* @see org.springframework.beans.factory.config.BeanFactoryPostProcessor#postProcessBeanFactory(org.springframework.beans.factory.config.ConfigurableListableBeanFactory)
*/
@Override
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
{
ParameterCheck.mandatory("beanName", beanName);
ParameterCheck.mandatory("extendingBeanName", extendingBeanName);
// check for bean name
if (!beanFactory.containsBean(beanName))
{
throw new NoSuchBeanDefinitionException("Can't find bean '" + beanName + "' to be extended.");
}
// check for extending bean
if (!beanFactory.containsBean(extendingBeanName))
{
throw new NoSuchBeanDefinitionException("Can't find bean '" + extendingBeanName + "' that is going to extend origional bean definition.");
}
// get the bean definitions
BeanDefinition beanDefinition = beanFactory.getBeanDefinition(beanName);
BeanDefinition extendingBeanDefinition = beanFactory.getBeanDefinition(extendingBeanName);
// update class
if (StringUtils.isNotBlank(extendingBeanDefinition.getBeanClassName()) &&
!beanDefinition.getBeanClassName().equals(extendingBeanDefinition.getBeanClassName()))
{
beanDefinition.setBeanClassName(extendingBeanDefinition.getBeanClassName());
}
// update properties
MutablePropertyValues properties = beanDefinition.getPropertyValues();
MutablePropertyValues extendingProperties = extendingBeanDefinition.getPropertyValues();
for (PropertyValue propertyValue : extendingProperties.getPropertyValueList())
{
properties.add(propertyValue.getName(), propertyValue.getValue());
}
}
}

2
rm-server/test/resources/test-context.xml
View File

@@ -130,7 +130,7 @@
<bean id="rm.dictionaryModelType" abstract="true">
<property name="doValidation" value="false"/>
</bean>
<bean class="org.alfresco.module.org_alfresco_module_rm.util.BeanExtender">
<bean class="org.alfresco.util.BeanExtender">
<property name="beanName" value="dictionaryModelType" />
<property name="extendingBeanName" value="rm.dictionaryModelType" />
</bean>

2
rm-server/unit-test/java/org/alfresco/module/org_alfresco_module_rm/test/AllUnitTestSuite.java
View File

@@ -34,7 +34,6 @@ import org.alfresco.module.org_alfresco_module_rm.recorded.version.config.Record
import org.alfresco.module.org_alfresco_module_rm.script.hold.HoldPostUnitTest;
import org.alfresco.module.org_alfresco_module_rm.script.hold.HoldPutUnitTest;
import org.alfresco.module.org_alfresco_module_rm.script.hold.HoldsGetUnitTest;
import org.alfresco.module.org_alfresco_module_rm.util.BeanExtenderUnitTest;
import org.alfresco.module.org_alfresco_module_rm.version.RecordableVersionServiceImplUnitTest;
import org.alfresco.repo.action.parameter.DateParameterProcessorUnitTest;
import org.junit.runner.RunWith;
@@ -54,7 +53,6 @@ import org.junit.runners.Suite.SuiteClasses;
RecordsManagementTypeFormFilterUnitTest.class,
DispositionLifecycleJobExecuterUnitTest.class,
DictionaryBootstrapPostProcessorUnitTest.class,
BeanExtenderUnitTest.class,
DateParameterProcessorUnitTest.class,
// services

245
rm-server/unit-test/java/org/alfresco/module/org_alfresco_module_rm/util/BeanExtenderUnitTest.java
View File

@@ -1,245 +0,0 @@
/*
* Copyright (C) 2005-2014 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.module.org_alfresco_module_rm.util;
import static org.mockito.Matchers.anyString;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import org.alfresco.module.org_alfresco_module_rm.test.util.BaseUnitTest;
import org.alfresco.util.GUID;
import org.junit.Test;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.springframework.beans.MutablePropertyValues;
import org.springframework.beans.PropertyValue;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
/**
* Bean extender unit test.
*
* @author Roy Wetherall
* @since 2.2
*/
public class BeanExtenderUnitTest extends BaseUnitTest
{
private static final String BEAN_NAME = GUID.generate();
private static final String EXTENDING_BEAN_NAME = GUID.generate();
@Mock private ConfigurableListableBeanFactory mockedBeanFactory;
@Mock private BeanDefinition mockedBeanDefinition;
@Mock private BeanDefinition mockedExtendingBeanDefinition;
@Mock private MutablePropertyValues mockedPropertyValuesBean;
@Mock private MutablePropertyValues mockedPropertyValuesExtendingBean;
@InjectMocks private BeanExtender beanExtender;
@Override
public void before() throws Exception
{
super.before();
// setup common interactions
doReturn(mockedPropertyValuesBean).when(mockedBeanDefinition).getPropertyValues();
doReturn(mockedPropertyValuesExtendingBean).when(mockedExtendingBeanDefinition).getPropertyValues();
}
/**
* given that the bean name is not set, ensure that an Illegal Argument
* exception is thrown.
*/
@Test
public void beanNameNotSet()
{
// === given ===
// set the extending bean name
beanExtender.setExtendingBeanName(EXTENDING_BEAN_NAME);
// expecting exception
exception.expect(IllegalArgumentException.class);
// === when ===
beanExtender.postProcessBeanFactory(mockedBeanFactory);
}
/**
* given that the extending bean name is not set, ensure that an illegal
* argument exception is thrown.
*/
@Test
public void extendingBeanNameNotSet()
{
// === given ===
// set the extending bean name
beanExtender.setBeanName(BEAN_NAME);
// expecting exception
exception.expect(IllegalArgumentException.class);
// === when ===
beanExtender.postProcessBeanFactory(mockedBeanFactory);
}
/**
* given that the bean does not exist ensure that an exception is thrown
*/
@Test
public void beanDoesNotExist()
{
// === given ===
// set the bean names
beanExtender.setBeanName(BEAN_NAME);
beanExtender.setExtendingBeanName(EXTENDING_BEAN_NAME);
doReturn(false).when(mockedBeanFactory).containsBean(BEAN_NAME);
doReturn(true).when(mockedBeanFactory).containsBean(EXTENDING_BEAN_NAME);
// expecting exception
exception.expect(NoSuchBeanDefinitionException.class);
// === when ===
beanExtender.postProcessBeanFactory(mockedBeanFactory);
}
/**
* given that the extending bean does not exist ensure that an exception is thrown
*/
@Test
public void extendingBeanDoesNotExist()
{
// === given ===
// set the bean names
beanExtender.setBeanName(BEAN_NAME);
beanExtender.setExtendingBeanName(EXTENDING_BEAN_NAME);
doReturn(true).when(mockedBeanFactory).containsBean(BEAN_NAME);
doReturn(false).when(mockedBeanFactory).containsBean(EXTENDING_BEAN_NAME);
// expecting exception
exception.expect(NoSuchBeanDefinitionException.class);
// === when ===
beanExtender.postProcessBeanFactory(mockedBeanFactory);
}
/**
* given that a different class name has been set on the extending bean ensure it is
* set correctly on the origional bean
*/
@Test
public void beanClassNameSet()
{
// === given ===
// set the bean names
beanExtender.setBeanName(BEAN_NAME);
beanExtender.setExtendingBeanName(EXTENDING_BEAN_NAME);
// both beans are available in the bean factory
doReturn(true).when(mockedBeanFactory).containsBean(BEAN_NAME);
doReturn(true).when(mockedBeanFactory).containsBean(EXTENDING_BEAN_NAME);
// return the mocked bean definitions
doReturn(mockedBeanDefinition).when(mockedBeanFactory).getBeanDefinition(BEAN_NAME);
doReturn(mockedExtendingBeanDefinition).when(mockedBeanFactory).getBeanDefinition(EXTENDING_BEAN_NAME);
// bean class names
doReturn("a").when(mockedBeanDefinition).getBeanClassName();
doReturn("b").when(mockedExtendingBeanDefinition).getBeanClassName();
// no properties have been defined
doReturn(Collections.EMPTY_LIST).when(mockedPropertyValuesExtendingBean).getPropertyValueList();
// === when ===
beanExtender.postProcessBeanFactory(mockedBeanFactory);
// === then ===
// expect the class name to be set on the bean
verify(mockedBeanDefinition, times(1)).setBeanClassName("b");
verify(mockedPropertyValuesBean, never()).add(anyString(), anyString());
}
/**
* given that new property values have been set on the extending bean ensure that they
* are correctly set on the original bean.
*/
@Test
public void beanPropertyValuesSet()
{
// === given ===
// set the bean names
beanExtender.setBeanName(BEAN_NAME);
beanExtender.setExtendingBeanName(EXTENDING_BEAN_NAME);
// both beans are available in the bean factory
doReturn(true).when(mockedBeanFactory).containsBean(BEAN_NAME);
doReturn(true).when(mockedBeanFactory).containsBean(EXTENDING_BEAN_NAME);
// return the mocked bean definitions
doReturn(mockedBeanDefinition).when(mockedBeanFactory).getBeanDefinition(BEAN_NAME);
doReturn(mockedExtendingBeanDefinition).when(mockedBeanFactory).getBeanDefinition(EXTENDING_BEAN_NAME);
// bean class names
doReturn("a").when(mockedBeanDefinition).getBeanClassName();
doReturn(null).when(mockedExtendingBeanDefinition).getBeanClassName();
PropertyValue mockedPropertyValueOne = generateMockedPropertyValue("one", "1");
PropertyValue mockedPropertyValueTwo = generateMockedPropertyValue("two", "2");
List<PropertyValue> list = new ArrayList<PropertyValue>(2);
list.add(mockedPropertyValueOne);
list.add(mockedPropertyValueTwo);
doReturn(list).when(mockedPropertyValuesExtendingBean).getPropertyValueList();
// === when ===
beanExtender.postProcessBeanFactory(mockedBeanFactory);
// === then ===
// expect the class name to be set on the bean
verify(mockedBeanDefinition, never()).setBeanClassName(anyString());
verify(mockedPropertyValuesBean, times(1)).add("one", "1");
verify(mockedPropertyValuesBean, times(1)).add("two", "2");
}
/**
* Helper method to generate a mocked property value
*/
private PropertyValue generateMockedPropertyValue(String name, String value)
{
PropertyValue result = mock(PropertyValue.class);
doReturn(name).when(result).getName();
doReturn(value).when(result).getValue();
return result;
}
}