2 * Copyright (C) 2007 EDIT
3 * European Distributed Institute of Taxonomy
4 * http://www.e-taxonomy.eu
6 * The contents of this file are subject to the Mozilla Public License Version 1.1
7 * See LICENSE.TXT at the top of this package for the full license terms.
10 package eu
.etaxonomy
.taxeditor
.store
;
12 import java
.util
.EnumSet
;
14 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
15 import org
.eclipse
.core
.runtime
.jobs
.Job
;
16 import org
.eclipse
.swt
.widgets
.Display
;
17 import org
.springframework
.core
.io
.ClassPathResource
;
18 import org
.springframework
.core
.io
.Resource
;
19 import org
.springframework
.security
.access
.PermissionEvaluator
;
20 import org
.springframework
.security
.authentication
.AuthenticationManager
;
21 import org
.springframework
.security
.core
.Authentication
;
22 import org
.springframework
.security
.core
.context
.SecurityContext
;
23 import org
.springframework
.security
.core
.context
.SecurityContextHolder
;
25 import eu
.etaxonomy
.cdm
.api
.application
.CdmApplicationException
;
26 import eu
.etaxonomy
.cdm
.api
.application
.CdmApplicationRemoteController
;
27 import eu
.etaxonomy
.cdm
.api
.application
.CdmApplicationState
;
28 import eu
.etaxonomy
.cdm
.api
.application
.ICdmApplicationConfiguration
;
29 import eu
.etaxonomy
.cdm
.api
.conversation
.ConversationHolder
;
30 import eu
.etaxonomy
.cdm
.api
.service
.ICommonService
;
31 import eu
.etaxonomy
.cdm
.api
.service
.IService
;
32 import eu
.etaxonomy
.cdm
.config
.ICdmSource
;
33 import eu
.etaxonomy
.cdm
.database
.DbSchemaValidation
;
34 import eu
.etaxonomy
.cdm
.ext
.geo
.IEditGeoService
;
35 import eu
.etaxonomy
.cdm
.model
.common
.CdmBase
;
36 import eu
.etaxonomy
.cdm
.model
.common
.Language
;
37 import eu
.etaxonomy
.cdm
.persistence
.hibernate
.permission
.CRUD
;
38 import eu
.etaxonomy
.cdm
.persistence
.hibernate
.permission
.ICdmPermissionEvaluator
;
39 import eu
.etaxonomy
.cdm
.persistence
.hibernate
.permission
.Role
;
40 import eu
.etaxonomy
.taxeditor
.datasource
.CdmDataSourceRepository
;
41 import eu
.etaxonomy
.taxeditor
.io
.ExportManager
;
42 import eu
.etaxonomy
.taxeditor
.io
.ImportManager
;
43 import eu
.etaxonomy
.taxeditor
.model
.AbstractUtility
;
44 import eu
.etaxonomy
.taxeditor
.model
.MessagingUtils
;
45 import eu
.etaxonomy
.taxeditor
.preference
.PreferencesUtil
;
46 import eu
.etaxonomy
.taxeditor
.remoting
.cache
.CdmRemoteCacheManager
;
47 import eu
.etaxonomy
.taxeditor
.session
.ICdmEntitySessionManager
;
48 import eu
.etaxonomy
.taxeditor
.session
.mock
.MockCdmEntitySessionManager
;
49 import eu
.etaxonomy
.taxeditor
.store
.internal
.TaxeditorStorePlugin
;
50 import eu
.etaxonomy
.taxeditor
.ui
.dialog
.RemotingLoginDialog
;
51 import eu
.etaxonomy
.taxeditor
.view
.datasource
.CdmDataSourceViewPart
;
54 * This implementation of ICdmDataRepository depends on hibernate sessions to
55 * store the data correctly for the current session. No state is held in this
58 * Only methods that either get or manipulate data are exposed here. So this
59 * class acts as a facade for the methods in cdmlib-service.
65 public class CdmStore
{
67 private static final Resource DEFAULT_APPLICATION_CONTEXT
= new ClassPathResource(
68 "/eu/etaxonomy/cdm/editorApplicationContext.xml",
69 TaxeditorStorePlugin
.class);
70 private static final DbSchemaValidation DEFAULT_DB_SCHEMA_VALIDATION
= DbSchemaValidation
.VALIDATE
;
72 private static CdmStore instance
;
74 //private final ICdmApplicationConfiguration applicationConfiguration;
76 private static ContextManager contextManager
= new ContextManager();
78 private static LoginManager loginManager
= new LoginManager();
80 private static TermManager termManager
= new TermManager();
82 private static SearchManager searchManager
= new SearchManager();
84 private static EditorManager editorManager
= new EditorManager();
86 private static UseObjectStore useObjectInitializer
= new UseObjectStore();
88 private static CdmStoreConnector job
;
90 private Language language
;
92 private ICdmSource cdmSource
;
94 private boolean isConnected
;
103 * @return a {@link eu.etaxonomy.taxeditor.store.CdmStore} object.
105 protected static CdmStore
getDefault() {
106 if (instance
!= null && instance
.isConnected
) {
108 } else{// if (instance == null || !instance.isConnected) {
110 MessagingUtils
.noDataSourceWarningDialog(instance
);
112 AbstractUtility
.showView(CdmDataSourceViewPart
.ID
);
118 * Initialize the with the last edited datasource
120 public static void connect() {
122 ICdmSource cdmSource
;
125 cdmSource
= CdmDataSourceRepository
.getCurrentCdmSource();
127 } catch (Exception e
) {
128 MessagingUtils
.messageDialog("Connection to CDM Source Failed", CdmStore
.class, "Could not connect to target CDM Source", e
);
135 * Initialize with a specific datasource
138 * a {@link eu.etaxonomy.cdm.database.ICdmDataSource} object.
140 public static void connect(ICdmSource cdmSource
) {
141 connect(cdmSource
, DEFAULT_DB_SCHEMA_VALIDATION
,
142 DEFAULT_APPLICATION_CONTEXT
);
145 public static void connect(ICdmSource cdmSource
, RemotingLoginDialog loginDialog
) {
147 DEFAULT_DB_SCHEMA_VALIDATION
,
148 DEFAULT_APPLICATION_CONTEXT
,
153 * Initialize and provide
156 * @param dbSchemaValidation
157 * @param applicationContextBean
159 private static void connect(final ICdmSource cdmSource
,
160 final DbSchemaValidation dbSchemaValidation
,
161 final Resource applicationContextBean
) {
163 MessagingUtils
.info("Connecting to datasource: " + cdmSource
);
165 job
= new CdmStoreConnector(Display
.getDefault(), cdmSource
,
166 dbSchemaValidation
, applicationContextBean
);
168 job
.setPriority(Job
.BUILD
);
173 private static void connect(final ICdmSource cdmSource
,
174 final DbSchemaValidation dbSchemaValidation
,
175 final Resource applicationContextBean
,
176 RemotingLoginDialog remotingLoginDialog
) {
177 RemotingLoginDialog loginDialog
= remotingLoginDialog
;
179 // before we connect we clear the entity caches and the sessions
180 CdmRemoteCacheManager
.removeEntityCaches();
181 if(getCurrentSessionManager() != null) {
182 getCurrentSessionManager().disposeAll();
185 MessagingUtils
.info("Connecting to datasource: " + cdmSource
);
187 job
= new CdmStoreConnector(Display
.getDefault(),
190 applicationContextBean
);
191 job
.start(loginDialog
);
195 public static boolean isConnecting() {
196 return job
!= null && job
.getState() == Job
.RUNNING
;
200 * Closes the current application context
203 * a {@link org.eclipse.core.runtime.IProgressMonitor} object.
205 public static void close(final IProgressMonitor monitor
) {
206 Display
.getDefault().asyncExec(new Runnable() {
210 * @see java.lang.Runnable#run()
214 getContextManager().notifyContextAboutToStop(monitor
);
215 if ((monitor
== null || (!monitor
.isCanceled()) && isActive())) {
216 getContextManager().notifyContextStop(monitor
);
223 public static void close(IProgressMonitor monitor
, boolean async
) {
227 getContextManager().notifyContextAboutToStop(monitor
);
228 if ((monitor
== null || (!monitor
.isCanceled()) && isActive())) {
229 getContextManager().notifyContextStop(monitor
);
235 private void close() {
238 CdmApplicationState
.dispose();
241 static void setInstance(ICdmApplicationConfiguration applicationController
,
242 ICdmSource cdmSource
) {
243 instance
= new CdmStore(applicationController
, cdmSource
);
246 private CdmStore(ICdmApplicationConfiguration applicationController
,
247 ICdmSource cdmSource
) {
248 CdmApplicationState
.setCurrentAppConfig(applicationController
);
249 CdmApplicationState
.setCurrentDataChangeService(new CdmUIDataChangeService());
250 this.cdmSource
= cdmSource
;
255 * All calls to the datastore require
259 private ICdmApplicationConfiguration
getApplicationConfiguration() {
261 return CdmApplicationState
.getCurrentAppConfig();
262 } catch (Exception e
) {
263 MessagingUtils
.error(CdmStore
.class, e
);
270 * getCurrentApplicationController
274 * {@link eu.etaxonomy.cdm.remote.api.application.CdmApplicationController}
277 public static ICdmApplicationConfiguration
getCurrentApplicationConfiguration() {
278 if (getDefault() != null) {
279 return getDefault().getApplicationConfiguration();
289 * Creates a new conversation, binds resources to the conversation and start
290 * a transaction for this conversation.
292 * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder}
295 public static ConversationHolder
createConversation() {
296 ConversationHolder conversation
= getCurrentApplicationConfiguration()
299 conversation
.startTransaction();
301 MessagingUtils
.messageDialog("No database connection", CdmStore
.class, "No database connection available", e
);
306 //FIXME:Remoting should be removed after moving completely to remoting
307 private MockCdmEntitySessionManager mockCdmEntitySessionManager
;
309 private ICdmEntitySessionManager
getSessionManager() {
310 //FIXME:Remoting we should only have CdmApplicationRemoteConfiguration after move to remoting
311 // bad hack which should be finally removed
312 if(getCurrentApplicationConfiguration() instanceof CdmApplicationRemoteController
) {
313 return ((CdmApplicationRemoteController
)getCurrentApplicationConfiguration()).getCdmEntitySessionManager();
315 if(mockCdmEntitySessionManager
== null) {
316 mockCdmEntitySessionManager
= new MockCdmEntitySessionManager();
318 return mockCdmEntitySessionManager
;
322 public static ICdmEntitySessionManager
getCurrentSessionManager() {
323 if (getDefault() != null) {
324 return getDefault().getSessionManager();
331 * Generic method that will scan the getters of {@link ICdmApplicationConfiguration} for the given service
332 * interface. If a matching getter is found the according service implementation is returned by
333 * invoking the getter otherwise the method returns <code>null</code>.
336 * @param serviceClass
337 * @return the configured implementation of <code>serviceClass</code> or <code>null</code>
339 public static <T
extends IService
> T
getService(Class
<T
> serviceClass
) {
342 service
= CdmApplicationState
.getService(serviceClass
);
343 } catch (CdmApplicationException cae
) {
344 MessagingUtils
.error(CdmStore
.class, cae
);
351 * @see #getService(Class)
352 * As ICommonService is not extending IService we need a specific request here
354 public static ICommonService
getCommonService() {
355 return CdmApplicationState
.getCommonService();
361 * getAuthenticationManager
365 * {@link org.springframework.security.authentication.ProviderManager}
368 public static AuthenticationManager
getAuthenticationManager() {
369 return getCurrentApplicationConfiguration().getAuthenticationManager();
374 * getAuthenticationManager
378 * {@link ICdmPermissionEvaluator} object.
380 public static ICdmPermissionEvaluator
getPermissionEvaluator() {
381 return getCurrentApplicationConfiguration().getPermissionEvaluator();
389 * @return a {@link eu.etaxonomy.cdm.ext.geo.IEditGeoService} object.
391 public static IEditGeoService
getGeoService() {
392 return (IEditGeoService
) getCurrentApplicationConfiguration().getBean(
397 * SECURITY RELATED CONVENIENCE METHODS
401 * @see org.springframework.security.access.PermissionEvaluator#hasPermission(org.springframework.security.core.Authentication, java.lang.Object, java.lang.Object)
403 * @param targetDomainObject
407 public static boolean currentAuthentiationHasPermission(CdmBase targetDomainObject
, EnumSet
<CRUD
> permission
){
408 //TODO use getCurrentApplicationConfiguration().currentAuthentiationHasPermission(CdmBase targetDomainObject, Operation permission) instead
409 SecurityContext context
= SecurityContextHolder
.getContext();
410 PermissionEvaluator pe
= getPermissionEvaluator();
411 boolean hasPermission
= false;
413 hasPermission
= getPermissionEvaluator().hasPermission(context
.getAuthentication(), targetDomainObject
,
415 } catch (org
.springframework
.security
.access
.AccessDeniedException e
) {
418 return hasPermission
;
422 * @see org.springframework.security.access.PermissionEvaluator#hasPermission(org.springframework.security.core.Authentication, java.lang.Object, java.lang.Object)
424 * @param targetDomainObject
428 public static boolean currentAuthentiationHasPermission(Class
<?
extends CdmBase
> targetType
, EnumSet
<CRUD
> permission
){
429 boolean hasPermission
= false;
431 hasPermission
= getPermissionEvaluator().hasPermission(getCurrentAuthentiation(), null, targetType
.getName(), permission
);
432 } catch (org
.springframework
.security
.access
.AccessDeniedException e
) {
435 return hasPermission
;
438 public static boolean currentAuthentiationHasOneOfRoles(Role
... roles
){
439 boolean hasPermission
= false;
441 hasPermission
= getPermissionEvaluator().hasOneOfRoles(getCurrentAuthentiation(), roles
);
442 } catch (org
.springframework
.security
.access
.AccessDeniedException e
) {
445 return hasPermission
;
448 public static Authentication
getCurrentAuthentiation() {
449 SecurityContext context
= SecurityContextHolder
.getContext();
450 return context
.getAuthentication();
458 * Provides access to the global default language set in the application preferences.
460 * @return a {@link eu.etaxonomy.cdm.model.common.Language} object.
462 public static Language
getDefaultLanguage() {
463 if (getDefault().getLanguage() == null) {
464 getDefault().setLanguage(PreferencesUtil
.getGlobalLanguage());
466 return getDefault().getLanguage();
475 * a {@link eu.etaxonomy.cdm.model.common.Language} object.
477 public static void setDefaultLanguage(Language language
) {
478 getDefault().setLanguage(language
);
482 * @return the language
484 private Language
getLanguage() {
490 * the language to set
492 private void setLanguage(Language language
) {
493 this.language
= language
;
502 * Getter for the field <code>loginManager</code>.
505 * @return a {@link eu.etaxonomy.taxeditor.store.LoginManager} object.
507 public static LoginManager
getLoginManager() {
513 * Getter for the field <code>contextManager</code>.
516 * @return a {@link eu.etaxonomy.taxeditor.store.ContextManager} object.
518 public static ContextManager
getContextManager() {
519 return contextManager
;
522 public static TermManager
getTermManager() {
526 public static SearchManager
getSearchManager() {
527 return searchManager
;
530 public static EditorManager
getEditorManager() {
531 return editorManager
;
535 * IMPORT/EXPORT FACTORIES
540 * Getter for the field <code>importHandler</code>.
543 * @return a {@link eu.etaxonomy.taxeditor.io.ImportManager} object.
545 public static ImportManager
getImportManager() {
546 return ImportManager
.NewInstance(getCurrentApplicationConfiguration());
551 * Getter for the field <code>exportHandler</code>.
554 * @return a {@link eu.etaxonomy.taxeditor.io.ExportManager} object.
556 public static ExportManager
getExportManager() {
557 return ExportManager
.NewInstance(getCurrentApplicationConfiguration());
561 * Whether this CdmStore is currently connected to a datasource
565 public static boolean isActive() {
566 return instance
!= null && instance
.isConnected
;
569 public static ICdmSource
getActiveCdmSource() {
571 return instance
.getCdmSource();
581 * @return a {@link eu.etaxonomy.cdm.database.ICdmDataSource} object.
582 * @deprecated currently retained for backward compatibility - use {@link getActiveCdmSource()} instead
584 // public static ICdmDataSource getDataSource() {
586 // return (ICdmDataSource)instance.getCdmSource();
594 private ICdmSource
getCdmSource() {