eu.etaxonomy.taxeditor.cdmlib/src/main/java/eu/etaxonomy/cdm/api/application/CdmApplicationRemoteConfiguration.java

   1 /**
   2  * Copyright (C) 2014 EDIT
   3  * European Distributed Institute of Taxonomy
   4  * http://www.e-taxonomy.eu
   5  *
   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.
   8  */
   9
  10 package eu.etaxonomy.cdm.api.application;
  11
  12 import java.util.ArrayList;
  13 import java.util.Arrays;
  14 import java.util.HashMap;
  15 import java.util.List;
  16 import java.util.Map;
  17
  18 import org.apache.log4j.Logger;
  19 import org.springframework.beans.BeansException;
  20 import org.springframework.context.ApplicationContext;
  21 import org.springframework.context.ApplicationContextAware;
  22 import org.springframework.remoting.httpinvoker.HttpComponentsHttpInvokerRequestExecutor;
  23 import org.springframework.remoting.httpinvoker.HttpInvokerProxyFactoryBean;
  24 import org.springframework.security.access.AccessDecisionVoter;
  25 import org.springframework.security.authentication.AuthenticationProvider;
  26 import org.springframework.security.authentication.ProviderManager;
  27 import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
  28 import org.springframework.security.authentication.dao.DaoAuthenticationProvider;
  29 import org.springframework.security.authentication.dao.ReflectionSaltSource;
  30 import org.springframework.security.authentication.encoding.Md5PasswordEncoder;
  31 import org.springframework.security.core.Authentication;
  32 import org.springframework.security.core.context.SecurityContext;
  33 import org.springframework.security.core.context.SecurityContextHolder;
  34 import org.springframework.stereotype.Component;
  35 import org.springframework.transaction.PlatformTransactionManager;
  36 import org.springframework.transaction.TransactionStatus;
  37
  38 import eu.etaxonomy.cdm.api.conversation.ConversationHolder;
  39 import eu.etaxonomy.cdm.api.conversation.ConversationHolderMock;
  40 import eu.etaxonomy.cdm.api.service.IAgentService;
  41 import eu.etaxonomy.cdm.api.service.IAnnotationService;
  42 import eu.etaxonomy.cdm.api.service.IClassificationService;
  43 import eu.etaxonomy.cdm.api.service.ICollectionService;
  44 import eu.etaxonomy.cdm.api.service.ICommonService;
  45 import eu.etaxonomy.cdm.api.service.IDatabaseService;
  46 import eu.etaxonomy.cdm.api.service.IDescriptionService;
  47 import eu.etaxonomy.cdm.api.service.IEntityConstraintViolationService;
  48 import eu.etaxonomy.cdm.api.service.IEntityValidationService;
  49 import eu.etaxonomy.cdm.api.service.IEventBaseService;
  50 import eu.etaxonomy.cdm.api.service.IFeatureNodeService;
  51 import eu.etaxonomy.cdm.api.service.IFeatureTreeService;
  52 import eu.etaxonomy.cdm.api.service.IGrantedAuthorityService;
  53 import eu.etaxonomy.cdm.api.service.IGroupService;
  54 import eu.etaxonomy.cdm.api.service.IIdentificationKeyService;
  55 import eu.etaxonomy.cdm.api.service.ILocationService;
  56 import eu.etaxonomy.cdm.api.service.IMediaService;
  57 import eu.etaxonomy.cdm.api.service.IMetadataService;
  58 import eu.etaxonomy.cdm.api.service.INameService;
  59 import eu.etaxonomy.cdm.api.service.IOccurrenceService;
  60 import eu.etaxonomy.cdm.api.service.IPolytomousKeyNodeService;
  61 import eu.etaxonomy.cdm.api.service.IPolytomousKeyService;
  62 import eu.etaxonomy.cdm.api.service.IProgressMonitorService;
  63 import eu.etaxonomy.cdm.api.service.IReferenceService;
  64 import eu.etaxonomy.cdm.api.service.IService;
  65 import eu.etaxonomy.cdm.api.service.ITaxonNodeService;
  66 import eu.etaxonomy.cdm.api.service.ITaxonService;
  67 import eu.etaxonomy.cdm.api.service.ITermService;
  68 import eu.etaxonomy.cdm.api.service.ITestService;
  69 import eu.etaxonomy.cdm.api.service.IUserService;
  70 import eu.etaxonomy.cdm.api.service.IVocabularyService;
  71 import eu.etaxonomy.cdm.api.service.IWorkingSetService;
  72 import eu.etaxonomy.cdm.api.service.molecular.IAmplificationService;
  73 import eu.etaxonomy.cdm.api.service.molecular.IPrimerService;
  74 import eu.etaxonomy.cdm.api.service.molecular.ISequenceService;
  75 import eu.etaxonomy.cdm.ext.geo.IEditGeoService;
  76 import eu.etaxonomy.cdm.io.service.IIOService;
  77 import eu.etaxonomy.cdm.model.common.CdmBase;
  78 import eu.etaxonomy.cdm.persistence.hibernate.permission.CdmPermissionEvaluator;
  79 import eu.etaxonomy.cdm.persistence.hibernate.permission.ICdmPermissionEvaluator;
  80 import eu.etaxonomy.cdm.persistence.hibernate.permission.UnanimousBasedUnrevokable;
  81 import eu.etaxonomy.cdm.persistence.hibernate.permission.voter.DescriptionBaseVoter;
  82 import eu.etaxonomy.cdm.persistence.hibernate.permission.voter.DescriptionElementVoter;
  83 import eu.etaxonomy.cdm.persistence.hibernate.permission.voter.GrantAlwaysVoter;
  84 import eu.etaxonomy.cdm.persistence.hibernate.permission.voter.TaxonBaseVoter;
  85 import eu.etaxonomy.cdm.persistence.hibernate.permission.voter.TaxonNodeVoter;
  86 import eu.etaxonomy.taxeditor.remoting.source.ICdmRemoteSource;
  87 import eu.etaxonomy.taxeditor.service.CachedCommonServiceImpl;
  88 import eu.etaxonomy.taxeditor.service.CdmAuthenticatedHttpInvokerRequestExecutor;
  89 import eu.etaxonomy.taxeditor.service.CdmServiceRequestExecutor;
  90 import eu.etaxonomy.taxeditor.service.ICachedCommonService;
  91 import eu.etaxonomy.taxeditor.service.TermServiceRequestExecutor;
  92 import eu.etaxonomy.taxeditor.session.CdmEntitySessionManager;
  93 import eu.etaxonomy.taxeditor.session.ICdmEntitySessionManager;
  94
  95
  96 /**
  97  * CDM Application Configuration class which manages the configuration for remoting
  98  * clients
  99  *
 100  */
 101 @Component
 102 public class CdmApplicationRemoteConfiguration implements ICdmApplicationConfiguration, ApplicationContextAware  {
 103
 104     @SuppressWarnings("unused")
 105     private static final Logger logger = Logger.getLogger(CdmApplicationRemoteConfiguration.class);
 106
 107     protected ApplicationContext applicationContext;
 108
 109     private ICdmRemoteSource remoteSource;
 110
 111     private Map serviceMap = new HashMap<Class<IService>, IService>();
 112
 113     private ICdmEntitySessionManager cdmEntitySessionManager;
 114
 115     private CdmPermissionEvaluator cdmPermissionEvaluator;
 116
 117     private ProviderManager authenticationManager;
 118
 119     private ICachedCommonService cachedCommonService;
 120
 121     public CdmApplicationRemoteConfiguration() {}
 122
 123     public CdmApplicationRemoteConfiguration(ICdmRemoteSource remoteSource) {
 124         this.remoteSource = remoteSource;
 125
 126     }
 127
 128     public void setRemoteSource(ICdmRemoteSource remoteSource) {
 129         this.remoteSource = remoteSource;
 130     }
 131
 132     private Object getService(Class<?> clazz, String serviceSuffix, HttpComponentsHttpInvokerRequestExecutor executor) {
 133         if(serviceMap.containsKey(clazz)) {
 134             return serviceMap.get(clazz);
 135         }
 136         Object service = getService(clazz, serviceSuffix, remoteSource, executor);
 137         serviceMap.put(clazz,  service);
 138         return service;
 139     }
 140
 141     public static Object getService(Class<?> clazz,
 142             String serviceSuffix,
 143             ICdmRemoteSource remoteSource,
 144             HttpComponentsHttpInvokerRequestExecutor executor) {
 145
 146         String baseUrl;
 147         if(remoteSource.getContextPath() == null || remoteSource.getContextPath().equals("")) {
 148             baseUrl = "http://" + remoteSource.getServer() + ":" + String.valueOf(remoteSource.getPort());
 149         } else {
 150             baseUrl = "http://" + remoteSource.getServer()  + ":" + String.valueOf(remoteSource.getPort()) + "/" + remoteSource.getContextPath();
 151         }
 152         HttpInvokerProxyFactoryBean proxy = new HttpInvokerProxyFactoryBean();
 153         proxy.setServiceInterface(clazz);
 154         proxy.setServiceUrl(baseUrl + serviceSuffix);
 155         if(executor != null) {
 156             executor.setReadTimeout(0);
 157             proxy.setHttpInvokerRequestExecutor(executor);
 158         }
 159         proxy.afterPropertiesSet();
 160         return proxy.getObject();
 161     }
 162
 163     // ****************************** APPLICATION CONTEXT *************************************************/
 164
 165     @Override
 166     public void setApplicationContext(ApplicationContext applicationContext) throws BeansException{
 167         this.applicationContext = applicationContext;
 168     }
 169
 170     /* (non-Javadoc)
 171      * @see eu.etaxonomy.cdm.api.application.CdmApplicationDefaultConfiguration#getTransactionManager()
 172      */
 173     @Override
 174     public PlatformTransactionManager getTransactionManager() throws UnsupportedOperationException {
 175         throw new UnsupportedOperationException("getTransactionManager is not implemented for CdmApplicationRemoteConfiguration");
 176     }
 177
 178
 179
 180     /**
 181      * @return
 182      */
 183     public IEditGeoService getEditGeoService() {
 184         return (IEditGeoService) getService(IEditGeoService.class, "/remoting/editgeo.service", new CdmServiceRequestExecutor());
 185     }
 186
 187     /**
 188      * @return
 189      */
 190     public ICachedCommonService getCachedCommonService(){
 191         if(cachedCommonService == null) {
 192             cachedCommonService = new CachedCommonServiceImpl();
 193         }
 194         return cachedCommonService;
 195     }
 196
 197
 198     public ICdmEntitySessionManager getCdmEntitySessionManager() {
 199         if(cdmEntitySessionManager == null) {
 200             cdmEntitySessionManager = new CdmEntitySessionManager();
 201         }
 202         return cdmEntitySessionManager;
 203     }
 204
 205
 206
 207
 208
 209
 210  // ****************************** GETTER *************************************************/
 211
 212     @Override
 213     public final Object getBean(String name){
 214         throw new UnsupportedOperationException("getBean is not implemented for CdmApplicationRemoteConfiguration");
 215     }
 216
 217     @Override
 218     public IAgentService getAgentService(){
 219         return (IAgentService) getService(IAgentService.class, "/remoting/agent.service", new CdmServiceRequestExecutor());
 220     }
 221
 222     @Override
 223     public IAnnotationService getAnnotationService(){
 224         return (IAnnotationService) getService(IAnnotationService.class, "/remoting/annotation.service", new CdmServiceRequestExecutor());
 225     }
 226
 227     @Override
 228     public IDatabaseService getDatabaseService(){
 229         return (IDatabaseService) getService(IDatabaseService.class, "/remoting/database.service", new CdmServiceRequestExecutor());
 230     }
 231
 232     @Override
 233     public INameService getNameService(){
 234         return (INameService) getService(INameService.class, "/remoting/name.service", new CdmServiceRequestExecutor());
 235     }
 236
 237     @Override
 238     public IReferenceService getReferenceService(){
 239         return (IReferenceService) getService(IReferenceService.class, "/remoting/reference.service", new CdmServiceRequestExecutor());
 240     }
 241
 242     @Override
 243     public ITaxonService getTaxonService(){
 244         return (ITaxonService) getService(ITaxonService.class, "/remoting/taxon.service", new CdmServiceRequestExecutor());
 245     }
 246
 247     @Override
 248     public IClassificationService getClassificationService(){
 249         return (IClassificationService) getService(IClassificationService.class, "/remoting/classification.service", new CdmServiceRequestExecutor());
 250     }
 251
 252     @Override
 253     public ITaxonNodeService getTaxonNodeService(){
 254         return (ITaxonNodeService) getService(ITaxonNodeService.class, "/remoting/taxonnode.service", new CdmServiceRequestExecutor());
 255     }
 256
 257     @Override
 258     public IDescriptionService getDescriptionService(){
 259         return (IDescriptionService) getService(IDescriptionService.class, "/remoting/description.service", new CdmServiceRequestExecutor());
 260     }
 261
 262     @Override
 263     public IOccurrenceService getOccurrenceService(){
 264         return (IOccurrenceService) getService(IOccurrenceService.class, "/remoting/occurrence.service", new CdmServiceRequestExecutor());
 265     }
 266
 267     @Override
 268     public IPrimerService getPrimerService(){
 269         return (IPrimerService) getService(IPrimerService.class, "/remoting/primer.service", new CdmServiceRequestExecutor());
 270     }
 271
 272     @Override
 273     public IAmplificationService getAmplificationService(){
 274         return (IAmplificationService) getService(IAmplificationService.class, "/remoting/amplification.service", new CdmServiceRequestExecutor());
 275     }
 276
 277     @Override
 278     public ISequenceService getSequenceService(){
 279         return (ISequenceService) getService(ISequenceService.class, "/remoting/sequence.service", new CdmServiceRequestExecutor());
 280     }
 281
 282     @Override
 283     public IEventBaseService getEventBaseService() {
 284         return (IEventBaseService) getService(IEventBaseService.class, "/remoting/eventbase.service", new CdmServiceRequestExecutor());
 285     }
 286
 287     @Override
 288     public IMediaService getMediaService(){
 289         return (IMediaService) getService(IMediaService.class, "/remoting/media.service", new CdmServiceRequestExecutor());
 290     }
 291
 292     @Override
 293     public ITermService getTermService(){
 294         return (ITermService) getService(ITermService.class, "/remoting/term.service", new TermServiceRequestExecutor());
 295     }
 296
 297     @Override
 298     public ICommonService getCommonService(){
 299         return (ICommonService) getService(ICommonService.class, "/remoting/common.service", new CdmServiceRequestExecutor());
 300     }
 301
 302     @Override
 303     public ILocationService getLocationService(){
 304         return (ILocationService) getService(ILocationService.class, "/remoting/location.service", new CdmServiceRequestExecutor());
 305     }
 306
 307     @Override
 308     public IUserService getUserService(){
 309         return (IUserService) getService(IUserService.class, "/remoting-public/user.service", new CdmServiceRequestExecutor());
 310     }
 311
 312
 313     public static IUserService getUserService(ICdmRemoteSource remoteSource) {
 314         return (IUserService) getService(IUserService.class, "/remoting-public/user.service", remoteSource, new HttpComponentsHttpInvokerRequestExecutor());
 315     }
 316
 317     @Override
 318     public IMetadataService getMetadataService() {
 319         return (IMetadataService) getService(IMetadataService.class, "/remoting-public/metadata.service", new HttpComponentsHttpInvokerRequestExecutor());
 320     }
 321
 322     public static IMetadataService getMetadataService(ICdmRemoteSource remoteSource) {
 323         return (IMetadataService) getService(IMetadataService.class, "/remoting-public/metadata.service", remoteSource, new HttpComponentsHttpInvokerRequestExecutor());
 324     }
 325
 326     @Override
 327     public IGrantedAuthorityService getGrantedAuthorityService(){
 328         return (IGrantedAuthorityService) getService(IGrantedAuthorityService.class, "/remoting/grantedauthority.service", new CdmServiceRequestExecutor());
 329     }
 330
 331     @Override
 332     public IService<CdmBase> getMainService(){
 333         return null;
 334     }
 335
 336
 337     @Override
 338     public ProviderManager getAuthenticationManager(){
 339         if(authenticationManager != null) {
 340             return authenticationManager;
 341         }
 342
 343         authenticationManager = getAuthenticationManager(getUserService());
 344         return authenticationManager;
 345     }
 346
 347     public static ProviderManager getAuthenticationManager(IUserService userService) {
 348         Md5PasswordEncoder passwordEncoder = new Md5PasswordEncoder();
 349         ReflectionSaltSource saltSource = new ReflectionSaltSource();
 350         saltSource.setUserPropertyToUse("getUsername");
 351
 352         DaoAuthenticationProvider daoAuthenticationProvider = new DaoAuthenticationProvider();
 353         daoAuthenticationProvider.setUserDetailsService(userService);
 354         daoAuthenticationProvider.setSaltSource(saltSource);
 355         daoAuthenticationProvider.setPasswordEncoder(passwordEncoder);
 356
 357         return new ProviderManager(Arrays.asList((AuthenticationProvider)daoAuthenticationProvider));
 358     }
 359
 360
 361     @Override
 362     public ConversationHolder NewConversation() {
 363         return new ConversationHolderMock();
 364     }
 365
 366     @Override
 367     public ICollectionService getCollectionService(){
 368         return (ICollectionService) getService(ICollectionService.class, "/remoting/collection.service", new CdmServiceRequestExecutor());
 369     }
 370
 371     @Override
 372     public IFeatureTreeService getFeatureTreeService(){
 373         return (IFeatureTreeService) getService(IFeatureTreeService.class, "/remoting/featuretree.service", new CdmServiceRequestExecutor());
 374     }
 375
 376     @Override
 377     public IFeatureNodeService getFeatureNodeService(){
 378         return (IFeatureNodeService) getService(IFeatureNodeService.class, "/remoting/featurenode.service", new CdmServiceRequestExecutor());
 379     }
 380
 381     @Override
 382     public IVocabularyService getVocabularyService(){
 383         return (IVocabularyService) getService(IVocabularyService.class, "/remoting/vocabulary.service", new CdmServiceRequestExecutor());
 384     }
 385
 386     @Override
 387     public IIdentificationKeyService getIdentificationKeyService(){
 388         return (IIdentificationKeyService) getService(IIdentificationKeyService.class, "/remoting/identificationkey.service", new CdmServiceRequestExecutor());
 389     }
 390
 391     @Override
 392     public IPolytomousKeyService getPolytomousKeyService(){
 393         return (IPolytomousKeyService) getService(IPolytomousKeyService.class, "/remoting/polytomouskey.service", new CdmServiceRequestExecutor());
 394     }
 395
 396
 397     @Override
 398     public IPolytomousKeyNodeService getPolytomousKeyNodeService(){
 399         return (IPolytomousKeyNodeService) getService(IPolytomousKeyNodeService.class, "/remoting/polytomouskeynode.service", new CdmServiceRequestExecutor());
 400     }
 401
 402     @Override
 403     public IProgressMonitorService getProgressMonitorService() {
 404         return (IProgressMonitorService) getService(IProgressMonitorService.class, "/remoting/progressmonitor.service", new CdmAuthenticatedHttpInvokerRequestExecutor());
 405     }
 406
 407     @Override
 408     public IWorkingSetService getWorkingSetService(){
 409         return (IWorkingSetService) getService(IWorkingSetService.class, "/remoting/workingset.service", new CdmServiceRequestExecutor());
 410     }
 411
 412     @Override
 413     public IGroupService getGroupService(){
 414         return (IGroupService) getService(IGroupService.class, "/remoting/group.service", new CdmServiceRequestExecutor());
 415     }
 416
 417
 418     @Override
 419     public IEntityValidationService getEntityValidationService(){
 420         return (IEntityValidationService) getService(IEntityValidationService.class, "/remoting/entityvalidation.service", new CdmServiceRequestExecutor());
 421     }
 422
 423
 424     @Override
 425     public IEntityConstraintViolationService getEntityConstraintViolationService(){
 426         return (IEntityConstraintViolationService) getService(IEntityConstraintViolationService.class, "/remoting/entityconstraintviolation.service", new CdmServiceRequestExecutor());
 427     }
 428
 429     @Override
 430     public ICdmPermissionEvaluator getPermissionEvaluator(){
 431
 432         if(cdmPermissionEvaluator != null) {
 433             return cdmPermissionEvaluator;
 434         }
 435         List<AccessDecisionVoter<? extends Object>> decisionVoters = new ArrayList<AccessDecisionVoter<? extends Object>>();
 436         decisionVoters.add(new GrantAlwaysVoter());
 437         decisionVoters.add(new TaxonNodeVoter());
 438         decisionVoters.add(new TaxonBaseVoter());
 439         decisionVoters.add(new DescriptionBaseVoter());
 440         decisionVoters.add(new DescriptionElementVoter());
 441         UnanimousBasedUnrevokable accessDecisionManager = new UnanimousBasedUnrevokable(decisionVoters);
 442
 443         cdmPermissionEvaluator = new CdmPermissionEvaluator();
 444         cdmPermissionEvaluator.setAccessDecisionManager(accessDecisionManager);
 445
 446         return cdmPermissionEvaluator;
 447     }
 448
 449
 450     @Override
 451     public TransactionStatus startTransaction() throws UnsupportedOperationException {
 452         throw new UnsupportedOperationException("startTransaction is not implemented for CdmApplicationRemoteConfiguration");
 453     }
 454
 455     @Override
 456     public TransactionStatus startTransaction(Boolean readOnly) throws UnsupportedOperationException {
 457         throw new UnsupportedOperationException("startTransaction is not implemented for CdmApplicationRemoteConfiguration");
 458     }
 459
 460
 461     @Override
 462     public void commitTransaction(TransactionStatus txStatus) throws UnsupportedOperationException {
 463         throw new UnsupportedOperationException("commitTransaction is not implemented for CdmApplicationRemoteConfiguration");
 464     }
 465
 466     @Override
 467     public void authenticate(String username, String password){
 468         UsernamePasswordAuthenticationToken tokenForUser = new UsernamePasswordAuthenticationToken(username, password);
 469         Authentication authentication = this.getAuthenticationManager().authenticate(tokenForUser);
 470         SecurityContext context = SecurityContextHolder.getContext();
 471         context.setAuthentication(authentication);
 472     }
 473
 474     public IIOService getIOService() {
 475         return (IIOService) getService(IIOService.class, "/remoting/io.service", new CdmServiceRequestExecutor());
 476     }
 477
 478     public ITestService getTestService() {
 479         return (ITestService) getService(ITestService.class, "/remoting/test.service", new CdmServiceRequestExecutor());
 480     }
 481 }