3 * Copyright (C) 2007 EDIT
4 * European Distributed Institute of Taxonomy
5 * http://www.e-taxonomy.eu
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.
12 package eu
.etaxonomy
.cdm
.api
.application
;
14 import java
.util
.EnumSet
;
15 import java
.util
.List
;
16 import java
.util
.UUID
;
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
;
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
;
78 public class CdmApplicationController
implements ICdmApplicationConfiguration
{
79 private static final Logger logger
= Logger
.getLogger(CdmApplicationController
.class);
81 public static final String DEFAULT_APPLICATION_CONTEXT_RESOURCE
= "/eu/etaxonomy/cdm/defaultApplicationContext.xml";
83 public AbstractApplicationContext applicationContext
;
84 private ICdmApplicationConfiguration configuration
;
85 private Resource applicationContextResource
;
87 private IProgressMonitor progressMonitor
;
89 final protected static DbSchemaValidation defaultDbSchemaValidation
= DbSchemaValidation
.VALIDATE
;
94 * Constructor, opens a spring ApplicationContext by using the default data source
95 * @throws DataSourceNotFoundException
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);
105 * Constructor, opens a spring ApplicationContext by using the default data source
106 * @param dbSchemaValidation validation type for database schema
107 * @throws DataSourceNotFoundException
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);
117 * Constructor, opens an spring ApplicationContext by using the according data source and the
118 * default database schema validation type
121 public static CdmApplicationController
NewInstance(ICdmDataSource dataSource
) {
122 return CdmApplicationController
.NewInstance(null, dataSource
, defaultDbSchemaValidation
, false);
125 public static CdmApplicationController
NewInstance(ICdmDataSource dataSource
, DbSchemaValidation dbSchemaValidation
) {
126 return CdmApplicationController
.NewInstance(null, dataSource
, dbSchemaValidation
, false);
129 public static CdmApplicationController
NewInstance(ICdmDataSource dataSource
, DbSchemaValidation dbSchemaValidation
, boolean omitTermLoading
) {
130 return CdmApplicationController
.NewInstance(null, dataSource
, dbSchemaValidation
, omitTermLoading
);
133 public static CdmApplicationController
NewInstance(Resource applicationContextResource
, ICdmDataSource dataSource
, DbSchemaValidation dbSchemaValidation
, boolean omitTermLoading
) {
134 return CdmApplicationController
.NewInstance(applicationContextResource
, dataSource
, dbSchemaValidation
, omitTermLoading
, null);
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);
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);
150 protected static ClassPathResource
getClasspathResource() {
151 return new ClassPathResource(DEFAULT_APPLICATION_CONTEXT_RESOURCE
);
156 * @throws DataSourceNotFoundException
158 protected static CdmPersistentDataSource
getDefaultDatasource() throws DataSourceNotFoundException
{
159 CdmPersistentDataSource dataSource
= CdmPersistentDataSource
.NewDefaultInstance();
165 * Constructor, opens an spring 2.5 ApplicationContext by using the according data source
167 * @param dbSchemaValidation
168 * @param omitTermLoading
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());
173 if (dbSchemaValidation
== null){
174 dbSchemaValidation
= defaultDbSchemaValidation
;
176 this.applicationContextResource
= applicationContextResource
!= null ? applicationContextResource
: getClasspathResource();
177 this.progressMonitor
= progressMonitor
!= null ? progressMonitor
: new NullProgressMonitor();
179 setNewDataSource(dataSource
, dbSchemaValidation
, omitTermLoading
, listeners
);
184 * Sets the application context to a new spring ApplicationContext by using the according data source and initializes the Controller.
187 private boolean setNewDataSource(ICdmDataSource dataSource
, DbSchemaValidation dbSchemaValidation
, boolean omitTermLoading
, List
<ApplicationListener
> listeners
){
189 if (dbSchemaValidation
== null){
190 dbSchemaValidation
= defaultDbSchemaValidation
;
192 logger
.info("Connecting to '" + dataSource
.getName() + "'");
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
);
200 // progressMonitor.worked(1);
202 BeanDefinition datasourceBean
= dataSource
.getDatasourceBean();
203 datasourceBean
.setAttribute("isLazy", false);
204 progressMonitor
.subTask("Registering datasource.");
205 applicationContext
.registerBeanDefinition("dataSource", datasourceBean
);
206 progressMonitor
.worked(1);
208 BeanDefinition hibernatePropBean
= dataSource
.getHibernatePropertiesBean(dbSchemaValidation
);
209 applicationContext
.registerBeanDefinition("hibernateProperties", hibernatePropBean
);
211 XmlBeanDefinitionReader xmlReader
= new XmlBeanDefinitionReader(applicationContext
);
212 progressMonitor
.subTask("Registering resources.");
213 xmlReader
.loadBeanDefinitions(applicationContextResource
);
214 progressMonitor
.worked(1);
217 if (omitTermLoading
== true){
218 String initializerName
= "persistentTermInitializer";
219 BeanDefinition beanDef
= applicationContext
.getBeanDefinition(initializerName
);
220 MutablePropertyValues values
= beanDef
.getPropertyValues();
221 values
.addPropertyValue("omit", omitTermLoading
);
224 if (listeners
!= null){
225 for(ApplicationListener listener
: listeners
){
226 applicationContext
.addApplicationListener(listener
);
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);
236 applicationContext
.refresh(new SubProgressMonitor(progressMonitor
, refreshTasks
));
237 applicationContext
.start();
238 // progressMonitor.worked(1);
240 progressMonitor
.subTask("Cleaning up.");
241 setApplicationContext(applicationContext
);
242 progressMonitor
.worked(1);
244 progressMonitor
.done();
253 * Tests if some DefinedTermsAreMissing.
254 * @return true, if at least one is missing, else false
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
)){
268 * Changes the ApplicationContext to the new dataSource
271 public boolean changeDataSource(ICdmDataSource dataSource
){
272 //logger.info("Change datasource to : " + dataSource);
273 return setNewDataSource(dataSource
, DbSchemaValidation
.VALIDATE
, false, null);
277 * Changes the ApplicationContext to the new dataSource
279 * @param dbSchemaValidation
281 public boolean changeDataSource(ICdmDataSource dataSource
, DbSchemaValidation dbSchemaValidation
){
282 //logger.info("Change datasource to : " + dataSource);
283 return setNewDataSource(dataSource
, dbSchemaValidation
, false, null);
287 * Changes the ApplicationContext to the new dataSource
289 * @param dbSchemaValidation
290 * @param omitTermLoading
292 public boolean changeDataSource(ICdmDataSource dataSource
, DbSchemaValidation dbSchemaValidation
, boolean omitTermLoading
){
293 logger
.info("Change datasource to : " + dataSource
);
294 return setNewDataSource(dataSource
, dbSchemaValidation
, omitTermLoading
, null);
298 * Changes the ApplicationContext to the new dataSource
300 * @param dbSchemaValidation
301 * @param omitTermLoading
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
);
309 * Sets a new application Context.
312 public void setApplicationContext(AbstractApplicationContext ac
){
313 closeApplicationContext(); //closes old application context if necessary
314 applicationContext
= ac
;
315 applicationContext
.registerShutdownHook();
320 * @see java.lang.Object#finalize()
322 public void finalize(){
327 * closes the application
330 closeApplicationContext();
334 * closes the application context
336 protected void closeApplicationContext(){
337 if (applicationContext
!= null){
338 logger
.info("Close ApplicationContext");
339 applicationContext
.close();
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
);
354 configuration
= (ICdmApplicationConfiguration
)applicationContext
.getBean("cdmApplicationDefaultConfiguration");
355 getDatabaseService().setApplicationController(this);
360 /* ****** Services *********/
361 public final INameService
getNameService(){
362 return configuration
.getNameService();
365 public final ITaxonService
getTaxonService(){
366 return configuration
.getTaxonService();
369 public final IClassificationService
getClassificationService(){
370 return configuration
.getClassificationService();
373 public final ITaxonNodeService
getTaxonNodeService(){
374 return configuration
.getTaxonNodeService();
377 public final IReferenceService
getReferenceService(){
378 return configuration
.getReferenceService();
381 public final IAgentService
getAgentService(){
382 return configuration
.getAgentService();
385 public final IDatabaseService
getDatabaseService(){
386 return configuration
.getDatabaseService();
389 public final ITermService
getTermService(){
390 return configuration
.getTermService();
393 public final IDescriptionService
getDescriptionService(){
394 return configuration
.getDescriptionService();
397 public final IOccurrenceService
getOccurrenceService(){
398 return configuration
.getOccurrenceService();
401 public final IMediaService
getMediaService(){
402 return configuration
.getMediaService();
405 public final ICommonService
getCommonService(){
406 return configuration
.getCommonService();
409 public final ILocationService
getLocationService(){
410 return configuration
.getLocationService();
413 public final IUserService
getUserService(){
414 return configuration
.getUserService();
417 public final IGrantedAuthorityService
getGrantedAuthorityService(){
418 return configuration
.getGrantedAuthorityService();
421 public IGroupService
getGroupService() {
422 return configuration
.getGroupService();
425 public final ICollectionService
getCollectionService(){
426 return configuration
.getCollectionService();
429 public final IFeatureTreeService
getFeatureTreeService(){
430 return configuration
.getFeatureTreeService();
433 public final IFeatureNodeService
getFeatureNodeService(){
434 return configuration
.getFeatureNodeService();
437 public final IVocabularyService
getVocabularyService(){
438 return configuration
.getVocabularyService();
441 public final IIdentificationKeyService
getIdentificationKeyService(){
442 return configuration
.getIdentificationKeyService();
445 public final IPolytomousKeyService
getPolytomousKeyService(){
446 return configuration
.getPolytomousKeyService();
449 public final IPolytomousKeyNodeService
getPolytomousKeyNodeService(){
450 return configuration
.getPolytomousKeyNodeService();
453 public final IService
<CdmBase
> getMainService(){
454 return configuration
.getMainService();
457 public final IWorkingSetService
getWorkingSetService(){
458 return configuration
.getWorkingSetService();
461 public final ConversationHolder
NewConversation(){
462 //return (ConversationHolder)applicationContext.getBean("conversationHolder");
463 return configuration
.NewConversation();
467 /* **** Security ***** */
471 * @see eu.etaxonomy.cdm.api.application.ICdmApplicationConfiguration#authenticate(java.lang.String, java.lang.String)
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
);
483 * @see eu.etaxonomy.cdm.api.application.ICdmApplicationConfiguration#getAuthenticationManager()
485 public final ProviderManager
getAuthenticationManager(){
486 return configuration
.getAuthenticationManager();
490 public ICdmPermissionEvaluator
getPermissionEvaluator() {
491 return configuration
.getPermissionEvaluator();
495 * @see org.springframework.security.access.PermissionEvaluator#hasPermission(org.springframework.security.core.Authentication, java.lang.Object, java.lang.Object)
497 * @param targetDomainObject
501 public boolean currentAuthentiationHasPermissions(CdmBase targetDomainObject
, EnumSet
<CRUD
> permission
){
502 SecurityContext context
= SecurityContextHolder
.getContext();
503 return getPermissionEvaluator().hasPermission(context
.getAuthentication(), targetDomainObject
, permission
);
508 public final PlatformTransactionManager
getTransactionManager() {
509 return configuration
.getTransactionManager();
512 public final Object
getBean(String name
){
513 return this.applicationContext
.getBean(name
);
517 * OLD TRANSACTION STUFF
520 /* **** flush ***********/
521 public void flush() {
522 SessionFactory sf
= (SessionFactory
)applicationContext
.getBean("sessionFactory");
523 sf
.getCurrentSession().flush();
526 public SessionFactory
getSessionFactory(){
527 return (SessionFactory
)applicationContext
.getBean("sessionFactory");
530 public TransactionStatus
startTransaction() {
531 return startTransaction(false);
534 public TransactionStatus
startTransaction(Boolean readOnly
) {
535 return configuration
.startTransaction(readOnly
);
538 public void commitTransaction(TransactionStatus txStatus
){
539 PlatformTransactionManager txManager
= configuration
.getTransactionManager();
540 txManager
.commit(txStatus
);