ref #8162 adapt cdmlip to new term package structure
[cdmlib.git] / cdmlib-services / src / main / java / eu / etaxonomy / cdm / api / application / CdmApplicationController.java
index 24a00db272053be6e7cfc944722da91db9f9dea2..c2e944132362fec489ed0e13fb63af2747b4be68 100644 (file)
@@ -1,4 +1,3 @@
-// $Id$\r
 /**\r
  * Copyright (C) 2007 EDIT\r
  * European Distributed Institute of Taxonomy\r
@@ -8,13 +7,11 @@
  * See LICENSE.TXT at the top of this package for the full license terms.\r
  */\r
 \r
-\r
 package eu.etaxonomy.cdm.api.application;\r
 \r
 import java.util.EnumSet;\r
-import java.util.HashSet;\r
 import java.util.List;\r
-import java.util.Set;\r
+import java.util.Properties;\r
 import java.util.UUID;\r
 \r
 import org.apache.log4j.Logger;\r
@@ -26,9 +23,9 @@ import org.springframework.context.ApplicationListener;
 import org.springframework.context.support.AbstractApplicationContext;\r
 import org.springframework.core.io.ClassPathResource;\r
 import org.springframework.core.io.Resource;\r
-import org.springframework.security.access.PermissionEvaluator;\r
 import org.springframework.security.authentication.ProviderManager;\r
-import org.springframework.security.core.GrantedAuthority;\r
+import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;\r
+import org.springframework.security.core.Authentication;\r
 import org.springframework.security.core.context.SecurityContext;\r
 import org.springframework.security.core.context.SecurityContextHolder;\r
 import org.springframework.transaction.PlatformTransactionManager;\r
@@ -36,11 +33,16 @@ import org.springframework.transaction.TransactionStatus;
 \r
 import eu.etaxonomy.cdm.api.conversation.ConversationHolder;\r
 import eu.etaxonomy.cdm.api.service.IAgentService;\r
+import eu.etaxonomy.cdm.api.service.IAnnotationService;\r
 import eu.etaxonomy.cdm.api.service.IClassificationService;\r
 import eu.etaxonomy.cdm.api.service.ICollectionService;\r
 import eu.etaxonomy.cdm.api.service.ICommonService;\r
 import eu.etaxonomy.cdm.api.service.IDatabaseService;\r
 import eu.etaxonomy.cdm.api.service.IDescriptionService;\r
+import eu.etaxonomy.cdm.api.service.IDescriptiveDataSetService;\r
+import eu.etaxonomy.cdm.api.service.IEntityConstraintViolationService;\r
+import eu.etaxonomy.cdm.api.service.IEntityValidationService;\r
+import eu.etaxonomy.cdm.api.service.IEventBaseService;\r
 import eu.etaxonomy.cdm.api.service.IFeatureNodeService;\r
 import eu.etaxonomy.cdm.api.service.IFeatureTreeService;\r
 import eu.etaxonomy.cdm.api.service.IGrantedAuthorityService;\r
@@ -48,18 +50,24 @@ import eu.etaxonomy.cdm.api.service.IGroupService;
 import eu.etaxonomy.cdm.api.service.IIdentificationKeyService;\r
 import eu.etaxonomy.cdm.api.service.ILocationService;\r
 import eu.etaxonomy.cdm.api.service.IMediaService;\r
+import eu.etaxonomy.cdm.api.service.IMetadataService;\r
 import eu.etaxonomy.cdm.api.service.INameService;\r
 import eu.etaxonomy.cdm.api.service.IOccurrenceService;\r
 import eu.etaxonomy.cdm.api.service.IPolytomousKeyNodeService;\r
 import eu.etaxonomy.cdm.api.service.IPolytomousKeyService;\r
+import eu.etaxonomy.cdm.api.service.IPreferenceService;\r
+import eu.etaxonomy.cdm.api.service.IProgressMonitorService;\r
 import eu.etaxonomy.cdm.api.service.IReferenceService;\r
-import eu.etaxonomy.cdm.api.service.IService;\r
+import eu.etaxonomy.cdm.api.service.IRegistrationService;\r
+import eu.etaxonomy.cdm.api.service.IRightsService;\r
 import eu.etaxonomy.cdm.api.service.ITaxonNodeService;\r
 import eu.etaxonomy.cdm.api.service.ITaxonService;\r
 import eu.etaxonomy.cdm.api.service.ITermService;\r
 import eu.etaxonomy.cdm.api.service.IUserService;\r
 import eu.etaxonomy.cdm.api.service.IVocabularyService;\r
-import eu.etaxonomy.cdm.api.service.IWorkingSetService;\r
+import eu.etaxonomy.cdm.api.service.molecular.IAmplificationService;\r
+import eu.etaxonomy.cdm.api.service.molecular.IPrimerService;\r
+import eu.etaxonomy.cdm.api.service.molecular.ISequenceService;\r
 import eu.etaxonomy.cdm.common.monitor.IProgressMonitor;\r
 import eu.etaxonomy.cdm.common.monitor.NullProgressMonitor;\r
 import eu.etaxonomy.cdm.common.monitor.SubProgressMonitor;\r
@@ -68,470 +76,691 @@ import eu.etaxonomy.cdm.database.DataSourceNotFoundException;
 import eu.etaxonomy.cdm.database.DbSchemaValidation;\r
 import eu.etaxonomy.cdm.database.ICdmDataSource;\r
 import eu.etaxonomy.cdm.model.common.CdmBase;\r
-import eu.etaxonomy.cdm.model.common.CdmMetaData;\r
-import eu.etaxonomy.cdm.model.common.DefinedTermBase;\r
-import eu.etaxonomy.cdm.model.common.GrantedAuthorityImpl;\r
-import eu.etaxonomy.cdm.model.common.User;\r
+import eu.etaxonomy.cdm.model.term.DefinedTermBase;\r
+import eu.etaxonomy.cdm.persistence.hibernate.HibernateConfiguration;\r
 import eu.etaxonomy.cdm.persistence.hibernate.permission.CRUD;\r
