git.aero2k.de Git - tmp/jakarta-migration.git/blob

   1 /**
   2  *  This document is a part of the source code and related artifacts
   3  *  for CollectionSpace, an open source collections management system
   4  *  for museums and related institutions:
   5
   6  *  http://www.collectionspace.org
   7  *  http://wiki.collectionspace.org
   8
   9  *  Copyright 2009 University of California at Berkeley
  10
  11  *  Licensed under the Educational Community License (ECL), Version 2.0.
  12  *  You may not use this file except in compliance with this License.
  13
  14  *  You may obtain a copy of the ECL 2.0 License at
  15
  16  *  https://source.collectionspace.org/collection-space/LICENSE.txt
  17
  18  *  Unless required by applicable law or agreed to in writing, software
  19  *  distributed under the License is distributed on an "AS IS" BASIS,
  20  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  21  *  See the License for the specific language governing permissions and
  22  *  limitations under the License.
  23  */
  24 package org.collectionspace.services.common.context;
  25
  26 import java.util.ArrayList;
  27 import java.util.HashMap;
  28 import java.util.List;
  29 import java.util.Map;
  30 import javax.ws.rs.core.MultivaluedMap;
  31 import javax.ws.rs.core.UriInfo;
  32
  33 import org.collectionspace.services.client.IQueryManager;
  34 import org.collectionspace.services.client.workflow.WorkflowClient;
  35 import org.collectionspace.services.common.ClientType;
  36 import org.collectionspace.services.common.ServiceMain;
  37 import org.collectionspace.services.common.config.PropertyItemUtils;
  38 import org.collectionspace.services.common.config.TenantBindingConfigReaderImpl;
  39 import org.collectionspace.services.common.document.DocumentHandler;
  40 import org.collectionspace.services.common.document.DocumentFilter;
  41 import org.collectionspace.services.common.document.ValidatorHandler;
  42 import org.collectionspace.services.common.security.SecurityContext;
  43 import org.collectionspace.services.common.security.SecurityContextImpl;
  44 import org.collectionspace.services.common.security.UnauthorizedException;
  45 import org.collectionspace.services.common.service.ObjectPartType;
  46 import org.collectionspace.services.common.service.ServiceBindingType;
  47 import org.collectionspace.services.common.tenant.RepositoryDomainType;
  48 import org.collectionspace.services.common.tenant.TenantBindingType;
  49 import org.collectionspace.services.common.types.PropertyItemType;
  50 import org.collectionspace.services.common.types.PropertyType;
  51 import org.slf4j.Logger;
  52 import org.slf4j.LoggerFactory;
  53
  54 /**
  55  * AbstractServiceContext
  56  *
  57  * $LastChangedRevision: $
  58  * $LastChangedDate: $
  59  */
  60 /**
  61  * @author pschmitz
  62  *
  63  * @param <IT>
  64  * @param <OT>
  65  */
  66 /**
  67  * @author pschmitz
  68  *
  69  * @param <IT>
  70  * @param <OT>
  71  */
  72 public abstract class AbstractServiceContextImpl<IT, OT>
  73         implements ServiceContext<IT, OT> {
  74
  75     /** The logger. */
  76     final Logger logger = LoggerFactory.getLogger(AbstractServiceContextImpl.class);
  77     /** The properties. */
  78     Map<String, Object> properties = new HashMap<String, Object>();
  79     /** The object part map. */
  80     Map<String, ObjectPartType> objectPartMap = new HashMap<String, ObjectPartType>();
  81     /** The service binding. */
  82     protected ServiceBindingType serviceBinding;
  83     /** The tenant binding. */
  84     private TenantBindingType tenantBinding;
  85     /** repository domain used by the service */
  86     private RepositoryDomainType repositoryDomain;
  87     /** The override document type. */
  88     private String overrideDocumentType = null;
  89     /** The val handlers. */
  90     private List<ValidatorHandler<IT, OT>> valHandlers = null;
  91     /** The doc handler. */
  92     private DocumentHandler docHandler = null;
  93     /** security context */
  94     private SecurityContext securityContext;
  95
  96     private UriInfo uriInfo;
  97
  98     /**
  99      * Instantiates a new abstract service context impl.
 100      */
 101     private AbstractServiceContextImpl() {
 102         // private constructor for singleton pattern
 103     }
 104     // request query params
 105     /** The query params. */
 106     private MultivaluedMap<String, String> queryParams;
 107
 108     /**
 109      * Instantiates a new abstract service context impl.
 110      *
 111      * @param serviceName the service name
 112      *
 113      * @throws UnauthorizedException the unauthorized exception
 114      */
 115     protected AbstractServiceContextImpl(String serviceName) throws UnauthorizedException {
 116
 117         //establish security context
 118         securityContext = new SecurityContextImpl();
 119         //make sure tenant context exists
 120         checkTenantContext();
 121
 122         //retrieve service bindings
 123         TenantBindingConfigReaderImpl tReader =
 124                 ServiceMain.getInstance().getTenantBindingConfigReader();
 125         String tenantId = securityContext.getCurrentTenantId();
 126         tenantBinding = tReader.getTenantBinding(tenantId);
 127         if (tenantBinding == null) {
 128             String msg = "No tenant binding found for tenantId=" + tenantId
 129                     + " while processing request for service= " + serviceName;
 130             logger.error(msg);
 131             throw new IllegalStateException(msg);
 132         }
 133         serviceBinding = tReader.getServiceBinding(tenantId, serviceName);
 134         if (serviceBinding == null) {
 135             String msg = "No service binding found while processing request for "
 136                     + serviceName + " for tenant id=" + getTenantId()
 137                     + " name=" + getTenantName();
 138             logger.error(msg);
 139             throw new IllegalStateException(msg);
 140         }
 141         if (logger.isDebugEnabled()) {
 142             logger.debug("tenantId=" + tenantId
 143                     + " service binding=" + serviceBinding.getName());
 144         }
 145         repositoryDomain = tReader.getRepositoryDomain(tenantId, serviceName);
 146         if (repositoryDomain != null) {
 147             if (logger.isDebugEnabled()) {
 148                 logger.debug("tenantId=" + tenantId
 149                         + " repository doamin=" + repositoryDomain.getName());
 150             }
 151         }
 152     }
 153
 154     /* (non-Javadoc)
 155      * @see org.collectionspace.services.common.context.ServiceContext#getCommonPartLabel()
 156      */
 157     @Override
 158     public String getCommonPartLabel() {
 159         return getCommonPartLabel(getServiceName());
 160     }
 161
 162     /* (non-Javadoc)
 163      * @see org.collectionspace.services.common.context.ServiceContext#getCommonPartLabel(java.lang.String)
 164      */
 165     public String getCommonPartLabel(String schemaName) {
 166         return schemaName.toLowerCase() + PART_LABEL_SEPARATOR + PART_COMMON_LABEL;
 167     }
 168
 169     /* (non-Javadoc)
 170      * @see org.collectionspace.services.common.context.ServiceContext#getPartsMetadata()
 171      */
 172     @Override
 173     public Map<String, ObjectPartType> getPartsMetadata() {
 174         if (objectPartMap.size() != 0) {
 175             return objectPartMap;
 176         }
 177         ServiceBindingUtils.getPartsMetadata(getServiceBinding(), objectPartMap);
 178         return objectPartMap;
 179     }
 180
 181     /**
 182      * Gets the properties for part.
 183      *
 184      * @param partLabel the part label
 185      *
 186      * @return the properties for part
 187      */
 188     public List<PropertyItemType> getPropertiesForPart(String partLabel) {
 189         Map<String, ObjectPartType> partMap = getPartsMetadata();
 190         ObjectPartType part = partMap.get(partLabel);
 191         if (part == null) {
 192             throw new RuntimeException("No such part found: " + partLabel);
 193         }
 194         List<PropertyType> propNodeList = part.getProperties();
 195         return propNodeList.isEmpty() ? null : propNodeList.get(0).getItem();
 196     }
 197
 198     /**
 199      * @param partLabel The name of the scehma part to search in
 200      * @param propName The name of the property (or properties) to find
 201      * @param qualified Whether the returned values should be qualified with the
 202      *          partLabel. This is when the property values are schema field references.
 203      * @return List of property values for the matched property on the named schema part.
 204      */
 205     public List<String> getPropertyValuesForPart(String partLabel, String propName, boolean qualified) {
 206         List<PropertyItemType> allProps = getPropertiesForPart(partLabel);
 207         return PropertyItemUtils.getPropertyValuesByName(allProps, propName,
 208                 (qualified ? (partLabel + ":") : null));
 209     }
 210
 211     /**
 212      * @param propName The name of the property (or properties) to find
 213      * @param qualified Whether the returned values should be qualified with the
 214      *          partLabel. This is when the property values are schema field references.
 215      * @return List of property values for the matched property on any schema part.
 216      */
 217     public List<String> getAllPartsPropertyValues(String propName, boolean qualified) {
 218         return ServiceBindingUtils.getAllPartsPropertyValues(getServiceBinding(), propName, qualified);
 219     }
 220
 221     /* (non-Javadoc)
 222      * @see org.collectionspace.services.common.context.ServiceContext#getServiceBindingPropertyValue(java.lang.String)
 223      */
 224     public String getServiceBindingPropertyValue(String propName) {
 225         return ServiceBindingUtils.getPropertyValue(getServiceBinding(), propName);
 226     }
 227
 228     /**
 229      * Gets the common part properties.
 230      *
 231      * @return the common part properties
 232      */
 233     public List<PropertyItemType> getCommonPartProperties() {
 234         return getPropertiesForPart(getCommonPartLabel());
 235     }
 236
 237     /**
 238      * @param propName The name of the property (or properties) to find
 239      * @param qualified Whether the returned values should be qualified with the
 240      *          partLabel. This is when the property values are schema field references.
 241      * @return List of property values for the matched property on the common schema part.
 242      */
 243     public List<String> getCommonPartPropertyValues(String propName, boolean qualified) {
 244         return getPropertyValuesForPart(getCommonPartLabel(), propName, qualified);
 245     }
 246
 247     /* (non-Javadoc)
 248      * @see org.collectionspace.services.common.context.ServiceContext#getQualifiedServiceName()
 249      */
 250     @Override
 251     public String getQualifiedServiceName() {
 252         return TenantBindingConfigReaderImpl.getTenantQualifiedServiceName(getTenantId(), getServiceName());
 253     }
 254
 255     /* (non-Javadoc)
 256      * @see org.collectionspace.services.common.context.ServiceContext#getRepositoryClientName()
 257      */
 258     @Override
 259     public String getRepositoryClientName() {
 260         if (repositoryDomain == null) {
 261             return null;
 262         }
 263         return repositoryDomain.getRepositoryClient();
 264     }
 265
 266     /* (non-Javadoc)
 267      * @see org.collectionspace.services.common.context.ServiceContext#getRepositoryClientType()
 268      */
 269     @Override
 270     public ClientType getRepositoryClientType() {
 271         //assumption: there is only one repository client configured
 272         return ServiceMain.getInstance().getClientType();
 273     }
 274
 275     /* (non-Javadoc)
 276      * @see org.collectionspace.services.common.context.ServiceContext#getRepositoryDomainName()
 277      */
 278     @Override
 279     public String getRepositoryDomainName() {
 280         if (repositoryDomain == null) {
 281             return null;
 282         }
 283         return repositoryDomain.getName();
 284     }
 285
 286     /* (non-Javadoc)
 287      * @see org.collectionspace.services.common.context.ServiceContext#getRepositoryWorkspaceId()
 288      */
 289     @Override
 290     public String getRepositoryWorkspaceId() {
 291         return ServiceMain.getInstance().getWorkspaceId(getTenantId(), getServiceName());
 292     }
 293
 294     /* (non-Javadoc)
 295      * @see org.collectionspace.services.common.context.ServiceContext#getRepositoryWorkspaceName()
 296      */
 297     @Override
 298     public String getRepositoryWorkspaceName() {
 299         //service name is workspace name by convention
 300         return serviceBinding.getName();
 301     }
 302
 303     /* (non-Javadoc)
 304      * @see org.collectionspace.services.common.context.ServiceContext#getServiceBinding()
 305      */
 306     @Override
 307     public ServiceBindingType getServiceBinding() {
 308         return serviceBinding;
 309     }
 310
 311     /* (non-Javadoc)
 312      * @see org.collectionspace.services.common.context.ServiceContext#getServiceName()
 313      */
 314     @Override
 315     public String getServiceName() {
 316         return serviceBinding.getName();
 317     }
 318
 319     /* (non-Javadoc)
 320      * @see org.collectionspace.services.common.context.ServiceContext#getDocumentType()
 321      */
 322     @Override
 323     public String getDocumentType() {
 324         // If they have not overridden the setting, use the type of the service
 325         // object.
 326         return (overrideDocumentType != null) ? overrideDocumentType : serviceBinding.getObject().getName();
 327     }
 328
 329     /* (non-Javadoc)
 330      * @see org.collectionspace.services.common.context.ServiceContext#setDocumentType(java.lang.String)
 331      */
 332     @Override
 333     public void setDocumentType(String docType) {
 334         overrideDocumentType = docType;
 335     }
 336
 337     /* (non-Javadoc)
 338      * @see org.collectionspace.services.common.context.ServiceContext#getSecurityContext()
 339      */
 340     @Override
 341     public SecurityContext getSecurityContext() {
 342         return securityContext;
 343     }
 344
 345     /* (non-Javadoc)
 346      * @see org.collectionspace.services.common.context.ServiceContext#getUserId()
 347      */
 348     @Override
 349     public String getUserId() {
 350         return securityContext.getUserId();
 351     }
 352
 353     /* (non-Javadoc)
 354      * @see org.collectionspace.services.common.context.ServiceContext#getTenantId()
 355      */
 356     @Override
 357     public String getTenantId() {
 358         return securityContext.getCurrentTenantId();
 359     }
 360
 361     /* (non-Javadoc)
 362      * @see org.collectionspace.services.common.context.ServiceContext#getTenantName()
 363      */
 364     @Override
 365     public String getTenantName() {
 366         return securityContext.getCurrentTenantName();
 367     }
 368
 369     /* (non-Javadoc)
 370      * @see org.collectionspace.services.common.context.ServiceContext#getInput()
 371      */
 372     @Override
 373     public abstract IT getInput();
 374
 375     /* (non-Javadoc)
 376      * @see org.collectionspace.services.common.context.ServiceContext#setInput(java.lang.Object)
 377      */
 378     @Override
 379     public abstract void setInput(IT input);
 380
 381     /* (non-Javadoc)
 382      * @see org.collectionspace.services.common.context.ServiceContext#getOutput()
 383      */
 384     @Override
 385     public abstract OT getOutput();
 386
 387     /* (non-Javadoc)
 388      * @see org.collectionspace.services.common.context.ServiceContext#setOutput(java.lang.Object)
 389      */
 390     @Override
 391     public abstract void setOutput(OT output);
 392
 393     /* (non-Javadoc)
 394      * @see org.collectionspace.services.common.context.ServiceContext#getProperties()
 395      */
 396     @Override
 397     public Map<String, Object> getProperties() {
 398         return properties;
 399     }
 400
 401     /* (non-Javadoc)
 402      * @see org.collectionspace.services.common.context.ServiceContext#setProperties(java.util.Map)
 403      */
 404     @Override
 405     public void setProperties(Map<String, Object> props) {
 406         properties.putAll(props);
 407     }
 408
 409     /* (non-Javadoc)
 410      * @see org.collectionspace.services.common.context.ServiceContext#getProperty(java.lang.String)
 411      */
 412     public Object getProperty(String name) {
 413         return properties.get(name);
 414     }
 415
 416     /* (non-Javadoc)
 417      * @see org.collectionspace.services.common.context.ServiceContext#setProperty(java.lang.String, java.lang.Object)
 418      */
 419     public void setProperty(String name, Object o) {
 420         properties.put(name, o);
 421     }
 422
 423     /**
 424      * checkTenantContext makss sure tenant context exists
 425      *
 426      * @return the string
 427      *
 428      * @throws UnauthorizedException the unauthorized exception
 429      */
 430     private void checkTenantContext() throws UnauthorizedException {
 431
 432         String tenantId = securityContext.getCurrentTenantId();
 433         if (tenantId == null) {
 434             String msg = "Could not find tenant context";
 435             logger.error(msg);
 436             throw new UnauthorizedException(msg);
 437         }
 438     }
 439
 440     private static String buildWorkflowWhereClause(MultivaluedMap<String, String> queryParams) {
 441         String result = null;
 442
 443         String includeDeleted = queryParams.getFirst(WorkflowClient.WORKFLOW_QUERY_NONDELETED);
 444         if (includeDeleted != null && includeDeleted.equalsIgnoreCase(Boolean.FALSE.toString())) {
 445                 result = "ecm:currentLifeCycleState <> 'deleted'";
 446         }
 447
 448         return result;
 449     }
 450
 451     /**
 452      * Creates the document handler instance.
 453      *
 454      * @return the document handler
 455      *
 456      * @throws Exception the exception
 457      */
 458     private DocumentHandler createDocumentHandlerInstance() throws Exception {
 459         ClassLoader tccl = Thread.currentThread().getContextClassLoader();
 460         Class<?> c = tccl.loadClass(getDocumentHandlerClass());
 461         if (DocumentHandler.class.isAssignableFrom(c)) {
 462             docHandler = (DocumentHandler) c.newInstance();
 463         } else {
 464             throw new IllegalArgumentException("Not of type "
 465                     + DocumentHandler.class.getCanonicalName());
 466         }
 467         //
 468         // Create a default document filter
 469         //
 470         docHandler.setServiceContext(this);
 471         DocumentFilter docFilter = docHandler.createDocumentFilter();
 472         //
 473         // If the context was created with query parameters,
 474         // reflect the values of those parameters in the document filter
 475         // to specify sort ordering, pagination, etc.
 476         //
 477         if (this.getQueryParams() != null) {
 478           docFilter.setSortOrder(this.getQueryParams());
 479           docFilter.setPagination(this.getQueryParams());
 480           String workflowWhereClause = buildWorkflowWhereClause(queryParams);
 481           if (workflowWhereClause != null) {
 482                   docFilter.appendWhereClause(workflowWhereClause, IQueryManager.SEARCH_QUALIFIER_AND);
 483           }
 484
 485         }
 486         docHandler.setDocumentFilter(docFilter);
 487
 488         return docHandler;
 489     }
 490
 491     /* (non-Javadoc)
 492      * @see org.collectionspace.services.common.context.ServiceContext#getDocumentHandler()
 493      */
 494     @Override
 495     public DocumentHandler getDocumentHandler() throws Exception {
 496         DocumentHandler result = docHandler;
 497         // create a new instance if one does not yet exist
 498         if (result == null) {
 499             result = createDocumentHandlerInstance();
 500         }
 501         return result;
 502     }
 503
 504     /* (non-Javadoc)
 505      * @see org.collectionspace.services.common.context.ServiceContext#getDocumentHanlder(javax.ws.rs.core.MultivaluedMap)
 506      */
 507     @Override
 508     public DocumentHandler getDocumentHandler(MultivaluedMap<String, String> queryParams) throws Exception {
 509         DocumentHandler result = getDocumentHandler();
 510         DocumentFilter documentFilter = result.getDocumentFilter(); //to see results in debugger variables view
 511         documentFilter.setPagination(queryParams);
 512         return result;
 513     }
 514
 515     /**
 516      * Gets the document handler class.
 517      *
 518      * @return the document handler class
 519      */
 520     private String getDocumentHandlerClass() {
 521         if (serviceBinding.getDocumentHandler() == null
 522                 || serviceBinding.getDocumentHandler().isEmpty()) {
 523             String msg = "Missing documentHandler in service binding for "
 524                     + getServiceName() + " for tenant id=" + getTenantId()
 525                     + " name=" + getTenantName();
 526             logger.error(msg);
 527             throw new IllegalStateException(msg);
 528         }
 529         return serviceBinding.getDocumentHandler().trim();
 530     }
 531
 532     /*
 533      * If this element is set in the service binding then use it otherwise
 534      * assume that asserts are NOT disabled.
 535      */
 536     private boolean disableValidationAsserts() {
 537         boolean result;
 538         Boolean disableAsserts = getServiceBinding().isDisableAsserts();
 539         result = (disableAsserts != null) ? disableAsserts : false;
 540         return result;
 541     }
 542
 543     /* (non-Javadoc)
 544      * @see org.collectionspace.services.common.context.ServiceContext#getValidatorHandlers()
 545      */
 546     @Override
 547     public List<ValidatorHandler<IT, OT>> getValidatorHandlers() throws Exception {
 548         if (valHandlers != null) {
 549             return valHandlers;
 550         }
 551         List<String> handlerClazzes = getServiceBinding().getValidatorHandler();
 552         List<ValidatorHandler<IT, OT>> handlers = new ArrayList<ValidatorHandler<IT, OT>>(handlerClazzes.size());
 553         ClassLoader tccl = Thread.currentThread().getContextClassLoader();
 554         for (String clazz : handlerClazzes) {
 555             clazz = clazz.trim();
 556             Class<?> c = tccl.loadClass(clazz);
 557             if (disableValidationAsserts() == false) {
 558                 // enable validation assertions
 559                 tccl.setClassAssertionStatus(clazz, true);
 560             }
 561             if (ValidatorHandler.class.isAssignableFrom(c)) {
 562                 handlers.add((ValidatorHandler) c.newInstance());
 563             }
 564         }
 565         valHandlers = handlers;
 566         return valHandlers;
 567     }
 568
 569     /* (non-Javadoc)
 570      * @see java.lang.Object#toString()
 571      */
 572     @Override
 573     public String toString() {
 574         StringBuilder msg = new StringBuilder();
 575         msg.append("AbstractServiceContext [");
 576         msg.append("service name=" + serviceBinding.getName() + " ");
 577         msg.append("service version=" + serviceBinding.getVersion() + " ");
 578         msg.append("tenant id=" + tenantBinding.getId() + " ");
 579         msg.append("tenant name=" + tenantBinding.getName() + " ");
 580         msg.append(tenantBinding.getDisplayName() + " ");
 581         if (repositoryDomain != null) {
 582             msg.append("tenant repository domain=" + repositoryDomain.getName());
 583         }
 584         for (Map.Entry<String, Object> entry : properties.entrySet()) {
 585             msg.append("property name=" + entry.getKey() + " value=" + entry.getValue().toString());
 586         }
 587         msg.append("]");
 588         return msg.toString();
 589     }
 590
 591     /* (non-Javadoc)
 592      * @see org.collectionspace.services.common.context.ServiceContext#getQueryParams()
 593      */
 594     @Override
 595     public MultivaluedMap<String, String> getQueryParams() {
 596
 597          if (queryParams == null){
 598               if (this.uriInfo != null){
 599                 queryParams = this.uriInfo.getQueryParameters();
 600             }
 601          }
 602          if (queryParams == null){
 603              queryParams = new org.jboss.resteasy.specimpl.MultivaluedMapImpl<String,String>();
 604         }
 605         return this.queryParams;
 606     }
 607
 608     @Override
 609      public MultivaluedMap<String, String> getQueryParamsPtr() {
 610            return this.queryParams;
 611     }
 612
 613     /* (non-Javadoc)
 614      * @see org.collectionspace.services.common.context.ServiceContext#setQueryParams(javax.ws.rs.core.MultivaluedMap)
 615      */
 616     @Override
 617     public void setQueryParams(MultivaluedMap<String, String> theQueryParams) {
 618         this.queryParams = theQueryParams;
 619     }
 620
 621     @Override
 622     public void setUriInfo(UriInfo ui){
 623         this.uriInfo = ui;
 624     }
 625
 626    @Override
 627    public UriInfo getUriInfo(){
 628         return this.uriInfo;
 629     }
 630 }