cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/application/CdmApplicationController.java

   1 // $Id$
   2 /**
   3  * Copyright (C) 2007 EDIT
   4  * European Distributed Institute of Taxonomy
   5  * http://www.e-taxonomy.eu
   6  *
   7  * The contents of this file are subject to the Mozilla Public License Version 1.1
   8  * See LICENSE.TXT at the top of this package for the full license terms.
   9  */
  10
  11
  12 package eu.etaxonomy.cdm.api.application;
  13
  14 import java.util.EnumSet;
  15 import java.util.List;
  16 import java.util.UUID;
  17
  18 import org.apache.log4j.Logger;
  19 import org.hibernate.SessionFactory;
  20 import org.springframework.beans.MutablePropertyValues;
  21 import org.springframework.beans.factory.config.BeanDefinition;
  22 import org.springframework.beans.factory.xml.XmlBeanDefinitionReader;
  23 import org.springframework.context.ApplicationListener;
  24 import org.springframework.context.support.AbstractApplicationContext;
  25 import org.springframework.core.io.ClassPathResource;
  26 import org.springframework.core.io.Resource;
  27 import org.springframework.security.authentication.ProviderManager;
  28 import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
  29 import org.springframework.security.core.Authentication;
  30 import org.springframework.security.core.context.SecurityContext;
  31 import org.springframework.security.core.context.SecurityContextHolder;
  32 import org.springframework.transaction.PlatformTransactionManager;
  33 import org.springframework.transaction.TransactionStatus;
  34
  35 import eu.etaxonomy.cdm.api.conversation.ConversationHolder;
  36 import eu.etaxonomy.cdm.api.service.IAgentService;
  37 import eu.etaxonomy.cdm.api.service.IClassificationService;
  38 import eu.etaxonomy.cdm.api.service.ICollectionService;
  39 import eu.etaxonomy.cdm.api.service.ICommonService;
  40 import eu.etaxonomy.cdm.api.service.IDatabaseService;
  41 import eu.etaxonomy.cdm.api.service.IDescriptionService;
  42 import eu.etaxonomy.cdm.api.service.IFeatureNodeService;
  43 import eu.etaxonomy.cdm.api.service.IFeatureTreeService;
  44 import eu.etaxonomy.cdm.api.service.IGrantedAuthorityService;
  45 import eu.etaxonomy.cdm.api.service.IGroupService;
  46 import eu.etaxonomy.cdm.api.service.IIdentificationKeyService;
  47 import eu.etaxonomy.cdm.api.service.ILocationService;
  48 import eu.etaxonomy.cdm.api.service.IMediaService;
  49 import eu.etaxonomy.cdm.api.service.INameService;
  50 import eu.etaxonomy.cdm.api.service.IOccurrenceService;
  51 import eu.etaxonomy.cdm.api.service.IPolytomousKeyNodeService;
  52 import eu.etaxonomy.cdm.api.service.IPolytomousKeyService;
  53 import eu.etaxonomy.cdm.api.service.IReferenceService;
  54 import eu.etaxonomy.cdm.api.service.IService;
  55 import eu.etaxonomy.cdm.api.service.ITaxonNodeService;
  56 import eu.etaxonomy.cdm.api.service.ITaxonService;
  57 import eu.etaxonomy.cdm.api.service.ITermService;
  58 import eu.etaxonomy.cdm.api.service.IUserService;
  59 import eu.etaxonomy.cdm.api.service.IVocabularyService;
  60 import eu.etaxonomy.cdm.api.service.IWorkingSetService;
  61 import eu.etaxonomy.cdm.common.monitor.IProgressMonitor;
  62 import eu.etaxonomy.cdm.common.monitor.NullProgressMonitor;
  63 import eu.etaxonomy.cdm.common.monitor.SubProgressMonitor;
  64 import eu.etaxonomy.cdm.database.CdmPersistentDataSource;
  65 import eu.etaxonomy.cdm.database.DataSourceNotFoundException;
  66 import eu.etaxonomy.cdm.database.DbSchemaValidation;
  67 import eu.etaxonomy.cdm.database.ICdmDataSource;
  68 import eu.etaxonomy.cdm.model.common.CdmBase;
  69 import eu.etaxonomy.cdm.model.common.DefinedTermBase;
  70 import eu.etaxonomy.cdm.persistence.hibernate.permission.CRUD;
  71 import eu.etaxonomy.cdm.persistence.hibernate.permission.ICdmPermissionEvaluator;
  72
  73
  74 /**
  75  * @author a.mueller
  76  *
  77  */
  78 public class CdmApplicationController implements ICdmApplicationConfiguration{
  79     private static final Logger logger = Logger.getLogger(CdmApplicationController.class);
  80
  81     public static final String DEFAULT_APPLICATION_CONTEXT_RESOURCE = "/eu/etaxonomy/cdm/defaultApplicationContext.xml";
  82
  83     public AbstractApplicationContext applicationContext;
  84     private ICdmApplicationConfiguration configuration;
  85     private Resource applicationContextResource;
  86
  87     private IProgressMonitor progressMonitor;
  88
  89     final protected static DbSchemaValidation defaultDbSchemaValidation = DbSchemaValidation.VALIDATE;
  90
  91
  92
  93     /**
  94      * Constructor, opens a spring ApplicationContext by using the default data source
  95      * @throws DataSourceNotFoundException
  96      */
  97     public static CdmApplicationController NewInstance() throws DataSourceNotFoundException {
  98         logger.info("Start CdmApplicationController with default data source");
  99         CdmPersistentDataSource dataSource = getDefaultDatasource();
 100         DbSchemaValidation dbSchemaValidation = defaultDbSchemaValidation;
 101         return CdmApplicationController.NewInstance(null, dataSource, dbSchemaValidation, false);
 102     }
 103
 104     /**
 105      * Constructor, opens a spring ApplicationContext by using the default data source
 106      * @param dbSchemaValidation validation type for database schema
 107      * @throws DataSourceNotFoundException
 108      */
 109     public static CdmApplicationController NewInstance(DbSchemaValidation dbSchemaValidation) throws DataSourceNotFoundException {
 110         logger.info("Start CdmApplicationController with default data source");
 111         CdmPersistentDataSource dataSource = getDefaultDatasource();
 112         return CdmApplicationController.NewInstance(null, dataSource, dbSchemaValidation, false);
 113     }
 114
 115
 116     /**
 117      * Constructor, opens an spring ApplicationContext by using the according data source and the
 118      * default database schema validation type
 119      * @param dataSource
 120      */
 121     public static CdmApplicationController NewInstance(ICdmDataSource dataSource) {
 122         return CdmApplicationController.NewInstance(null, dataSource, defaultDbSchemaValidation, false);
 123     }
 124
 125     public static CdmApplicationController NewInstance(ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation) {
 126         return CdmApplicationController.NewInstance(null, dataSource, dbSchemaValidation, false);
 127     }
 128
 129     public static CdmApplicationController NewInstance(ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation, boolean omitTermLoading) {
 130         return CdmApplicationController.NewInstance(null, dataSource, dbSchemaValidation, omitTermLoading);
 131     }
 132
 133     public static CdmApplicationController NewInstance(Resource applicationContextResource, ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation, boolean omitTermLoading) {
 134         return CdmApplicationController.NewInstance(applicationContextResource, dataSource, dbSchemaValidation, omitTermLoading, null);
 135     }
 136
 137     public static CdmApplicationController NewInstance(Resource applicationContextResource, ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation, boolean omitTermLoading, IProgressMonitor progressMonitor) {
 138         return new CdmApplicationController(applicationContextResource, dataSource, dbSchemaValidation, omitTermLoading, progressMonitor, null);
 139     }
 140
 141     //TODO discuss need for listeners before commit to trunk
 142 //      public static CdmApplicationController NewInstance(Resource applicationContextResource, ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation, boolean omitTermLoading, IProgressMonitor progressMonitor, List<ApplicationListener> listeners) {
 143 //              return new CdmApplicationController(applicationContextResource, dataSource, dbSchemaValidation, omitTermLoading, progressMonitor,listeners);
 144 //      }
 145
 146
 147     /**
 148      * @return
 149      */
 150     protected static ClassPathResource getClasspathResource() {
 151         return new ClassPathResource(DEFAULT_APPLICATION_CONTEXT_RESOURCE);
 152     }
 153
 154     /**
 155      * @return
 156      * @throws DataSourceNotFoundException
 157      */
 158     protected static CdmPersistentDataSource getDefaultDatasource() throws DataSourceNotFoundException {
 159         CdmPersistentDataSource dataSource = CdmPersistentDataSource.NewDefaultInstance();
 160         return dataSource;
 161     }
 162
 163
 164     /**
 165      * Constructor, opens an spring 2.5 ApplicationContext by using the according data source
 166      * @param dataSource
 167      * @param dbSchemaValidation
 168      * @param omitTermLoading
 169      */
 170     protected CdmApplicationController(Resource applicationContextResource, ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation, boolean omitTermLoading, IProgressMonitor progressMonitor, List<ApplicationListener> listeners){
 171         logger.info("Start CdmApplicationController with datasource: " + dataSource.getName());
 172
 173         if (dbSchemaValidation == null){
 174             dbSchemaValidation = defaultDbSchemaValidation;
 175         }
 176         this.applicationContextResource = applicationContextResource != null ? applicationContextResource : getClasspathResource();
 177         this.progressMonitor = progressMonitor != null ? progressMonitor : new NullProgressMonitor();
 178
 179         setNewDataSource(dataSource, dbSchemaValidation, omitTermLoading, listeners);
 180     }
 181
 182
 183     /**
 184      * Sets the application context to a new spring ApplicationContext by using the according data source and initializes the Controller.
 185      * @param dataSource
 186      */
 187     private boolean setNewDataSource(ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation, boolean omitTermLoading, List<ApplicationListener> listeners){
 188
 189         if (dbSchemaValidation == null){
 190             dbSchemaValidation = defaultDbSchemaValidation;
 191         }
 192         logger.info("Connecting to '" + dataSource.getName() + "'");
 193
 194         MonitoredGenericApplicationContext applicationContext =  new MonitoredGenericApplicationContext();
 195         int refreshTasks = 45;
 196         int nTasks = 5 + refreshTasks;
 197 //              nTasks += applicationContext.countTasks();
 198         progressMonitor.beginTask("Connecting to '" + dataSource.getName() + "'", nTasks);
 199
 200 //              progressMonitor.worked(1);
 201
 202         BeanDefinition datasourceBean = dataSource.getDatasourceBean();
 203         datasourceBean.setAttribute("isLazy", false);
 204         progressMonitor.subTask("Registering datasource.");
 205         applicationContext.registerBeanDefinition("dataSource", datasourceBean);
 206         progressMonitor.worked(1);
 207
 208         BeanDefinition hibernatePropBean= dataSource.getHibernatePropertiesBean(dbSchemaValidation);
 209         applicationContext.registerBeanDefinition("hibernateProperties", hibernatePropBean);
 210
 211         XmlBeanDefinitionReader xmlReader = new XmlBeanDefinitionReader(applicationContext);
 212         progressMonitor.subTask("Registering resources.");
 213         xmlReader.loadBeanDefinitions(applicationContextResource);
 214         progressMonitor.worked(1);
 215
 216         //omitTerms
 217         if (omitTermLoading == true){
 218             String initializerName = "persistentTermInitializer";
 219             BeanDefinition beanDef = applicationContext.getBeanDefinition(initializerName);
 220             MutablePropertyValues values = beanDef.getPropertyValues();
 221             values.addPropertyValue("omit", omitTermLoading);
 222         }
 223
 224         if (listeners != null){
 225             for(ApplicationListener listener : listeners){
 226                 applicationContext.addApplicationListener(listener);
 227             }
 228         }
 229
 230 //              String message = "Start application context. This might take a while ...";
 231 ////            progressMonitor.subTask(message);
 232 //              SubProgressMonitor subMonitor= new SubProgressMonitor(progressMonitor, 10);
 233 //              subMonitor.beginTask(message, 2);
 234 //              applicationContext.setProgressMonitor(subMonitor);
 235
 236         applicationContext.refresh(new SubProgressMonitor(progressMonitor, refreshTasks));
 237         applicationContext.start();
 238 //              progressMonitor.worked(1);
 239
 240         progressMonitor.subTask("Cleaning up.");
 241         setApplicationContext(applicationContext);
 242         progressMonitor.worked(1);
 243
 244         progressMonitor.done();
 245         return true;
 246     }
 247
 248
 249
 250
 251
 252     /**
 253      * Tests if some DefinedTermsAreMissing.
 254      * @return true, if at least one is missing, else false
 255      */
 256     public boolean testDefinedTermsAreMissing(){
 257         UUID englishUuid = UUID.fromString("e9f8cdb7-6819-44e8-95d3-e2d0690c3523");
 258         DefinedTermBase<?> english = this.getTermService().load(englishUuid);
 259         if ( english == null || ! english.getUuid().equals(englishUuid)){
 260             return true;
 261         }else{
 262             return false;
 263         }
 264     }
 265
 266
 267     /**
 268      * Changes the ApplicationContext to the new dataSource
 269      * @param dataSource
 270      */
 271     public boolean changeDataSource(ICdmDataSource dataSource){
 272         //logger.info("Change datasource to : " + dataSource);
 273         return setNewDataSource(dataSource, DbSchemaValidation.VALIDATE, false, null);
 274     }
 275
 276     /**
 277      * Changes the ApplicationContext to the new dataSource
 278      * @param dataSource
 279      * @param dbSchemaValidation
 280      */
 281     public boolean changeDataSource(ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation){
 282         //logger.info("Change datasource to : " + dataSource);
 283         return setNewDataSource(dataSource, dbSchemaValidation, false, null);
 284     }
 285
 286     /**
 287      * Changes the ApplicationContext to the new dataSource
 288      * @param dataSource
 289      * @param dbSchemaValidation
 290      * @param omitTermLoading
 291      */
 292     public boolean changeDataSource(ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation, boolean omitTermLoading){
 293         logger.info("Change datasource to : " + dataSource);
 294         return setNewDataSource(dataSource, dbSchemaValidation, omitTermLoading, null);
 295     }
 296
 297     /**
 298      * Changes the ApplicationContext to the new dataSource
 299      * @param dataSource
 300      * @param dbSchemaValidation
 301      * @param omitTermLoading
 302      */
 303     public boolean changeDataSource(ICdmDataSource dataSource, DbSchemaValidation dbSchemaValidation, boolean omitTermLoading, List<ApplicationListener> listeners){
 304         logger.info("Change datasource to : " + dataSource);
 305         return setNewDataSource(dataSource, dbSchemaValidation, omitTermLoading, listeners);
 306     }
 307
 308     /**
 309      * Sets a new application Context.
 310      * @param ac
 311      */
 312     public void setApplicationContext(AbstractApplicationContext ac){
 313         closeApplicationContext(); //closes old application context if necessary
 314         applicationContext = ac;
 315         applicationContext.registerShutdownHook();
 316         init();
 317     }
 318
 319     /* (non-Javadoc)
 320      * @see java.lang.Object#finalize()
 321      */
 322     public void finalize(){
 323         close();
 324     }
 325
 326     /**
 327      * closes the application
 328      */
 329     public void close(){
 330         closeApplicationContext();
 331     }
 332
 333     /**
 334      * closes the application context
 335      */
 336     protected void closeApplicationContext(){
 337         if (applicationContext != null){
 338             logger.info("Close ApplicationContext");
 339             applicationContext.close();
 340         }
 341     }
 342
 343     protected void init(){
 344         logger.debug("Init " +  this.getClass().getName() + " ... ");
 345         if (logger.isDebugEnabled()){for (String beanName : applicationContext.getBeanDefinitionNames()){ logger.debug(beanName);}}
 346         //TODO delete next row (was just for testing)
 347         if (logger.isInfoEnabled()){
 348             logger.info("Registered Beans: ");
 349             String[] beanNames = applicationContext.getBeanDefinitionNames();
 350             for (String beanName : beanNames){
 351                 logger.info(beanName);
 352             }
 353         }
 354         configuration = (ICdmApplicationConfiguration)applicationContext.getBean("cdmApplicationDefaultConfiguration");
 355         getDatabaseService().setApplicationController(this);
 356     }
 357
 358
 359
 360     /* ******  Services *********/
 361     public final INameService getNameService(){
 362         return configuration.getNameService();
 363     }
 364
 365     public final ITaxonService getTaxonService(){
 366         return configuration.getTaxonService();
 367     }
 368
 369     public final IClassificationService getClassificationService(){
 370         return configuration.getClassificationService();
 371     }
 372
 373     public final ITaxonNodeService getTaxonNodeService(){
 374         return configuration.getTaxonNodeService();
 375     }
 376
 377     public final IReferenceService getReferenceService(){
 378         return configuration.getReferenceService();
 379     }
 380
 381     public final IAgentService getAgentService(){
 382         return configuration.getAgentService();
 383     }
 384
 385     public final IDatabaseService getDatabaseService(){
 386         return configuration.getDatabaseService();
 387     }
 388
 389     public final ITermService getTermService(){
 390         return configuration.getTermService();
 391     }
 392
 393     public final IDescriptionService getDescriptionService(){
 394         return configuration.getDescriptionService();
 395     }
 396
 397     public final IOccurrenceService getOccurrenceService(){
 398         return configuration.getOccurrenceService();
 399     }
 400
 401     public final IMediaService getMediaService(){
 402         return configuration.getMediaService();
 403     }
 404
 405     public final ICommonService getCommonService(){
 406         return configuration.getCommonService();
 407     }
 408
 409     public final ILocationService getLocationService(){
 410         return configuration.getLocationService();
 411     }
 412
 413     public final IUserService getUserService(){
 414         return configuration.getUserService();
 415     }
 416
 417     public final IGrantedAuthorityService getGrantedAuthorityService(){
 418         return configuration.getGrantedAuthorityService();
 419     }
 420
 421     public IGroupService getGroupService() {
 422         return configuration.getGroupService();
 423     }
 424
 425     public final ICollectionService getCollectionService(){
 426         return configuration.getCollectionService();
 427     }
 428
 429     public final IFeatureTreeService getFeatureTreeService(){
 430         return configuration.getFeatureTreeService();
 431     }
 432
 433     public final IFeatureNodeService getFeatureNodeService(){
 434         return configuration.getFeatureNodeService();
 435     }
 436
 437     public final IVocabularyService getVocabularyService(){
 438         return configuration.getVocabularyService();
 439     }
 440
 441     public final IIdentificationKeyService getIdentificationKeyService(){
 442         return configuration.getIdentificationKeyService();
 443     }
 444
 445     public final IPolytomousKeyService getPolytomousKeyService(){
 446         return configuration.getPolytomousKeyService();
 447     }
 448
 449     public final IPolytomousKeyNodeService getPolytomousKeyNodeService(){
 450         return configuration.getPolytomousKeyNodeService();
 451     }
 452
 453     public final IService<CdmBase> getMainService(){
 454         return configuration.getMainService();
 455     }
 456
 457     public final IWorkingSetService getWorkingSetService(){
 458         return configuration.getWorkingSetService();
 459     }
 460
 461     public final ConversationHolder NewConversation(){
 462         //return (ConversationHolder)applicationContext.getBean("conversationHolder");
 463         return configuration.NewConversation();
 464     }
 465
 466
 467     /* **** Security ***** */
 468
 469
 470     /* (non-Javadoc)
 471      * @see eu.etaxonomy.cdm.api.application.ICdmApplicationConfiguration#authenticate(java.lang.String, java.lang.String)
 472      */
 473     @Override
 474         public void authenticate(String username, String password){
 475                 UsernamePasswordAuthenticationToken tokenForUser = new UsernamePasswordAuthenticationToken(username, password);
 476                 Authentication authentication = this.getAuthenticationManager().authenticate(tokenForUser);
 477         SecurityContext context = SecurityContextHolder.getContext();
 478         context.setAuthentication(authentication);
 479         }
 480
 481
 482     /* (non-Javadoc)
 483      * @see eu.etaxonomy.cdm.api.application.ICdmApplicationConfiguration#getAuthenticationManager()
 484      */
 485     public final ProviderManager getAuthenticationManager(){
 486         return configuration.getAuthenticationManager();
 487     }
 488
 489
 490     public ICdmPermissionEvaluator getPermissionEvaluator() {
 491         return configuration.getPermissionEvaluator();
 492     }
 493
 494     /**
 495      * @see org.springframework.security.access.PermissionEvaluator#hasPermission(org.springframework.security.core.Authentication, java.lang.Object, java.lang.Object)
 496      *
 497      * @param targetDomainObject
 498      * @param permission
 499      * @return
 500      */
 501     public boolean currentAuthentiationHasPermissions(CdmBase targetDomainObject, EnumSet<CRUD> permission){
 502         SecurityContext context = SecurityContextHolder.getContext();
 503         return getPermissionEvaluator().hasPermission(context.getAuthentication(), targetDomainObject, permission);
 504     }
 505
 506
 507     @Override
 508     public final PlatformTransactionManager getTransactionManager() {
 509         return configuration.getTransactionManager();
 510     }
 511
 512     public final Object getBean(String name){
 513         return this.applicationContext.getBean(name);
 514     }
 515
 516     /*
 517      * OLD TRANSACTION STUFF
 518      */
 519
 520     /* **** flush ***********/
 521     public void flush() {
 522         SessionFactory sf = (SessionFactory)applicationContext.getBean("sessionFactory");
 523         sf.getCurrentSession().flush();
 524     }
 525
 526     public SessionFactory getSessionFactory(){
 527         return (SessionFactory)applicationContext.getBean("sessionFactory");
 528     }
 529
 530     public TransactionStatus startTransaction() {
 531         return startTransaction(false);
 532     }
 533
 534     public TransactionStatus startTransaction(Boolean readOnly) {
 535         return configuration.startTransaction(readOnly);
 536     }
 537
 538     public void commitTransaction(TransactionStatus txStatus){
 539         PlatformTransactionManager txManager = configuration.getTransactionManager();
 540         txManager.commit(txStatus);
 541         return;
 542     }
 543
 544 }