-import eu.etaxonomy.cdm.persistence.hibernate.permission.Operation;\r
-import eu.etaxonomy.cdm.persistence.hibernate.permission.Role;\r
-\r
+import eu.etaxonomy.cdm.persistence.hibernate.permission.ICdmPermissionEvaluator;\r
 \r
 /**\r
  * @author a.mueller\r
- *\r
  */\r
-public class CdmApplicationController implements ICdmApplicationConfiguration{\r
-    private static final Logger logger = Logger.getLogger(CdmApplicationController.class);\r
+public class CdmApplicationController implements ICdmRepository {\r
+       private static final Logger logger = Logger.getLogger(CdmApplicationController.class);\r
+\r
+       public static final String DEFAULT_APPLICATION_CONTEXT_RESOURCE = "/eu/etaxonomy/cdm/defaultApplicationContext.xml";\r
+\r
+       public AbstractApplicationContext applicationContext;\r
+       protected ICdmRepository configuration;\r
+       private final Resource applicationContextResource;\r
+\r
+       private final IProgressMonitor progressMonitor;\r
+\r
+       final protected static DbSchemaValidation defaultDbSchemaValidation = DbSchemaValidation.VALIDATE;\r
+\r
+\r
+       /**\r
+        * Constructor, opens a spring ApplicationContext by using the default data source\r
+        *\r
+        * @throws DataSourceNotFoundException\r
+        */\r
+       public static CdmApplicationController NewInstance() throws DataSourceNotFoundException{\r
+               logger.info("Start CdmApplicationController with default data source");\r
+               CdmPersistentDataSource dataSource = getDefaultDatasource();\r
+               DbSchemaValidation dbSchemaValidation = defaultDbSchemaValidation;\r
+               return CdmApplicationController.NewInstance(null, dataSource, dbSchemaValidation, false);\r
+       }\r
+\r
+\r
+       /**\r
+        * Constructor, opens a spring ApplicationContext by using the default data source\r
+        *\r
+        * @param dbSchemaValidation\r
+        *            validation type for database schema\r
+        * @throws DataSourceNotFoundException\r
+        */\r
+       public static CdmApplicationController NewInstance(DbSchemaValidation dbSchemaValidation) throws DataSourceNotFoundException{\r
+               logger.info("Start CdmApplicationController with default data source");\r
+               CdmPersistentDataSource dataSource = getDefaultDatasource();\r
+               return CdmApplicationController.NewInstance(null, dataSource, dbSchemaValidation, false);\r
+       }\r
+\r
+\r
+       /**\r
+        * Constructor, opens an spring ApplicationContext by using the according data source\r
+        * and the default database schema validation type\r
+        *\r
+        * @param dataSource\r
+        */\r
+       public static CdmApplicationController NewInstance(ICdmDataSource dataSource){\r
+               return CdmApplicationController.NewInstance(null, dataSource, defaultDbSchemaValidation, false);\r
+       }\r
+\r
+\r
+       public static CdmApplicationController NewInstance(ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation){\r
+               return CdmApplicationController.NewInstance(null, dataSource, dbSchemaValidation, false);\r
+       }\r
+\r
+\r
+       public static CdmApplicationController NewInstance(ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation, boolean omitTermLoading){\r
+               return CdmApplicationController.NewInstance(null, dataSource, dbSchemaValidation, omitTermLoading);\r
+       }\r
+\r
+       public static CdmApplicationController NewInstance(Resource applicationContextResource, ICdmDataSource dataSource,\r
+                       DbSchemaValidation dbSchemaValidation, boolean omitTermLoading){\r
+               return CdmApplicationController.NewInstance(applicationContextResource, dataSource, dbSchemaValidation,\r
+                       null, omitTermLoading, null);\r
+       }\r
+    public static CdmApplicationController NewInstance(Resource applicationContextResource, ICdmDataSource dataSource,\r
+            DbSchemaValidation dbSchemaValidation, boolean omitTermLoading, IProgressMonitor progressMonitor){\r
+        return new CdmApplicationController(applicationContextResource, dataSource, dbSchemaValidation,\r
+                null, omitTermLoading, progressMonitor, null);\r
+    }\r
+       public static CdmApplicationController NewInstance(Resource applicationContextResource, ICdmDataSource dataSource,\r
+                       DbSchemaValidation dbSchemaValidation, HibernateConfiguration hibernateConfig,\r
+                       boolean omitTermLoading, IProgressMonitor progressMonitor){\r
+               return new CdmApplicationController(applicationContextResource, dataSource, dbSchemaValidation,\r
+                       hibernateConfig, omitTermLoading, progressMonitor, null);\r
+       }\r
+\r
+\r
+       //TODO discuss need for listeners before commit to trunk\r
+       //      public static CdmApplicationController NewInstance(Resource applicationContextResource, ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation, boolean omitTermLoading, IProgressMonitor progressMonitor, List<ApplicationListener> listeners) {\r
+       //              return new CdmApplicationController(applicationContextResource, dataSource, dbSchemaValidation, omitTermLoading, progressMonitor,listeners);\r
+       //      }\r
+\r
+       /**\r
+        * @return\r
+        */\r
+       protected static ClassPathResource getClasspathResource(){\r
+               return new ClassPathResource(DEFAULT_APPLICATION_CONTEXT_RESOURCE);\r
+       }\r
+\r
+\r
+       /**\r
+        * @return\r
+        * @throws DataSourceNotFoundException\r
+        */\r
+       protected static CdmPersistentDataSource getDefaultDatasource() throws DataSourceNotFoundException{\r
+               CdmPersistentDataSource dataSource = CdmPersistentDataSource.NewDefaultInstance();\r
+               return dataSource;\r
+       }\r
+\r
+\r
+       /**\r
+        *\r
+        * FIXME:Remoting this constructor is added only to allow extension of this cntroller\r
+        * class. and should be removed after refactoring\r
+        */\r
+       protected CdmApplicationController(){\r
+               applicationContextResource = null;\r
+               progressMonitor = null;\r
+       }\r
+\r
+\r
+       /**\r
+        * Constructor, opens an spring 2.5 ApplicationContext by using the according data\r
+        * source\r
+        *\r
+        * @param dataSource\r
+        * @param dbSchemaValidation\r
+        * @param omitTermLoading\r
+        */\r
+       protected CdmApplicationController(Resource applicationContextResource, ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation,\r
+               HibernateConfiguration hibernateConfig,\r
+               boolean omitTermLoading, IProgressMonitor progressMonitor, List<ApplicationListener> listeners){\r
+               logger.info("Start CdmApplicationController with datasource: " + dataSource.getName());\r
+\r
+               if (dbSchemaValidation == null) {\r
+                       dbSchemaValidation = defaultDbSchemaValidation;\r
+               }\r
+               this.applicationContextResource = applicationContextResource != null ? applicationContextResource : getClasspathResource();\r
+               this.progressMonitor = progressMonitor != null ? progressMonitor : new NullProgressMonitor();\r
+\r
+               setNewDataSource(dataSource, dbSchemaValidation, hibernateConfig, omitTermLoading, listeners);\r
+       }\r
+\r
+\r
+       /**\r
+        * Sets the application context to a new spring ApplicationContext by using the\r
+        * according data source and initializes the Controller.\r
+        *\r
+        * @param dataSource\r
+        */\r
+       private boolean setNewDataSource(ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation,\r
+               HibernateConfiguration hibernateConfig,\r
+               boolean omitTermLoading, List<ApplicationListener> listeners){\r
+\r
+               if (dbSchemaValidation == null) {\r
+                       dbSchemaValidation = defaultDbSchemaValidation;\r
+               }\r
+               logger.info("Connecting to '" + dataSource.getName() + "'");\r
+\r
+               MonitoredGenericApplicationContext applicationContext = new MonitoredGenericApplicationContext();\r
+               int refreshTasks = 45;\r
+               int nTasks = 5 + refreshTasks;\r
+               //              nTasks += applicationContext.countTasks();\r
+               progressMonitor.beginTask("Connecting to '" + dataSource.getName() + "'", nTasks);\r
+\r
+               //              progressMonitor.worked(1);\r
+\r
+               BeanDefinition datasourceBean = dataSource.getDatasourceBean();\r
+               datasourceBean.setAttribute("isLazy", false);\r
+               progressMonitor.subTask("Registering datasource.");\r
+               applicationContext.registerBeanDefinition("dataSource", datasourceBean);\r
+               progressMonitor.worked(1);\r
+\r
+               BeanDefinition hibernatePropBean = dataSource.getHibernatePropertiesBean(dbSchemaValidation, hibernateConfig);\r
+               applicationContext.registerBeanDefinition("hibernateProperties", hibernatePropBean);\r
+\r
+               XmlBeanDefinitionReader xmlReader = new XmlBeanDefinitionReader(applicationContext);\r
+               progressMonitor.subTask("Registering resources.");\r
+               xmlReader.loadBeanDefinitions(applicationContextResource);\r
+               progressMonitor.worked(1);\r
+\r
+               //omitTerms\r
+               if (omitTermLoading == true) {\r
+                       String initializerName = "persistentTermInitializer";\r
+                       BeanDefinition beanDef = applicationContext.getBeanDefinition(initializerName);\r
+                       MutablePropertyValues values = beanDef.getPropertyValues();\r
+                       values.addPropertyValue("omit", omitTermLoading);\r
+               }\r
+\r
+               if (listeners != null) {\r
+                       for (ApplicationListener<?> listener : listeners) {\r
+                               applicationContext.addApplicationListener(listener);\r
+                       }\r
+               }\r
+\r
+               //              String message = "Start application context. This might take a while ...";\r
+               ////            progressMonitor.subTask(message);\r
+               //              SubProgressMonitor subMonitor= new SubProgressMonitor(progressMonitor, 10);\r
+               //              subMonitor.beginTask(message, 2);\r
+               //              applicationContext.setProgressMonitor(subMonitor);\r
+\r
+               applicationContext.refresh(new SubProgressMonitor(progressMonitor, refreshTasks));\r
+               applicationContext.start();\r
+               //              progressMonitor.worked(1);\r
+\r
+               progressMonitor.subTask("Cleaning up.");\r
+               setApplicationContext(applicationContext);\r
+               progressMonitor.worked(1);\r
+\r
+               progressMonitor.done();\r
+               return true;\r
+       }\r
+\r
+       /**\r
+     * Overrides all default with values in hibernate config, if defined\r
+     * @param hibernatePropBean\r
+     * @param hibernateConfig\r
+     */\r
+    private void registerHibernateConfig(BeanDefinition hibernatePropBean, HibernateConfiguration hibernateConfig) {\r
+        setHibernateProperty(hibernatePropBean, HibernateConfiguration.REGISTER_ENVERS,\r
+                hibernateConfig.getRegisterEnvers());\r
+        setHibernateProperty(hibernatePropBean, HibernateConfiguration.REGISTER_SEARCH,\r
+                hibernateConfig.getRegisterSearch());\r
+        setHibernateProperty(hibernatePropBean, HibernateConfiguration.SHOW_SQL,\r
+                hibernateConfig.getShowSql());\r
+        setHibernateProperty(hibernatePropBean, HibernateConfiguration.FORMAT_SQL,\r
+                hibernateConfig.getFormatSql());\r
+    }\r
+\r
+\r
+    private void setHibernateProperty(BeanDefinition hibernatePropBean, String key, Boolean value) {\r
+           if (value != null){\r
+               setHibernateProperty(hibernatePropBean, key, String.valueOf(value));\r
+           }\r
+       }\r
+    private void setHibernateProperty(BeanDefinition hibernatePropBean, String key, String value) {\r
+        if (value != null){\r
+            Properties props = (Properties)hibernatePropBean.getPropertyValues().get("properties");\r
+            props.setProperty(key, value);\r
+        }\r
+    }\r
 \r
-    public static final String DEFAULT_APPLICATION_CONTEXT_RESOURCE = "/eu/etaxonomy/cdm/defaultApplicationContext.xml";\r
 \r
-    public AbstractApplicationContext applicationContext;\r
-    private ICdmApplicationConfiguration configuration;\r
-    private Resource applicationContextResource;\r
+       /**\r
+        * Tests if some DefinedTermsAreMissing.\r
+        *\r
+        * @return true, if at least one is missing, else false\r
+        */\r
+       public boolean testDefinedTermsAreMissing(){\r
+               UUID englishUuid = UUID.fromString("e9f8cdb7-6819-44e8-95d3-e2d0690c3523");\r
+               DefinedTermBase<?> english = this.getTermService().load(englishUuid);\r
+               if (english == null || !english.getUuid().equals(englishUuid)) {\r
+                       return true;\r
+               }\r
+               else {\r
+                       return false;\r
+               }\r
+       }\r
+\r
+\r
+       /**\r
+        * Changes the ApplicationContext to the new dataSource\r
+        *\r
+        * @param dataSource\r
+        */\r
+       public boolean changeDataSource(ICdmDataSource dataSource){\r
+               //logger.info("Change datasource to : " + dataSource);\r
+               return setNewDataSource(dataSource, DbSchemaValidation.VALIDATE, null, false, null);\r
+       }\r
+\r
+\r
+       /**\r
+        * Changes the ApplicationContext to the new dataSource\r
+        *\r
+        * @param dataSource\r
+        * @param dbSchemaValidation\r
+        */\r
+       public boolean changeDataSource(ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation){\r
+               //logger.info("Change datasource to : " + dataSource);\r
+               return setNewDataSource(dataSource, dbSchemaValidation, null, false, null);\r
+       }\r
+\r
+\r
+       /**\r
+        * Changes the ApplicationContext to the new dataSource\r
+        *\r
+        * @param dataSource\r
+        * @param dbSchemaValidation\r
+        * @param omitTermLoading\r
+        */\r
+       public boolean changeDataSource(ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation, boolean omitTermLoading){\r
+               logger.info("Change datasource to : " + dataSource);\r
+               return setNewDataSource(dataSource, dbSchemaValidation, null, omitTermLoading, null);\r
+       }\r
+\r
+\r
+       /**\r
+        * Changes the ApplicationContext to the new dataSource\r
+        *\r
+        * @param dataSource\r
+        * @param dbSchemaValidation\r
+        * @param omitTermLoading\r
+        */\r
+       public boolean changeDataSource(ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation, boolean omitTermLoading,\r
+                       List<ApplicationListener> listeners){\r
+               logger.info("Change datasource to : " + dataSource);\r
+               return setNewDataSource(dataSource, dbSchemaValidation, null, omitTermLoading, listeners);\r
+       }\r
+\r
+\r
+       /**\r
+        * Sets a new application Context.\r
+        *\r
+        * @param ac\r
+        */\r
+       public void setApplicationContext(AbstractApplicationContext ac){\r
+               closeApplicationContext(); //closes old application context if necessary\r
+               applicationContext = ac;\r
+               applicationContext.registerShutdownHook();\r
+               init();\r
+       }\r
+\r
+       @Override\r
+       public void finalize(){\r
+               close();\r
+       }\r
+\r
+       /**\r
+        * closes the application\r
+        */\r
+       public void close(){\r
+               closeApplicationContext();\r
+       }\r
+\r
+\r
+       /**\r
+        * closes the application context\r
+        */\r
+       protected void closeApplicationContext(){\r
+               if (applicationContext != null) {\r
+                       logger.info("Close ApplicationContext");\r
+                       applicationContext.close();\r
+               }\r
+       }\r
+\r
+\r
+       protected void init(){\r
+               logger.debug("Init " + this.getClass().getName() + " ... ");\r
+               if (logger.isDebugEnabled()) {\r
+                       for (String beanName : applicationContext.getBeanDefinitionNames()) {\r
+                               logger.debug(beanName);\r
+                       }\r
+               }\r
+               //TODO delete next row (was just for testing)\r
+               if (logger.isInfoEnabled()) {\r
+                       logger.info("Registered Beans: ");\r
+                       String[] beanNames = applicationContext.getBeanDefinitionNames();\r
+                       for (String beanName : beanNames) {\r
+                               logger.info(beanName);\r
+                       }\r
+               }\r
+               configuration = (ICdmRepository) applicationContext.getBean("cdmRepository");\r
+               try {\r
+                       //FIXME:Remoting catching exection to allow for remoting\r
+                       getDatabaseService().setApplicationController(this);\r
+               }\r
+               catch (UnsupportedOperationException uoe) {\r
+                       logger.warn("getDatabaseService() is not implmented for current application context");\r
+               }\r
+       }\r
+\r
+\r
+       /* ****** Services ******** */\r
+       @Override\r
+       public final IAnnotationService getAnnotationService(){\r
+           return configuration.getAnnotationService();\r
+       }\r
+\r
+       @Override\r
+       public final INameService getNameService(){\r
+           return configuration.getNameService();\r
+       }\r
+\r
+\r
+       @Override\r
+       public final ITaxonService getTaxonService(){\r
+               return configuration.getTaxonService();\r
+       }\r
+\r
+\r
+       @Override\r
+       public final IClassificationService getClassificationService(){\r
+               return configuration.getClassificationService();\r
+       }\r
+\r
+\r
+       @Override\r
+       public final ITaxonNodeService getTaxonNodeService(){\r
+           try{\r
+               return configuration.getTaxonNodeService();\r
+           } catch (Exception e){\r
+               e.printStackTrace();\r
+           }\r
+           return null;\r
+       }\r
+\r
+\r
+       @Override\r
+       public final IReferenceService getReferenceService(){\r
+               return configuration.getReferenceService();\r
+       }\r
+\r
+\r
+       @Override\r
+       public final IAgentService getAgentService(){\r
+               return configuration.getAgentService();\r
+       }\r
+\r
+\r
+       @Override\r
+       public final IDatabaseService getDatabaseService(){\r
+               return configuration.getDatabaseService();\r
+       }\r
+\r
 \r
-    private IProgressMonitor progressMonitor;\r
+       @Override\r
+       public final ITermService getTermService(){\r
+               return configuration.getTermService();\r
+       }\r
 \r
-    final protected static DbSchemaValidation defaultDbSchemaValidation = DbSchemaValidation.VALIDATE;\r
+\r
+       @Override\r
+       public final IDescriptionService getDescriptionService(){\r
+               return configuration.getDescriptionService();\r
+       }\r
 \r
 \r
+       @Override\r
+       public final IOccurrenceService getOccurrenceService(){\r
+               return configuration.getOccurrenceService();\r
+       }\r
 \r
-    /**\r
-     * Constructor, opens a spring ApplicationContext by using the default data source\r
-     * @throws DataSourceNotFoundException\r
-     */\r
-    public static CdmApplicationController NewInstance() throws DataSourceNotFoundException {\r
-        logger.info("Start CdmApplicationController with default data source");\r
-        CdmPersistentDataSource dataSource = getDefaultDatasource();\r
-        DbSchemaValidation dbSchemaValidation = defaultDbSchemaValidation;\r
-        return CdmApplicationController.NewInstance(null, dataSource, dbSchemaValidation, false);\r
-    }\r
+       @Override\r
+       public IAmplificationService getAmplificationService(){\r
+               return configuration.getAmplificationService();\r
+       }\r
 \r
-    /**\r
-     * Constructor, opens a spring ApplicationContext by using the default data source\r
-     * @param dbSchemaValidation validation type for database schema\r
-     * @throws DataSourceNotFoundException\r
-     */\r
-    public static CdmApplicationController NewInstance(DbSchemaValidation dbSchemaValidation) throws DataSourceNotFoundException {\r
-        logger.info("Start CdmApplicationController with default data source");\r
-        CdmPersistentDataSource dataSource = getDefaultDatasource();\r
-        return CdmApplicationController.NewInstance(null, dataSource, dbSchemaValidation, false);\r
-    }\r
+       @Override\r
+       public ISequenceService getSequenceService(){\r
+               return configuration.getSequenceService();\r
+       }\r
 \r
+       @Override\r
+       public IEventBaseService getEventBaseService() {\r
+           return configuration.getEventBaseService();\r
+       }\r
 \r
-    /**\r
-     * Constructor, opens an spring ApplicationContext by using the according data source and the\r
-     * default database schema validation type\r
-     * @param dataSource\r
-     */\r
-    public static CdmApplicationController NewInstance(ICdmDataSource dataSource) {\r
-        return CdmApplicationController.NewInstance(null, dataSource, defaultDbSchemaValidation, false);\r
-    }\r
 \r
-    public static CdmApplicationController NewInstance(ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation) {\r
-        return CdmApplicationController.NewInstance(null, dataSource, dbSchemaValidation, false);\r
-    }\r
 \r
-    public static CdmApplicationController NewInstance(ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation, boolean omitTermLoading) {\r
-        return CdmApplicationController.NewInstance(null, dataSource, dbSchemaValidation, omitTermLoading);\r
-    }\r
+       @Override\r
+       public final IPrimerService getPrimerService(){\r
+               return configuration.getPrimerService();\r
+       }\r
 \r
-    public static CdmApplicationController NewInstance(Resource applicationContextResource, ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation, boolean omitTermLoading) {\r
-        return CdmApplicationController.NewInstance(applicationContextResource, dataSource, dbSchemaValidation, omitTermLoading, null);\r
-    }\r
 \r
-    public static CdmApplicationController NewInstance(Resource applicationContextResource, ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation, boolean omitTermLoading, IProgressMonitor progressMonitor) {\r
-        return new CdmApplicationController(applicationContextResource, dataSource, dbSchemaValidation, omitTermLoading, progressMonitor, null);\r
-    }\r
+       @Override\r
+       public final IMediaService getMediaService(){\r
+               return configuration.getMediaService();\r
+       }\r
 \r
-    //TODO discuss need for listeners before commit to trunk\r
-//     public static CdmApplicationController NewInstance(Resource applicationContextResource, ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation, boolean omitTermLoading, IProgressMonitor progressMonitor, List<ApplicationListener> listeners) {\r
-//             return new CdmApplicationController(applicationContextResource, dataSource, dbSchemaValidation, omitTermLoading, progressMonitor,listeners);\r
-//     }\r
 \r
-\r
-    /**\r
-     * @return\r
-     */\r
-    protected static ClassPathResource getClasspathResource() {\r
-        return new ClassPathResource(DEFAULT_APPLICATION_CONTEXT_RESOURCE);\r
+    @Override\r
+    public final IMetadataService getMetadataService(){\r
+        return configuration.getMetadataService();\r
     }\r
 \r
-    /**\r
-     * @return\r
-     * @throws DataSourceNotFoundException\r
-     */\r
-    protected static CdmPersistentDataSource getDefaultDatasource() throws DataSourceNotFoundException {\r
-        CdmPersistentDataSource dataSource = CdmPersistentDataSource.NewDefaultInstance();\r
-        return dataSource;\r
-    }\r
 \r
+       @Override\r
+       public final ICommonService getCommonService(){\r
+               return configuration.getCommonService();\r
+       }\r
 \r
-    /**\r
-     * Constructor, opens an spring 2.5 ApplicationContext by using the according data source\r
-     * @param dataSource\r
-     * @param dbSchemaValidation\r
-     * @param omitTermLoading\r
-     */\r
-    protected CdmApplicationController(Resource applicationContextResource, ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation, boolean omitTermLoading, IProgressMonitor progressMonitor, List<ApplicationListener> listeners){\r
-        logger.info("Start CdmApplicationController with datasource: " + dataSource.getName());\r
 \r
-        if (dbSchemaValidation == null){\r
-            dbSchemaValidation = defaultDbSchemaValidation;\r
-        }\r
-        this.applicationContextResource = applicationContextResource != null ? applicationContextResource : getClasspathResource();\r
-        this.progressMonitor = progressMonitor != null ? progressMonitor : new NullProgressMonitor();\r
+       @Override\r
+       public final ILocationService getLocationService(){\r
+               return configuration.getLocationService();\r
+       }\r
 \r
-        setNewDataSource(dataSource, dbSchemaValidation, omitTermLoading, listeners);\r
-    }\r
 \r
+       @Override\r
+       public final IUserService getUserService(){\r
+               return configuration.getUserService();\r
+       }\r
 \r
-    /**\r
-     * Sets the application context to a new spring ApplicationContext by using the according data source and initializes the Controller.\r
-     * @param dataSource\r
-     */\r
-    private boolean setNewDataSource(ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation, boolean omitTermLoading, List<ApplicationListener> listeners){\r
 \r
-        if (dbSchemaValidation == null){\r
-            dbSchemaValidation = defaultDbSchemaValidation;\r
-        }\r
-        logger.info("Connecting to '" + dataSource.getName() + "'");\r
-\r
-        MonitoredGenericApplicationContext applicationContext =  new MonitoredGenericApplicationContext();\r
-        int refreshTasks = 45;\r
-        int nTasks = 5 + refreshTasks;\r
-//             nTasks += applicationContext.countTasks();\r
-        progressMonitor.beginTask("Connecting to '" + dataSource.getName() + "'", nTasks);\r
-\r
-//             progressMonitor.worked(1);\r
-\r
-        BeanDefinition datasourceBean = dataSource.getDatasourceBean();\r
-        datasourceBean.setAttribute("isLazy", false);\r
-        progressMonitor.subTask("Registering datasource.");\r
-        applicationContext.registerBeanDefinition("dataSource", datasourceBean);\r
-        progressMonitor.worked(1);\r
-\r
-        BeanDefinition hibernatePropBean= dataSource.getHibernatePropertiesBean(dbSchemaValidation);\r
-        applicationContext.registerBeanDefinition("hibernateProperties", hibernatePropBean);\r
-\r
-        XmlBeanDefinitionReader xmlReader = new XmlBeanDefinitionReader(applicationContext);\r
-        progressMonitor.subTask("Registering resources.");\r
-        xmlReader.loadBeanDefinitions(applicationContextResource);\r
-        progressMonitor.worked(1);\r
-\r
-        //omitTerms\r
-        if (omitTermLoading == true){\r
-            String initializerName = "persistentTermInitializer";\r
-            BeanDefinition beanDef = applicationContext.getBeanDefinition(initializerName);\r
-            MutablePropertyValues values = beanDef.getPropertyValues();\r
-            values.addPropertyValue("omit", omitTermLoading);\r
-        }\r
+       @Override\r
+       public final IGrantedAuthorityService getGrantedAuthorityService(){\r
+               return configuration.getGrantedAuthorityService();\r
+       }\r
 \r
-        if (listeners != null){\r
-            for(ApplicationListener listener : listeners){\r
-                applicationContext.addApplicationListener(listener);\r
-            }\r
-        }\r
 \r
-//             String message = "Start application context. This might take a while ...";\r
-////           progressMonitor.subTask(message);\r
-//             SubProgressMonitor subMonitor= new SubProgressMonitor(progressMonitor, 10);\r
-//             subMonitor.beginTask(message, 2);\r
-//             applicationContext.setProgressMonitor(subMonitor);\r
+       @Override\r
+       public IGroupService getGroupService(){\r
+               return configuration.getGroupService();\r
+       }\r
 \r
-        applicationContext.refresh(new SubProgressMonitor(progressMonitor, refreshTasks));\r
-        applicationContext.start();\r
-//             progressMonitor.worked(1);\r
 \r
-        progressMonitor.subTask("Cleaning up.");\r
-        setApplicationContext(applicationContext);\r
-        progressMonitor.worked(1);\r
+       @Override\r
+       public final ICollectionService getCollectionService(){\r
+               return configuration.getCollectionService();\r
+       }\r
 \r
-        progressMonitor.done();\r
-        return true;\r
-    }\r
 \r
+       @Override\r
+       public final IFeatureTreeService getFeatureTreeService(){\r
+               return configuration.getFeatureTreeService();\r
+       }\r
 \r
+       @Override\r
+       public final IPreferenceService getPreferenceService(){\r
+           return configuration.getPreferenceService();\r
+       }\r
 \r
 \r
+       @Override\r
+       public final IFeatureNodeService getFeatureNodeService(){\r
+               return configuration.getFeatureNodeService();\r
+       }\r
 \r
-    /**\r
-     * Tests if some DefinedTermsAreMissing.\r
-     * @return true, if at least one is missing, else false\r
-     */\r
-    public boolean testDefinedTermsAreMissing(){\r
-        UUID englishUuid = UUID.fromString("e9f8cdb7-6819-44e8-95d3-e2d0690c3523");\r
-        DefinedTermBase<?> english = this.getTermService().load(englishUuid);\r
-        if ( english == null || ! english.getUuid().equals(englishUuid)){\r
-            return true;\r
-        }else{\r
-            return false;\r
-        }\r
-    }\r
 \r
+       @Override\r
+       public final IVocabularyService getVocabularyService(){\r
+               return configuration.getVocabularyService();\r
+       }\r
 \r
-    /**\r
-     * Changes the ApplicationContext to the new dataSource\r
-     * @param dataSource\r
-     */\r
-    public boolean changeDataSource(ICdmDataSource dataSource){\r
-        //logger.info("Change datasource to : " + dataSource);\r
-        return setNewDataSource(dataSource, DbSchemaValidation.VALIDATE, false, null);\r
-    }\r
 \r
-    /**\r
-     * Changes the ApplicationContext to the new dataSource\r
-     * @param dataSource\r
-     * @param dbSchemaValidation\r
-     */\r
-    public boolean changeDataSource(ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation){\r
-        //logger.info("Change datasource to : " + dataSource);\r
-        return setNewDataSource(dataSource, dbSchemaValidation, false, null);\r
-    }\r
+       @Override\r
+       public final IIdentificationKeyService getIdentificationKeyService(){\r
+               return configuration.getIdentificationKeyService();\r
+       }\r
 \r
-    /**\r
-     * Changes the ApplicationContext to the new dataSource\r
-     * @param dataSource\r
-     * @param dbSchemaValidation\r
-     * @param omitTermLoading\r
-     */\r
-    public boolean changeDataSource(ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation, boolean omitTermLoading){\r
-        logger.info("Change datasource to : " + dataSource);\r
-        return setNewDataSource(dataSource, dbSchemaValidation, omitTermLoading, null);\r
-    }\r
 \r
-    /**\r
-     * Changes the ApplicationContext to the new dataSource\r
-     * @param dataSource\r
-     * @param dbSchemaValidation\r
-     * @param omitTermLoading\r
-     */\r
-    public boolean changeDataSource(ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation, boolean omitTermLoading, List<ApplicationListener> listeners){\r
-        logger.info("Change datasource to : " + dataSource);\r
-        return setNewDataSource(dataSource, dbSchemaValidation, omitTermLoading, listeners);\r
-    }\r
+       @Override\r
+       public final IPolytomousKeyService getPolytomousKeyService(){\r
+               return configuration.getPolytomousKeyService();\r
+       }\r
 \r
-    /**\r
-     * Sets a new application Context.\r
-     * @param ac\r
-     */\r
-    public void setApplicationContext(AbstractApplicationContext ac){\r
-        closeApplicationContext(); //closes old application context if necessary\r
-        applicationContext = ac;\r
-        applicationContext.registerShutdownHook();\r
-        init();\r
-    }\r
 \r
-    /* (non-Javadoc)\r
-     * @see java.lang.Object#finalize()\r
-     */\r
-    public void finalize(){\r
-        close();\r
-    }\r
+       @Override\r
+       public final IPolytomousKeyNodeService getPolytomousKeyNodeService(){\r
+               return configuration.getPolytomousKeyNodeService();\r
+       }\r
 \r
-    /**\r
-     * closes the application\r
-     */\r
-    public void close(){\r
-        closeApplicationContext();\r
-    }\r
 \r
     /**\r
-     * closes the application context\r
+     * {@inheritDoc}\r
      */\r
-    protected void closeApplicationContext(){\r
-        if (applicationContext != null){\r
-            logger.info("Close ApplicationContext");\r
-            applicationContext.close();\r
-        }\r
+    @Override\r
+    public IProgressMonitorService getProgressMonitorService() {\r
+        return configuration.getProgressMonitorService();\r
     }\r
 \r
-    protected void init(){\r
-        logger.debug("Init " +  this.getClass().getName() + " ... ");\r
-        if (logger.isDebugEnabled()){for (String beanName : applicationContext.getBeanDefinitionNames()){ logger.debug(beanName);}}\r
-        //TODO delete next row (was just for testing)\r
-        if (logger.isInfoEnabled()){\r
-            logger.info("Registered Beans: ");\r
-            String[] beanNames = applicationContext.getBeanDefinitionNames();\r
-            for (String beanName : beanNames){\r
-                logger.info(beanName);\r
-            }\r
-        }\r
-        configuration = (ICdmApplicationConfiguration)applicationContext.getBean("cdmApplicationDefaultConfiguration");\r
-        getDatabaseService().setApplicationController(this);\r
-    }\r
 \r
+       @Override\r
+       public IEntityValidationService getEntityValidationService(){\r
+               return configuration.getEntityValidationService();\r
+       }\r
 \r
 \r
-    /* ******  Services *********/\r
-    public final INameService getNameService(){\r
-        return configuration.getNameService();\r
-    }\r
+       @Override\r
+       public IEntityConstraintViolationService getEntityConstraintViolationService(){\r
+               return configuration.getEntityConstraintViolationService();\r
+       }\r
 \r
-    public final ITaxonService getTaxonService(){\r
-        return configuration.getTaxonService();\r
-    }\r
+       @Override\r
+       public final IDescriptiveDataSetService getDescriptiveDataSetService(){\r
+               return configuration.getDescriptiveDataSetService();\r
+       }\r
 \r
-    public final IClassificationService getClassificationService(){\r
-        return configuration.getClassificationService();\r
-    }\r
 \r
-    public final ITaxonNodeService getTaxonNodeService(){\r
-        return configuration.getTaxonNodeService();\r
-    }\r
+       @Override\r
+       public final ConversationHolder NewConversation(){\r
+               //return (ConversationHolder)applicationContext.getBean("conversationHolder");\r
+               return configuration.NewConversation();\r
+       }\r
 \r
-    public final IReferenceService getReferenceService(){\r
-        return configuration.getReferenceService();\r
-    }\r
 \r
-    public final IAgentService getAgentService(){\r
-        return configuration.getAgentService();\r
-    }\r
+       /* **** Security ***** */\r
 \r
-    public final IDatabaseService getDatabaseService(){\r
-        return configuration.getDatabaseService();\r
-    }\r
+       @Override\r
+       public void authenticate(String username, String password){\r
+               UsernamePasswordAuthenticationToken tokenForUser = new UsernamePasswordAuthenticationToken(username, password);\r
+               Authentication authentication = this.getAuthenticationManager().authenticate(tokenForUser);\r
+               SecurityContext context = SecurityContextHolder.getContext();\r
+               context.setAuthentication(authentication);\r
+       }\r
 \r
-    public final ITermService getTermService(){\r
-        return configuration.getTermService();\r
-    }\r
+       @Override\r
+       public final ProviderManager getAuthenticationManager(){\r
+               return configuration.getAuthenticationManager();\r
+       }\r
 \r
-    public final IDescriptionService getDescriptionService(){\r
-        return configuration.getDescriptionService();\r
-    }\r
 \r
-    public final IOccurrenceService getOccurrenceService(){\r
-        return configuration.getOccurrenceService();\r
-    }\r
+       @Override\r
+       public ICdmPermissionEvaluator getPermissionEvaluator(){\r
+               return configuration.getPermissionEvaluator();\r
+       }\r
 \r
-    public final IMediaService getMediaService(){\r
-        return configuration.getMediaService();\r
-    }\r
+       /**\r
+        * @see org.springframework.security.access.PermissionEvaluator#hasPermission(org.springframework.security.core.Authentication,\r
+        *      java.lang.Object, java.lang.Object)\r
+        *\r
+        * @param targetDomainObject\r
+        * @param permission\r
+        * @return\r
+        */\r
+       public boolean currentAuthentiationHasPermissions(CdmBase targetDomainObject, EnumSet<CRUD> permission){\r
+               SecurityContext context = SecurityContextHolder.getContext();\r
+               return getPermissionEvaluator().hasPermission(context.getAuthentication(), targetDomainObject, permission);\r
+       }\r
 \r
-    public final ICommonService getCommonService(){\r
-        return configuration.getCommonService();\r
-    }\r
 \r
-    public final ILocationService getLocationService(){\r
-        return configuration.getLocationService();\r
-    }\r
+       @Override\r
+       public final PlatformTransactionManager getTransactionManager(){\r
+               return configuration.getTransactionManager();\r
+       }\r
 \r
-    public final IUserService getUserService(){\r
-        return configuration.getUserService();\r
-    }\r
 \r
-    public final IGrantedAuthorityService getGrantedAuthorityService(){\r
-        return configuration.getGrantedAuthorityService();\r
-    }\r
+       @Override\r
+       public final Object getBean(String name){\r
+               return this.applicationContext.getBean(name);\r
+       }\r
 \r
-    public IGroupService getGroupService() {\r
-        return configuration.getGroupService();\r
-    }\r
 \r
-    public final ICollectionService getCollectionService(){\r
-        return configuration.getCollectionService();\r
-    }\r
+       /*\r
+        * OLD TRANSACTION STUFF\r
+        */\r
 \r
-    public final IFeatureTreeService getFeatureTreeService(){\r
-        return configuration.getFeatureTreeService();\r
-    }\r
+       /* **** flush ********** */\r
+       public void flush(){\r
+               SessionFactory sf = (SessionFactory) applicationContext.getBean("sessionFactory");\r
+               sf.getCurrentSession().flush();\r
+       }\r
 \r
-    public final IFeatureNodeService getFeatureNodeService(){\r
-        return configuration.getFeatureNodeService();\r
-    }\r
 \r
-    public final IVocabularyService getVocabularyService(){\r
-        return configuration.getVocabularyService();\r
-    }\r
+       public SessionFactory getSessionFactory(){\r
+               return (SessionFactory) applicationContext.getBean("sessionFactory");\r
+       }\r
 \r
-    public final IIdentificationKeyService getIdentificationKeyService(){\r
-        return configuration.getIdentificationKeyService();\r
-    }\r
 \r
-    public final IPolytomousKeyService getPolytomousKeyService(){\r
-        return configuration.getPolytomousKeyService();\r
-    }\r
+       @Override\r
+       public TransactionStatus startTransaction(){\r
+               return startTransaction(false);\r
+       }\r
 \r
-    public final IPolytomousKeyNodeService getPolytomousKeyNodeService(){\r
-        return configuration.getPolytomousKeyNodeService();\r
-    }\r
-\r
-    public final IService<CdmBase> getMainService(){\r
-        return configuration.getMainService();\r
-    }\r
-\r
-    public final IWorkingSetService getWorkingSetService(){\r
-        return configuration.getWorkingSetService();\r
-    }\r
-\r
-    public final ConversationHolder NewConversation(){\r
-        //return (ConversationHolder)applicationContext.getBean("conversationHolder");\r
-        return configuration.NewConversation();\r
-    }\r
 \r
+       @Override\r
+       public TransactionStatus startTransaction(Boolean readOnly){\r
+               return configuration.startTransaction(readOnly);\r
+       }\r
 \r
-    /* **** Security ***** */\r
+       @Override\r
+       public void commitTransaction(TransactionStatus txStatus){\r
+               PlatformTransactionManager txManager = configuration.getTransactionManager();\r
+               txManager.commit(txStatus);\r
+               return;\r
+       }\r
 \r
-    /* (non-Javadoc)\r
-     * @see eu.etaxonomy.cdm.api.application.ICdmApplicationConfiguration#getAuthenticationManager()\r
-     */\r
-    public final ProviderManager getAuthenticationManager(){\r
-        return configuration.getAuthenticationManager();\r
-    }\r
-\r
-\r
-    public PermissionEvaluator getPermissionEvaluator() {\r
-        return configuration.getPermissionEvaluator();\r
-    }\r
 \r
     /**\r
-     * @see org.springframework.security.access.PermissionEvaluator#hasPermission(org.springframework.security.core.Authentication, java.lang.Object, java.lang.Object)\r
-     *\r
-     * @param targetDomainObject\r
-     * @param permission\r
-     * @return\r
+     * {@inheritDoc}\r
      */\r
-    public boolean currentAuthentiationHasPermissions(CdmBase targetDomainObject, EnumSet<CRUD> permission){\r
-        SecurityContext context = SecurityContextHolder.getContext();\r
-        return getPermissionEvaluator().hasPermission(context.getAuthentication(), targetDomainObject, permission);\r
-    }\r
-\r
-\r
     @Override\r
-    public final PlatformTransactionManager getTransactionManager() {\r
-        return configuration.getTransactionManager();\r
+    public IRightsService getRightsService() {\r
+        return configuration.getRightsService();\r
     }\r
 \r
-    public final Object getBean(String name){\r
-        return this.applicationContext.getBean(name);\r
-    }\r
 \r
-    /*\r
-     * OLD TRANSACTION STUFF\r
+    /**\r
+     * {@inheritDoc}\r
      */\r
-\r
-    /* **** flush ***********/\r
-    public void flush() {\r
-        SessionFactory sf = (SessionFactory)applicationContext.getBean("sessionFactory");\r
-        sf.getCurrentSession().flush();\r
-    }\r
-\r
-    public SessionFactory getSessionFactory(){\r
-        return (SessionFactory)applicationContext.getBean("sessionFactory");\r
-    }\r
-\r
-    public TransactionStatus startTransaction() {\r
-        return startTransaction(false);\r
-    }\r
-\r
-    public TransactionStatus startTransaction(Boolean readOnly) {\r
-        return configuration.startTransaction(readOnly);\r
-    }\r
-\r
-    public void commitTransaction(TransactionStatus txStatus){\r
-        PlatformTransactionManager txManager = configuration.getTransactionManager();\r
-        txManager.commit(txStatus);\r
-        return;\r
+    @Override\r
+    public IRegistrationService getRegistrationService() {\r
+        return configuration.getRegistrationService();\r
     }\r
 \r
 }\r
+\r