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