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

   1 /**
   2  * This document is a part of the source code and related artifacts for
   3  * CollectionSpace, an open source collections management system for museums and
   4  * related institutions:
   5  *
   6  * http://www.collectionspace.org http://wiki.collectionspace.org
   7  *
   8  * Copyright 2009 University of California at Berkeley
   9  *
  10  * Licensed under the Educational Community License (ECL), Version 2.0. You may
  11  * not use this file except in compliance with this License.
  12  *
  13  * You may obtain a copy of the ECL 2.0 License at
  14  *
  15  * https://source.collectionspace.org/collection-space/LICENSE.txt
  16  */
  17 package org.collectionspace.services.nuxeo.client.java;
  18
  19 import java.io.Serializable;
  20 import java.sql.SQLException;
  21 import java.util.ArrayList;
  22 import java.util.Collections;
  23 import java.util.Comparator;
  24 import java.util.HashSet;
  25 import java.util.Hashtable;
  26 import java.util.Iterator;
  27 import java.util.List;
  28 import java.util.Map;
  29 import java.util.Set;
  30 import java.util.UUID;
  31
  32 import javax.sql.rowset.CachedRowSet;
  33 import javax.ws.rs.core.MultivaluedMap;
  34
  35 import org.collectionspace.services.lifecycle.TransitionDef;
  36 import org.collectionspace.services.nuxeo.util.CSReindexFulltextRoot;
  37 import org.collectionspace.services.nuxeo.util.NuxeoUtils;
  38 import org.collectionspace.services.client.CollectionSpaceClient;
  39 import org.collectionspace.services.client.IQueryManager;
  40 import org.collectionspace.services.client.PoxPayloadIn;
  41 import org.collectionspace.services.client.PoxPayloadOut;
  42 import org.collectionspace.services.client.Profiler;
  43 import org.collectionspace.services.client.workflow.WorkflowClient;
  44 import org.collectionspace.services.common.context.ServiceContext;
  45 import org.collectionspace.services.common.query.QueryContext;
  46 import org.collectionspace.services.common.repository.RepositoryClient;
  47 import org.collectionspace.services.common.storage.JDBCTools;
  48 import org.collectionspace.services.common.storage.PreparedStatementSimpleBuilder;
  49 import org.collectionspace.services.common.document.BadRequestException;
  50 import org.collectionspace.services.common.document.DocumentException;
  51 import org.collectionspace.services.common.document.DocumentFilter;
  52 import org.collectionspace.services.common.document.DocumentHandler;
  53 import org.collectionspace.services.common.document.DocumentNotFoundException;
  54 import org.collectionspace.services.common.document.DocumentHandler.Action;
  55 import org.collectionspace.services.common.document.DocumentWrapper;
  56 import org.collectionspace.services.common.document.DocumentWrapperImpl;
  57 import org.collectionspace.services.common.document.TransactionException;
  58 import org.collectionspace.services.common.CSWebApplicationException;
  59 import org.collectionspace.services.common.ServiceMain;
  60 import org.collectionspace.services.common.api.Tools;
  61 import org.collectionspace.services.common.config.ConfigUtils;
  62 import org.collectionspace.services.common.config.TenantBindingConfigReaderImpl;
  63 import org.collectionspace.services.common.config.TenantBindingUtils;
  64 import org.collectionspace.services.common.storage.PreparedStatementBuilder;
  65 import org.collectionspace.services.common.vocabulary.RefNameServiceUtils.AuthorityItemSpecifier;
  66 import org.collectionspace.services.common.vocabulary.RefNameServiceUtils.Specifier;
  67 import org.collectionspace.services.config.tenant.TenantBindingType;
  68 import org.collectionspace.services.config.tenant.RepositoryDomainType;
  69
  70 //
  71 // CSPACE-5036 - How to make CMISQL queries from Nuxeo
  72 //
  73 import org.apache.chemistry.opencmis.commons.enums.CmisVersion;
  74 import org.apache.chemistry.opencmis.commons.server.CallContext;
  75 import org.apache.chemistry.opencmis.server.impl.CallContextImpl;
  76 import org.apache.chemistry.opencmis.server.shared.ThresholdOutputStreamFactory;
  77 import org.nuxeo.common.utils.IdUtils;
  78 import org.nuxeo.ecm.core.api.ClientException;
  79 import org.nuxeo.ecm.core.api.DocumentModel;
  80 import org.nuxeo.ecm.core.api.DocumentModelList;
  81 import org.nuxeo.ecm.core.api.IterableQueryResult;
  82 import org.nuxeo.ecm.core.api.VersioningOption;
  83 import org.nuxeo.ecm.core.api.impl.DocumentModelListImpl;
  84 import org.nuxeo.ecm.core.api.DocumentRef;
  85 import org.nuxeo.ecm.core.api.IdRef;
  86 import org.nuxeo.ecm.core.api.PathRef;
  87 import org.nuxeo.runtime.transaction.TransactionRuntimeException;
  88 import org.nuxeo.ecm.core.opencmis.bindings.NuxeoCmisServiceFactory;
  89 import org.nuxeo.ecm.core.opencmis.impl.server.NuxeoCmisService;
  90 import org.slf4j.Logger;
  91 import org.slf4j.LoggerFactory;
  92
  93 /**
  94  * RepositoryClientImpl is used to perform CRUD operations on documents in Nuxeo
  95  * repository using Remote Java APIs. It uses
  96  *
  97  * @see DocumentHandler as IOHandler with the client.
  98  *
  99  * $LastChangedRevision: $ $LastChangedDate: $
 100  */
 101 public class RepositoryClientImpl implements RepositoryClient<PoxPayloadIn, PoxPayloadOut> {
 102
 103     /**
 104      * The logger.
 105      */
 106     private final Logger logger = LoggerFactory.getLogger(RepositoryClientImpl.class);
 107 //    private final Logger profilerLogger = LoggerFactory.getLogger("remperf");
 108 //    private String foo = Profiler.createLogger();
 109     public static final String NUXEO_CORE_TYPE_DOMAIN = "Domain";
 110     public static final String NUXEO_CORE_TYPE_WORKSPACEROOT = "WorkspaceRoot";
 111     // FIXME: Get this value from an existing constant, if available
 112     public static final String BACKSLASH = "\\";
 113     public static final String USER_SUPPLIED_WILDCARD = "*";
 114     public static final String USER_SUPPLIED_WILDCARD_REGEX = BACKSLASH + USER_SUPPLIED_WILDCARD;
 115     public static final String USER_SUPPLIED_ANCHOR_CHAR = "^";
 116     public static final String USER_SUPPLIED_ANCHOR_CHAR_REGEX = BACKSLASH + USER_SUPPLIED_ANCHOR_CHAR;
 117     public static final String ENDING_ANCHOR_CHAR = "$";
 118     public static final String ENDING_ANCHOR_CHAR_REGEX = BACKSLASH + ENDING_ANCHOR_CHAR;
 119
 120
 121     /**
 122      * Instantiates a new repository java client impl.
 123      */
 124     public RepositoryClientImpl() {
 125         //Empty constructor
 126     }
 127
 128     public void assertWorkflowState(ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx, DocumentModel docModel) throws DocumentNotFoundException, ClientException {
 129         MultivaluedMap<String, String> queryParams = ctx.getQueryParams();
 130         if (queryParams != null) {
 131             //
 132             // Look for the workflow "delete" query param and see if we need to assert that the
 133             // docModel is in a non-deleted workflow state.
 134             //
 135             String currentState = docModel.getCurrentLifeCycleState();
 136             String includeDeletedStr = queryParams.getFirst(WorkflowClient.WORKFLOW_QUERY_NONDELETED);
 137             boolean includeDeleted = (includeDeletedStr == null) ? true : Boolean.parseBoolean(includeDeletedStr);
 138             if (includeDeleted == false) {
 139                 //
 140                 // We don't wanted soft-deleted objects, so throw an exception if this one is soft-deleted.
 141                 //
 142                 if (currentState.contains(WorkflowClient.WORKFLOWSTATE_DELETED)) {
 143                     String msg = "The GET assertion that docModel not be in 'deleted' workflow state failed.";
 144                     logger.debug(msg);
 145                     throw new DocumentNotFoundException(msg);
 146                 }
 147             }
 148         }
 149     }
 150
 151     /**
 152      * create document in the Nuxeo repository
 153      *
 154      * @param ctx service context under which this method is invoked
 155      * @param handler should be used by the caller to provide and transform the
 156      * document
 157      * @return id in repository of the newly created document
 158      * @throws BadRequestException
 159      * @throws TransactionException
 160      * @throws DocumentException
 161      */
 162     @Override
 163     public String create(ServiceContext ctx,
 164             DocumentHandler handler) throws BadRequestException,
 165             TransactionException, DocumentException {
 166
 167         String docType = NuxeoUtils.getTenantQualifiedDocType(ctx); //ctx.getDocumentType();
 168         if (docType == null) {
 169             throw new IllegalArgumentException(
 170                     "RepositoryJavaClient.create: docType is missing");
 171         }
 172
 173         if (handler == null) {
 174             throw new IllegalArgumentException(
 175                     "RepositoryJavaClient.create: handler is missing");
 176         }
 177         String nuxeoWspaceId = ctx.getRepositoryWorkspaceId();
 178         if (nuxeoWspaceId == null) {
 179             throw new DocumentNotFoundException(
 180                     "Unable to find workspace for service " + ctx.getServiceName()
 181                     + " check if the workspace exists in the Nuxeo repository");
 182         }
 183
 184         CoreSessionInterface repoSession = null;
 185         try {
 186             handler.prepare(Action.CREATE);
 187             repoSession = getRepositorySession(ctx);
 188             DocumentRef nuxeoWspace = new IdRef(nuxeoWspaceId);
 189             DocumentModel wspaceDoc = repoSession.getDocument(nuxeoWspace);
 190             String wspacePath = wspaceDoc.getPathAsString();
 191             //give our own ID so PathRef could be constructed later on
 192             String id = IdUtils.generateId(UUID.randomUUID().toString());
 193             // create document model
 194             DocumentModel doc = repoSession.createDocumentModel(wspacePath, id, docType);
 195             /* Check for a versioned document, and check In and Out before we proceed.
 196              * This does not work as we do not have the uid schema on our docs.
 197              if(((DocumentModelHandler) handler).supportsVersioning()) {
 198              doc.setProperty("uid","major_version",1);
 199              doc.setProperty("uid","minor_version",0);
 200              }
 201              */
 202             ((DocumentModelHandler) handler).setRepositorySession(repoSession);
 203             DocumentWrapper<DocumentModel> wrapDoc = new DocumentWrapperImpl<DocumentModel>(doc);
 204             handler.handle(Action.CREATE, wrapDoc);
 205             // create document with documentmodel
 206             doc = repoSession.createDocument(doc);
 207             repoSession.save();
 208 // TODO for sub-docs need to call into the handler to let it deal with subitems. Pass in the id,
 209 // and assume the handler has the state it needs (doc fragments).
 210             handler.complete(Action.CREATE, wrapDoc);
 211             return id;
 212         } catch (BadRequestException bre) {
 213             throw bre;
 214         } catch (Exception e) {
 215             throw new NuxeoDocumentException(e);
 216         } finally {
 217             if (repoSession != null) {
 218                 releaseRepositorySession(ctx, repoSession);
 219             }
 220         }
 221
 222     }
 223
 224
 225     @Override
 226     public boolean reindex(DocumentHandler handler, String indexid) throws DocumentNotFoundException, DocumentException
 227     {
 228         return reindex(handler, null, indexid);
 229     }
 230
 231     @Override
 232     public boolean reindex(DocumentHandler handler, String csid, String indexid) throws DocumentNotFoundException, DocumentException
 233     {
 234         boolean result = true;
 235         CoreSessionInterface repoSession = null;
 236         ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx = handler.getServiceContext();
 237
 238         try {
 239             String queryString = handler.getDocumentsToIndexQuery(indexid, csid);
 240             repoSession = getRepositorySession(ctx);
 241             CSReindexFulltextRoot indexer = new CSReindexFulltextRoot(repoSession);
 242             indexer.reindexFulltext(0, 0, queryString);
 243             //
 244             // Set repository session to handle the document
 245             //
 246         } catch (Exception e) {
 247             if (logger.isDebugEnabled()) {
 248                 logger.debug("Caught exception ", e);
 249             }
 250             throw new NuxeoDocumentException(e);
 251         } finally {
 252             if (repoSession != null) {
 253                 releaseRepositorySession(ctx, repoSession);
 254             }
 255         }
 256
 257         return result;
 258     }
 259
 260     @Override
 261     public boolean synchronize(ServiceContext ctx, Object specifier, DocumentHandler handler)
 262             throws DocumentNotFoundException, TransactionException, DocumentException {
 263         boolean result = false;
 264
 265         if (handler == null) {
 266             throw new IllegalArgumentException(
 267                     "RepositoryJavaClient.get: handler is missing");
 268         }
 269
 270         CoreSessionInterface repoSession = null;
 271         try {
 272             handler.prepare(Action.SYNC);
 273             repoSession = getRepositorySession(ctx);
 274             ((DocumentModelHandler) handler).setRepositorySession(repoSession);
 275             DocumentWrapper<Object> wrapDoc = new DocumentWrapperImpl<Object>(specifier);
 276             result = handler.handle(Action.SYNC, wrapDoc);
 277             handler.complete(Action.SYNC, wrapDoc);
 278         } catch (IllegalArgumentException iae) {
 279             throw iae;
 280         } catch (DocumentException de) {
 281             throw de;
 282         } catch (Exception e) {
 283             if (logger.isDebugEnabled()) {
 284                 logger.debug("Caught exception ", e);
 285             }
 286             throw new NuxeoDocumentException(e);
 287         } finally {
 288             if (repoSession != null) {
 289                 releaseRepositorySession(ctx, repoSession);
 290             }
 291         }
 292
 293         return result;
 294     }
 295
 296     @Override
 297     public boolean synchronizeItem(ServiceContext ctx, AuthorityItemSpecifier itemSpecifier, DocumentHandler handler)
 298             throws DocumentNotFoundException, TransactionException, DocumentException {
 299         boolean result = false;
 300
 301         if (handler == null) {
 302             throw new IllegalArgumentException(
 303                     "RepositoryJavaClient.get: handler is missing");
 304         }
 305
 306         CoreSessionInterface repoSession = null;
 307         try {
 308             handler.prepare(Action.SYNC);
 309             repoSession = getRepositorySession(ctx);
 310             ((DocumentModelHandler) handler).setRepositorySession(repoSession);
 311             DocumentWrapper<AuthorityItemSpecifier> wrapDoc = new DocumentWrapperImpl<AuthorityItemSpecifier>(itemSpecifier);
 312             result = handler.handle(Action.SYNC, wrapDoc);
 313             handler.complete(Action.SYNC, wrapDoc);
 314         } catch (IllegalArgumentException iae) {
 315             throw iae;
 316         } catch (DocumentException de) {
 317             throw de;
 318         } catch (Exception e) {
 319             if (logger.isDebugEnabled()) {
 320                 logger.debug("Caught exception ", e);
 321             }
 322             throw new NuxeoDocumentException(e);
 323         } finally {
 324             if (repoSession != null) {
 325                 releaseRepositorySession(ctx, repoSession);
 326             }
 327         }
 328
 329         return result;
 330     }
 331
 332     /**
 333      * get document from the Nuxeo repository
 334      *
 335      * @param ctx service context under which this method is invoked
 336      * @param id of the document to retrieve
 337      * @param handler should be used by the caller to provide and transform the
 338      * document
 339      * @throws DocumentNotFoundException if the document cannot be found in the
 340      * repository
 341      * @throws TransactionException
 342      * @throws DocumentException
 343      */
 344     @Override
 345     public void get(ServiceContext ctx, String id, DocumentHandler handler)
 346             throws DocumentNotFoundException, TransactionException, DocumentException {
 347
 348         if (handler == null) {
 349             throw new IllegalArgumentException(
 350                     "RepositoryJavaClient.get: handler is missing");
 351         }
 352
 353         CoreSessionInterface repoSession = null;
 354         try {
 355             handler.prepare(Action.GET);
 356             repoSession = getRepositorySession(ctx);
 357             DocumentRef docRef = NuxeoUtils.createPathRef(ctx, id);
 358             DocumentModel docModel = null;
 359             try {
 360                 docModel = repoSession.getDocument(docRef);
 361                 assertWorkflowState(ctx, docModel);
 362             } catch (ClientException ce) {
 363                 String msg = logException(ce, "Could not find document with CSID=" + id);
 364                 throw new DocumentNotFoundException(msg, ce);
 365             }
 366             //
 367             // Set repository session to handle the document
 368             //
 369             ((DocumentModelHandler) handler).setRepositorySession(repoSession);
 370             DocumentWrapper<DocumentModel> wrapDoc = new DocumentWrapperImpl<DocumentModel>(docModel);
 371             handler.handle(Action.GET, wrapDoc);
 372             handler.complete(Action.GET, wrapDoc);
 373         } catch (IllegalArgumentException iae) {
 374             throw iae;
 375         } catch (DocumentException de) {
 376             throw de;
 377         } catch (Exception e) {
 378             if (logger.isDebugEnabled()) {
 379                 logger.debug("Caught exception ", e);
 380             }
 381             throw new NuxeoDocumentException(e);
 382         } finally {
 383             if (repoSession != null) {
 384                 releaseRepositorySession(ctx, repoSession);
 385             }
 386         }
 387     }
 388
 389     /**
 390      * get a document from the Nuxeo repository, using the docFilter params.
 391      *
 392      * @param ctx service context under which this method is invoked
 393      * @param handler should be used by the caller to provide and transform the
 394      * document. Handler must have a docFilter set to return a single item.
 395      * @throws DocumentNotFoundException if the document cannot be found in the
 396      * repository
 397      * @throws TransactionException
 398      * @throws DocumentException
 399      */
 400     @Override
 401     public void get(ServiceContext ctx, DocumentHandler handler)
 402             throws DocumentNotFoundException, TransactionException, DocumentException {
 403         QueryContext queryContext = new QueryContext(ctx, handler);
 404         CoreSessionInterface repoSession = null;
 405
 406         try {
 407             handler.prepare(Action.GET);
 408             repoSession = getRepositorySession(ctx);
 409
 410             DocumentModelList docList = null;
 411             // force limit to 1, and ignore totalSize
 412             String query = NuxeoUtils.buildNXQLQuery(ctx, queryContext);
 413             docList = repoSession.query(query, null, 1, 0, false);
 414             if (docList.size() != 1) {
 415                 throw new DocumentNotFoundException("No document found matching filter params: " + query);
 416             }
 417             DocumentModel doc = docList.get(0);
 418
 419             if (logger.isDebugEnabled()) {
 420                 logger.debug("Executed NXQL query: " + query);
 421             }
 422
 423             //set reposession to handle the document
 424             ((DocumentModelHandler) handler).setRepositorySession(repoSession);
 425             DocumentWrapper<DocumentModel> wrapDoc = new DocumentWrapperImpl<DocumentModel>(doc);
 426             handler.handle(Action.GET, wrapDoc);
 427             handler.complete(Action.GET, wrapDoc);
 428         } catch (IllegalArgumentException iae) {
 429             throw iae;
 430         } catch (DocumentException de) {
 431             throw de;
 432         } catch (Exception e) {
 433             if (logger.isDebugEnabled()) {
 434                 logger.debug("Caught exception ", e);
 435             }
 436             throw new NuxeoDocumentException(e);
 437         } finally {
 438             if (repoSession != null) {
 439                 releaseRepositorySession(ctx, repoSession);
 440             }
 441         }
 442     }
 443
 444     public DocumentWrapper<DocumentModel> getDoc(
 445                 CoreSessionInterface repoSession,
 446             ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx,
 447             String csid) throws DocumentNotFoundException, DocumentException {
 448         DocumentWrapper<DocumentModel> wrapDoc = null;
 449
 450         try {
 451             DocumentRef docRef = NuxeoUtils.createPathRef(ctx, csid);
 452             DocumentModel doc = null;
 453             try {
 454                 doc = repoSession.getDocument(docRef);
 455             } catch (ClientException ce) {
 456                 String msg = logException(ce, "Could not find document with CSID=" + csid);
 457                 throw new DocumentNotFoundException(msg, ce);
 458             }
 459             wrapDoc = new DocumentWrapperImpl<DocumentModel>(doc);
 460         } catch (IllegalArgumentException iae) {
 461             throw iae;
 462         } catch (DocumentException de) {
 463             throw de;
 464         }
 465
 466         return wrapDoc;
 467     }
 468
 469     /**
 470      * Get wrapped documentModel from the Nuxeo repository. The search is
 471      * restricted to the workspace of the current context.
 472      *
 473      * @param ctx service context under which this method is invoked
 474      * @param csid of the document to retrieve
 475      * @throws DocumentNotFoundException
 476      * @throws TransactionException
 477      * @throws DocumentException
 478      * @return a wrapped documentModel
 479      */
 480     @Override
 481     public DocumentWrapper<DocumentModel> getDoc(
 482             ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx,
 483             String csid) throws DocumentNotFoundException, TransactionException, DocumentException {
 484         CoreSessionInterface repoSession = null;
 485         DocumentWrapper<DocumentModel> wrapDoc = null;
 486
 487         try {
 488             // Open a new repository session
 489             repoSession = getRepositorySession(ctx);
 490             wrapDoc = getDoc(repoSession, ctx, csid);
 491         } catch (IllegalArgumentException iae) {
 492             throw iae;
 493         } catch (DocumentException de) {
 494             throw de;
 495         } catch (Exception e) {
 496             if (logger.isDebugEnabled()) {
 497                 logger.debug("Caught exception ", e);
 498             }
 499             throw new NuxeoDocumentException(e);
 500         } finally {
 501             if (repoSession != null) {
 502                 releaseRepositorySession(ctx, repoSession);
 503             }
 504         }
 505
 506         if (logger.isWarnEnabled() == true) {
 507             logger.warn("Returned DocumentModel instance was created with a repository session that is now closed.");
 508         }
 509         return wrapDoc;
 510     }
 511
 512     public DocumentWrapper<DocumentModel> findDoc(
 513                 CoreSessionInterface repoSession,
 514             ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx,
 515             String whereClause)
 516             throws DocumentNotFoundException, DocumentException {
 517         DocumentWrapper<DocumentModel> wrapDoc = null;
 518
 519         try {
 520             QueryContext queryContext = new QueryContext(ctx, whereClause);
 521             DocumentModelList docList = null;
 522             // force limit to 1, and ignore totalSize
 523             String query = NuxeoUtils.buildNXQLQuery(ctx, queryContext);
 524             docList = repoSession.query(query,
 525                     null, //Filter
 526                     1, //limit
 527                     0, //offset
 528                     false); //countTotal
 529             if (docList.size() != 1) {
 530                 if (logger.isDebugEnabled()) {
 531                     logger.debug("findDoc: Query found: " + docList.size() + " items.");
 532                     logger.debug(" Query: " + query);
 533                 }
 534                 throw new DocumentNotFoundException("No document found matching filter params: " + query);
 535             }
 536             DocumentModel doc = docList.get(0);
 537             wrapDoc = new DocumentWrapperImpl<DocumentModel>(doc);
 538         } catch (IllegalArgumentException iae) {
 539             throw iae;
 540         } catch (DocumentException de) {
 541             throw de;
 542         } catch (Exception e) {
 543             if (logger.isDebugEnabled()) {
 544                 logger.debug("Caught exception ", e);
 545             }
 546             throw new NuxeoDocumentException(e);
 547         }
 548
 549         return wrapDoc;
 550     }
 551
 552     /**
 553      * find wrapped documentModel from the Nuxeo repository
 554      *
 555      * @param ctx service context under which this method is invoked
 556      * @param whereClause where NXQL where clause to get the document
 557      * @throws DocumentNotFoundException
 558      * @throws TransactionException
 559      * @throws DocumentException
 560      * @return a wrapped documentModel retrieved by the repository query
 561      */
 562     @Override
 563     public DocumentWrapper<DocumentModel> findDoc(
 564             ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx,
 565             String whereClause)
 566             throws DocumentNotFoundException, TransactionException, DocumentException {
 567         CoreSessionInterface repoSession = null;
 568         DocumentWrapper<DocumentModel> wrapDoc = null;
 569
 570         try {
 571             repoSession = getRepositorySession(ctx);
 572             wrapDoc = findDoc(repoSession, ctx, whereClause);
 573         } catch (DocumentNotFoundException dnfe) {
 574                 throw dnfe;
 575         } catch (DocumentException de) {
 576                 throw de;
 577         } catch (Exception e) {
 578                 if (repoSession == null) {
 579                         throw new NuxeoDocumentException("Unable to create a Nuxeo repository session.", e);
 580                 } else {
 581                         throw new NuxeoDocumentException("Unexpected Nuxeo exception.", e);
 582                 }
 583         } finally {
 584             if (repoSession != null) {
 585                 releaseRepositorySession(ctx, repoSession);
 586             }
 587         }
 588
 589         if (logger.isWarnEnabled() == true) {
 590             logger.warn("Returned DocumentModel instance was created with a repository session that is now closed.");
 591         }
 592
 593         return wrapDoc;
 594     }
 595
 596     /**
 597      * find doc and return CSID from the Nuxeo repository
 598      *
 599      * @param repoSession
 600      * @param ctx service context under which this method is invoked
 601      * @param whereClause where NXQL where clause to get the document
 602      * @throws DocumentNotFoundException
 603      * @throws TransactionException
 604      * @throws DocumentException
 605      * @return the CollectionSpace ID (CSID) of the requested document
 606      */
 607     @Override
 608     public String findDocCSID(CoreSessionInterface repoSession,
 609             ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx, String whereClause)
 610             throws DocumentNotFoundException, TransactionException, DocumentException {
 611         String csid = null;
 612         boolean releaseSession = false;
 613         try {
 614             if (repoSession == null) {
 615                 repoSession = this.getRepositorySession(ctx);
 616                 releaseSession = true;
 617             }
 618             DocumentWrapper<DocumentModel> wrapDoc = findDoc(repoSession, ctx, whereClause);
 619             DocumentModel docModel = wrapDoc.getWrappedObject();
 620             csid = NuxeoUtils.getCsid(docModel);//NuxeoUtils.extractId(docModel.getPathAsString());
 621         } catch (DocumentNotFoundException dnfe) {
 622             throw dnfe;
 623         } catch (IllegalArgumentException iae) {
 624             throw iae;
 625         } catch (DocumentException de) {
 626             throw de;
 627         } catch (Exception e) {
 628             if (logger.isDebugEnabled()) {
 629                 logger.debug("Caught exception ", e);
 630             }
 631             throw new NuxeoDocumentException(e);
 632         } finally {
 633             if (releaseSession && (repoSession != null)) {
 634                 this.releaseRepositorySession(ctx, repoSession);
 635             }
 636         }
 637         return csid;
 638     }
 639
 640     public DocumentWrapper<DocumentModelList> findDocs(
 641             ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx,
 642             CoreSessionInterface repoSession,
 643             List<String> docTypes,
 644             String whereClause,
 645             String orderByClause,
 646             int pageSize,
 647             int pageNum,
 648             boolean computeTotal)
 649             throws DocumentNotFoundException, DocumentException {
 650         DocumentWrapper<DocumentModelList> wrapDoc = null;
 651
 652         try {
 653             if (docTypes == null || docTypes.size() < 1) {
 654                 throw new DocumentNotFoundException(
 655                         "The findDocs() method must specify at least one DocumentType.");
 656             }
 657             DocumentModelList docList = null;
 658             QueryContext queryContext = new QueryContext(ctx, whereClause, orderByClause);
 659             String query = NuxeoUtils.buildNXQLQuery(docTypes, queryContext);
 660             if (logger.isDebugEnabled()) {
 661                 logger.debug("findDocs() NXQL: " + query);
 662             }
 663             docList = repoSession.query(query, null, pageSize, pageSize * pageNum, computeTotal);
 664             wrapDoc = new DocumentWrapperImpl<DocumentModelList>(docList);
 665         } catch (IllegalArgumentException iae) {
 666             throw iae;
 667         } catch (Exception e) {
 668             if (logger.isDebugEnabled()) {
 669                 logger.debug("Caught exception ", e);
 670             }
 671             throw new NuxeoDocumentException(e);
 672         }
 673
 674         return wrapDoc;
 675     }
 676
 677     protected static String buildInListForDocTypes(List<String> docTypes) {
 678         StringBuilder sb = new StringBuilder();
 679         sb.append("(");
 680         boolean first = true;
 681         for (String docType : docTypes) {
 682             if (first) {
 683                 first = false;
 684             } else {
 685                 sb.append(",");
 686             }
 687             sb.append("'");
 688             sb.append(docType);
 689             sb.append("'");
 690         }
 691         sb.append(")");
 692         return sb.toString();
 693     }
 694
 695     public DocumentWrapper<DocumentModelList> findDocs(
 696             ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx,
 697             DocumentHandler handler,
 698             CoreSessionInterface repoSession,
 699             List<String> docTypes)
 700             throws DocumentNotFoundException, DocumentException {
 701         DocumentWrapper<DocumentModelList> wrapDoc = null;
 702
 703         DocumentFilter filter = handler.getDocumentFilter();
 704         String oldOrderBy = filter.getOrderByClause();
 705         if (isClauseEmpty(oldOrderBy) == true) {
 706             filter.setOrderByClause(DocumentFilter.ORDER_BY_LAST_UPDATED);
 707         }
 708         QueryContext queryContext = new QueryContext(ctx, handler);
 709
 710         try {
 711             if (docTypes == null || docTypes.size() < 1) {
 712                 throw new DocumentNotFoundException(
 713                         "The findDocs() method must specify at least one DocumentType.");
 714             }
 715             DocumentModelList docList = null;
 716             if (handler.isCMISQuery() == true) {
 717                 String inList = buildInListForDocTypes(docTypes);
 718                 ctx.getQueryParams().add(IQueryManager.SEARCH_RELATED_MATCH_OBJ_DOCTYPES, inList);
 719                 docList = getFilteredCMIS(repoSession, ctx, handler, queryContext);
 720             } else {
 721                 String query = NuxeoUtils.buildNXQLQuery(docTypes, queryContext);
 722                 if (logger.isDebugEnabled()) {
 723                     logger.debug("findDocs() NXQL: " + query);
 724                 }
 725                 docList = repoSession.query(query, null, filter.getPageSize(), filter.getOffset(), true);
 726             }
 727             wrapDoc = new DocumentWrapperImpl<DocumentModelList>(docList);
 728         } catch (IllegalArgumentException iae) {
 729             throw iae;
 730         } catch (Exception e) {
 731             if (logger.isDebugEnabled()) {
 732                 logger.debug("Caught exception ", e);
 733             }
 734             throw new NuxeoDocumentException(e);
 735         }
 736
 737         return wrapDoc;
 738     }
 739
 740     /**
 741      * Find a list of documentModels from the Nuxeo repository
 742      *
 743      * @param docTypes a list of DocType names to match
 744      * @param whereClause where the clause to qualify on
 745      * @throws DocumentNotFoundException
 746      * @throws TransactionException
 747      * @throws DocumentException
 748      * @return a list of documentModels
 749      */
 750     @Override
 751     public DocumentWrapper<DocumentModelList> findDocs(
 752             ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx,
 753             List<String> docTypes,
 754             String whereClause,
 755             int pageSize, int pageNum, boolean computeTotal)
 756             throws DocumentNotFoundException, TransactionException, DocumentException {
 757         CoreSessionInterface repoSession = null;
 758         DocumentWrapper<DocumentModelList> wrapDoc = null;
 759
 760         try {
 761             repoSession = getRepositorySession(ctx);
 762             wrapDoc = findDocs(ctx, repoSession, docTypes, whereClause, null,
 763                     pageSize, pageNum, computeTotal);
 764         } catch (IllegalArgumentException iae) {
 765             throw iae;
 766         } catch (Exception e) {
 767             if (logger.isDebugEnabled()) {
 768                 logger.debug("Caught exception ", e);
 769             }
 770             throw new NuxeoDocumentException(e);
 771         } finally {
 772             if (repoSession != null) {
 773                 releaseRepositorySession(ctx, repoSession);
 774             }
 775         }
 776
 777         if (logger.isWarnEnabled() == true) {
 778             logger.warn("Returned DocumentModelList instance was created with a repository session that is now closed.");
 779         }
 780
 781         return wrapDoc;
 782     }
 783
 784     /* (non-Javadoc)
 785      * @see org.collectionspace.services.common.storage.StorageClient#get(org.collectionspace.services.common.context.ServiceContext, java.util.List, org.collectionspace.services.common.document.DocumentHandler)
 786      */
 787     @Override
 788     public void get(ServiceContext ctx, List<String> csidList, DocumentHandler handler)
 789             throws DocumentNotFoundException, TransactionException, DocumentException {
 790         if (handler == null) {
 791             throw new IllegalArgumentException(
 792                     "RepositoryJavaClient.getAll: handler is missing");
 793         }
 794
 795         CoreSessionInterface repoSession = null;
 796         try {
 797             handler.prepare(Action.GET_ALL);
 798             repoSession = getRepositorySession(ctx);
 799             DocumentModelList docModelList = new DocumentModelListImpl();
 800             //FIXME: Should be using NuxeoUtils.createPathRef for security reasons
 801             for (String csid : csidList) {
 802                 DocumentRef docRef = NuxeoUtils.createPathRef(ctx, csid);
 803                 DocumentModel docModel = repoSession.getDocument(docRef);
 804                 docModelList.add(docModel);
 805             }
 806
 807             //set reposession to handle the document
 808             ((DocumentModelHandler) handler).setRepositorySession(repoSession);
 809             DocumentWrapper<DocumentModelList> wrapDoc = new DocumentWrapperImpl<DocumentModelList>(docModelList);
 810             handler.handle(Action.GET_ALL, wrapDoc);
 811             handler.complete(Action.GET_ALL, wrapDoc);
 812         } catch (DocumentException de) {
 813             throw de;
 814         } catch (Exception e) {
 815             if (logger.isDebugEnabled()) {
 816                 logger.debug("Caught exception ", e);
 817             }
 818             throw new NuxeoDocumentException(e);
 819         } finally {
 820             if (repoSession != null) {
 821                 releaseRepositorySession(ctx, repoSession);
 822             }
 823         }
 824     }
 825
 826     /**
 827      * getAll get all documents for an entity entity service from the Nuxeo
 828      * repository
 829      *
 830      * @param ctx service context under which this method is invoked
 831      * @param handler should be used by the caller to provide and transform the
 832      * document
 833      * @throws DocumentNotFoundException
 834      * @throws TransactionException
 835      * @throws DocumentException
 836      */
 837     @Override
 838     public void getAll(ServiceContext ctx, DocumentHandler handler)
 839             throws DocumentNotFoundException, TransactionException, DocumentException {
 840         if (handler == null) {
 841             throw new IllegalArgumentException(
 842                     "RepositoryJavaClient.getAll: handler is missing");
 843         }
 844         String nuxeoWspaceId = ctx.getRepositoryWorkspaceId();
 845         if (nuxeoWspaceId == null) {
 846             throw new DocumentNotFoundException(
 847                     "Unable to find workspace for service "
 848                     + ctx.getServiceName()
 849                     + " check if the workspace exists in the Nuxeo repository.");
 850         }
 851
 852         CoreSessionInterface repoSession = null;
 853         try {
 854             handler.prepare(Action.GET_ALL);
 855             repoSession = getRepositorySession(ctx);
 856             DocumentRef wsDocRef = new IdRef(nuxeoWspaceId);
 857             DocumentModelList docList = repoSession.getChildren(wsDocRef);
 858             //set reposession to handle the document
 859             ((DocumentModelHandler) handler).setRepositorySession(repoSession);
 860             DocumentWrapper<DocumentModelList> wrapDoc = new DocumentWrapperImpl<DocumentModelList>(docList);
 861             handler.handle(Action.GET_ALL, wrapDoc);
 862             handler.complete(Action.GET_ALL, wrapDoc);
 863         } catch (DocumentException de) {
 864             throw de;
 865         } catch (Exception e) {
 866             if (logger.isDebugEnabled()) {
 867                 logger.debug("Caught exception ", e);
 868             }
 869             throw new NuxeoDocumentException(e);
 870         } finally {
 871             if (repoSession != null) {
 872                 releaseRepositorySession(ctx, repoSession);
 873             }
 874         }
 875     }
 876
 877     private boolean isClauseEmpty(String theString) {
 878         boolean result = true;
 879         if (theString != null && !theString.isEmpty()) {
 880             result = false;
 881         }
 882         return result;
 883     }
 884
 885     public DocumentWrapper<DocumentModel> getDocFromCsid(
 886             ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx,
 887             CoreSessionInterface repoSession,
 888             String csid)
 889             throws Exception {
 890         DocumentWrapper<DocumentModel> result = null;
 891
 892         result = new DocumentWrapperImpl<DocumentModel>(NuxeoUtils.getDocFromCsid(ctx, repoSession, csid));
 893
 894         return result;
 895     }
 896
 897     /*
 898      * A method to find a CollectionSpace document (of any type) given just a service context and
 899      * its CSID.  A search across *all* service workspaces (within a given tenant context) is performed to find
 900      * the document
 901      *
 902      * This query searches Nuxeo's Hierarchy table where our CSIDs are stored in the "name" column.
 903      */
 904     @Override
 905     public DocumentWrapper<DocumentModel> getDocFromCsid(ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx,
 906             String csid)
 907             throws Exception {
 908         DocumentWrapper<DocumentModel> result = null;
 909         CoreSessionInterface repoSession = null;
 910         try {
 911             repoSession = getRepositorySession(ctx);
 912             result = getDocFromCsid(ctx, repoSession, csid);
 913         } finally {
 914             if (repoSession != null) {
 915                 releaseRepositorySession(ctx, repoSession);
 916             }
 917         }
 918
 919         if (logger.isWarnEnabled() == true) {
 920             logger.warn("Returned DocumentModel instance was created with a repository session that is now closed.");
 921         }
 922
 923         return result;
 924     }
 925
 926     /**
 927      * Returns a URI value for a document in the Nuxeo repository
 928      *
 929      * @param wrappedDoc a wrapped documentModel
 930      * @throws ClientException
 931      * @return a document URI
 932      */
 933     @Override
 934     public String getDocURI(DocumentWrapper<DocumentModel> wrappedDoc) throws ClientException {
 935         DocumentModel docModel = wrappedDoc.getWrappedObject();
 936         String uri = (String) docModel.getProperty(CollectionSpaceClient.COLLECTIONSPACE_CORE_SCHEMA,
 937                 CollectionSpaceClient.COLLECTIONSPACE_CORE_URI);
 938         return uri;
 939     }
 940
 941     /*
 942      * See CSPACE-5036 - How to make CMISQL queries from Nuxeo
 943      */
 944     private IterableQueryResult makeCMISQLQuery(CoreSessionInterface repoSession, String query, QueryContext queryContext) throws DocumentException {
 945         IterableQueryResult result = null;
 946         /** Threshold over which temporary files are not kept in memory. */
 947         final int THRESHOLD = 1024 * 1024;
 948
 949         try {
 950             logger.debug(String.format("Performing a CMIS query on Nuxeo repository named %s",
 951                         repoSession.getRepositoryName()));
 952
 953             ThresholdOutputStreamFactory streamFactory = ThresholdOutputStreamFactory.newInstance(
 954                     null, THRESHOLD, -1, false);
 955             CallContextImpl callContext = new CallContextImpl(
 956                     CallContext.BINDING_LOCAL,
 957                     CmisVersion.CMIS_1_1,
 958                     repoSession.getRepositoryName(),
 959                     null, // ServletContext
 960                     null, // HttpServletRequest
 961                     null, // HttpServletResponse
 962                     new NuxeoCmisServiceFactory(),
 963                     streamFactory);
 964             callContext.put(CallContext.USERNAME, repoSession.getPrincipal().getName());
 965
 966             NuxeoCmisService cmisService = new NuxeoCmisService(repoSession.getCoreSession());
 967             result = repoSession.queryAndFetch(query, "CMISQL", cmisService);
 968         } catch (ClientException e) {
 969             // TODO Auto-generated catch block
 970             logger.error("Encounter trouble making the following CMIS query: " + query, e);
 971             throw new NuxeoDocumentException(e);
 972         }
 973
 974         return result;
 975     }
 976
 977     /**
 978      * getFiltered get all documents for an entity service from the Document
 979      * repository, given filter parameters specified by the handler.
 980      *
 981      * @param ctx service context under which this method is invoked
 982      * @param handler should be used by the caller to provide and transform the
 983      * document
 984      * @throws DocumentNotFoundException if workspace not found
 985      * @throws TransactionException
 986      * @throws DocumentException
 987      */
 988     @Override
 989     public void getFiltered(ServiceContext ctx, DocumentHandler handler)
 990             throws DocumentNotFoundException, TransactionException, DocumentException {
 991
 992         DocumentFilter filter = handler.getDocumentFilter();
 993         String oldOrderBy = filter.getOrderByClause();
 994         if (isClauseEmpty(oldOrderBy) == true) {
 995             filter.setOrderByClause(DocumentFilter.ORDER_BY_LAST_UPDATED);
 996         }
 997         QueryContext queryContext = new QueryContext(ctx, handler);
 998
 999         CoreSessionInterface repoSession = null;
1000         try {
1001             handler.prepare(Action.GET_ALL);
1002             repoSession = getRepositorySession(ctx); //Keeps a refcount here for the repository session so you need to release this when finished
1003
1004             DocumentModelList docList = null;
1005             // JDBC query
1006             if (handler.isJDBCQuery() == true) {
1007                 docList = getFilteredJDBC(repoSession, ctx, handler);
1008             // CMIS query
1009             } else if (handler.isCMISQuery() == true) {
1010                 docList = getFilteredCMIS(repoSession, ctx, handler, queryContext); //FIXME: REM - Need to deal with paging info in CMIS query
1011             // NXQL query
1012             } else {
1013                 String query = NuxeoUtils.buildNXQLQuery(ctx, queryContext);
1014                 if (logger.isDebugEnabled()) {
1015                     logger.debug("Executing NXQL query: " + query.toString());
1016                 }
1017                 Profiler profiler = new Profiler(this, 2);
1018                 profiler.log("Executing NXQL query: " + query.toString());
1019                 profiler.start();
1020                 // If we have a page size and/or offset, then reflect those values
1021                 // when constructing the query, and also pass 'true' to get totalSize
1022                 // in the returned DocumentModelList.
1023                 if ((queryContext.getDocFilter().getOffset() > 0) || (queryContext.getDocFilter().getPageSize() > 0)) {
1024                     docList = repoSession.query(query, null,
1025                             queryContext.getDocFilter().getPageSize(), queryContext.getDocFilter().getOffset(), true);
1026                 } else {
1027                     docList = repoSession.query(query);
1028                 }
1029                 profiler.stop();
1030             }
1031
1032             //set repoSession to handle the document
1033             ((DocumentModelHandler) handler).setRepositorySession(repoSession);
1034             DocumentWrapper<DocumentModelList> wrapDoc = new DocumentWrapperImpl<DocumentModelList>(docList);
1035             handler.handle(Action.GET_ALL, wrapDoc);
1036             handler.complete(Action.GET_ALL, wrapDoc);
1037         } catch (DocumentException de) {
1038             throw de;
1039         } catch (Exception e) {
1040             if (logger.isDebugEnabled()) {
1041                 logger.debug("Caught exception ", e); // REM - 1/17/2014: Check for org.nuxeo.ecm.core.api.ClientException and re-attempt
1042             }
1043             throw new NuxeoDocumentException(e);
1044         } finally {
1045             if (repoSession != null) {
1046                 releaseRepositorySession(ctx, repoSession);
1047             }
1048         }
1049     }
1050
1051     /**
1052      * Perform a database query, via JDBC and SQL, to retrieve matching records
1053      * based on filter criteria.
1054      *
1055      * Although this method currently has a general-purpose name, it is
1056      * currently dedicated to a specific task: that of improving performance
1057      * for partial term matching queries on authority items / terms, via
1058      * the use of a hand-tuned SQL query, rather than via the generated SQL
1059      * produced by Nuxeo from an NXQL query.  (See CSPACE-6361 for a task
1060      * to generalize this method.)
1061      *
1062      * @param repoSession a repository session.
1063      * @param ctx the service context.
1064      * @param handler a relevant document handler.
1065      * @return a list of document models matching the search criteria.
1066      * @throws Exception
1067      */
1068     private DocumentModelList getFilteredJDBC(CoreSessionInterface repoSession, ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx,
1069             DocumentHandler handler) throws Exception {
1070         DocumentModelList result = new DocumentModelListImpl();
1071
1072         // FIXME: Get all of the following values from appropriate external constants.
1073         //
1074         // At present, the two constants below are duplicated in both RepositoryClientImpl
1075         // and in AuthorityItemDocumentModelHandler.
1076         final String TERM_GROUP_LIST_NAME = "TERM_GROUP_LIST_NAME";
1077         final String TERM_GROUP_TABLE_NAME_PARAM = "TERM_GROUP_TABLE_NAME";
1078         final String IN_AUTHORITY_PARAM = "IN_AUTHORITY";
1079         // Get this from a constant in AuthorityResource or equivalent
1080         final String PARENT_WILDCARD = "_ALL_";
1081
1082         // Build two SQL statements, to be executed within a single transaction:
1083         // the first statement to control join order, and the second statement
1084         // representing the actual 'get filtered' query
1085
1086         // Build the join control statement
1087         //
1088         // Per http://www.postgresql.org/docs/9.2/static/runtime-config-query.html#GUC-JOIN-COLLAPSE-LIMIT
1089         // "Setting [this value] to 1 prevents any reordering of explicit JOINs.
1090         // Thus, the explicit join order specified in the query will be the
1091         // actual order in which the relations are joined."
1092         // See CSPACE-5945 for further discussion of why this setting is needed.
1093         //
1094         // Adding this statement is commented out here for now.  It significantly
1095         // improved query performance for authority item / term queries where
1096         // large numbers of rows were retrieved, but appears to have resulted
1097         // in consistently slower-than-desired query performance where zero or
1098         // very few records were retrieved. See notes on CSPACE-5945. - ADR 2013-04-09
1099         // String joinControlSql = "SET LOCAL join_collapse_limit TO 1;";
1100
1101         // Build the query statement
1102         //
1103         // Start with the default query
1104         String selectStatement =
1105                 "SELECT DISTINCT commonschema.id"
1106                 + " FROM " + handler.getServiceContext().getCommonPartLabel() + " commonschema";
1107
1108         String joinClauses =
1109                 " INNER JOIN misc"
1110                 + "  ON misc.id = commonschema.id"
1111                 + " INNER JOIN hierarchy hierarchy_termgroup"
1112                 + "  ON hierarchy_termgroup.parentid = misc.id"
1113                 + " INNER JOIN "  + handler.getJDBCQueryParams().get(TERM_GROUP_TABLE_NAME_PARAM) + " termgroup"
1114                 + "  ON termgroup.id = hierarchy_termgroup.id ";
1115
1116         String whereClause;
1117         MultivaluedMap<String, String> queryParams = ctx.getQueryParams();
1118         // Value for replaceable parameter 1 in the query
1119         String partialTerm = queryParams.getFirst(IQueryManager.SEARCH_TYPE_PARTIALTERM);
1120         // If the value of the partial term query parameter is blank ('pt='),
1121         // return all records, subject to restriction by any limit clause
1122         if (Tools.isBlank(partialTerm)) {
1123            whereClause = "";
1124         } else {
1125            // Otherwise, return records that match the supplied partial term
1126            whereClause =
1127                 " WHERE (termgroup.termdisplayname ILIKE ?)";
1128         }
1129
1130         // At present, results are ordered in code, below, rather than in SQL,
1131         // and the orderByClause below is thus intentionally blank.
1132         //
1133         // To implement the orderByClause below in SQL; e.g. via
1134         // 'ORDER BY termgroup.termdisplayname', the relevant column
1135         // must be returned by the SELECT statement.
1136         String orderByClause = "";
1137
1138         String limitClause;
1139         TenantBindingConfigReaderImpl tReader =
1140                 ServiceMain.getInstance().getTenantBindingConfigReader();
1141         TenantBindingType tenantBinding = tReader.getTenantBinding(ctx.getTenantId());
1142         String maxListItemsLimit = TenantBindingUtils.getPropertyValue(tenantBinding,
1143                 IQueryManager.MAX_LIST_ITEMS_RETURNED_LIMIT_ON_JDBC_QUERIES);
1144         limitClause =
1145                 " LIMIT " + getMaxItemsLimitOnJdbcQueries(maxListItemsLimit); // implicit int-to-String conversion
1146
1147         // After building the individual parts of the query, set the values
1148         // of replaceable parameters that will be inserted into that query
1149         // and optionally add restrictions
1150
1151         List<String> params = new ArrayList<>();
1152
1153         if (Tools.notBlank(whereClause)) {
1154
1155             // Read tenant bindings configuration to determine whether
1156             // to automatically insert leading, as well as trailing, wildcards
1157             // into the term matching string.
1158             String usesStartingWildcard = TenantBindingUtils.getPropertyValue(tenantBinding,
1159                     IQueryManager.TENANT_USES_STARTING_WILDCARD_FOR_PARTIAL_TERM);
1160             // Handle user-provided leading wildcard characters, in the
1161             // configuration where a leading wildcard is not automatically inserted.
1162             // (The user-provided wildcard must be in the first, or "starting"
1163             // character position in the partial term value.)
1164             if (Tools.notBlank(usesStartingWildcard)) {
1165                 if (usesStartingWildcard.equalsIgnoreCase(Boolean.FALSE.toString())) {
1166                     partialTerm = handleProvidedStartingWildcard(partialTerm);
1167                     // Otherwise, in the configuration where a leading wildcard
1168                     // is usually automatically inserted, handle the cases where
1169                     // a user has entered an anchor character in the first position
1170                     // in the starting term value. In those cases, strip that
1171                     // anchor character and don't add a leading wildcard
1172                 } else {
1173                     if (partialTerm.startsWith(USER_SUPPLIED_ANCHOR_CHAR)) {
1174                         partialTerm = partialTerm.substring(1, partialTerm.length());
1175                         // Otherwise, automatically add a leading wildcard
1176                     } else {
1177                         partialTerm = JDBCTools.SQL_WILDCARD + partialTerm;
1178                     }
1179                 }
1180             }
1181             // Add SQL wildcards in the midst of the partial term match search
1182             // expression, whever user-supplied wildcards appear, except in the
1183             // first or last character positions of the search expression.
1184             partialTerm = subtituteWildcardsInPartialTerm(partialTerm);
1185
1186             // If a designated 'anchor character' is present as the last character
1187             // in the search expression, strip that character and don't add
1188             // a trailing wildcard
1189             int lastCharPos = partialTerm.length() - 1;
1190             if (partialTerm.endsWith(USER_SUPPLIED_ANCHOR_CHAR) && lastCharPos > 0) {
1191                     partialTerm = partialTerm.substring(0, lastCharPos);
1192             } else {
1193                 // Otherwise, automatically add a trailing wildcard
1194                 partialTerm = partialTerm + JDBCTools.SQL_WILDCARD;
1195             }
1196             params.add(partialTerm);
1197         }
1198
1199         // Optionally add restrictions to the default query, based on variables
1200         // in the current request
1201
1202         // Restrict the query to filter out deleted records, if requested
1203         String includeDeleted = queryParams.getFirst(WorkflowClient.WORKFLOW_QUERY_NONDELETED);
1204         if (includeDeleted != null && includeDeleted.equalsIgnoreCase(Boolean.FALSE.toString())) {
1205             whereClause = whereClause
1206                     + "  AND (misc.lifecyclestate <> '" + WorkflowClient.WORKFLOWSTATE_DELETED + "')"
1207                         + "  AND (misc.lifecyclestate <> '" + WorkflowClient.WORKFLOWSTATE_LOCKED_DELETED + "')";
1208         }
1209
1210         // If a particular authority is specified, restrict the query further
1211         // to return only records within that authority
1212         String inAuthorityValue = (String) handler.getJDBCQueryParams().get(IN_AUTHORITY_PARAM);
1213         if (Tools.notBlank(inAuthorityValue)) {
1214             // Handle the '_ALL_' case for inAuthority
1215             if (inAuthorityValue.equals(PARENT_WILDCARD)) {
1216                 // Add nothing to the query here if it should match within all authorities
1217             } else {
1218                 whereClause = whereClause
1219                     + "  AND (commonschema.inauthority = ?)";
1220                 params.add(inAuthorityValue); // Value for replaceable parameter 2 in the query
1221             }
1222         }
1223
1224         // Restrict the query further to return only records pertaining to
1225         // the current tenant, unless:
1226         // * Data for this service, in this tenant, is stored in its own,
1227         //   separate repository, rather than being intermingled with other
1228         //   tenants' data in the default repository; or
1229         // * Restriction by tenant ID in JDBC queries has been disabled,
1230         //   via configuration for this tenant,
1231         if (restrictJDBCQueryByTenantID(tenantBinding, ctx)) {
1232                 joinClauses = joinClauses
1233                     + " INNER JOIN collectionspace_core core"
1234                     + "  ON core.id = hierarchy_termgroup.parentid";
1235                 whereClause = whereClause
1236                     + "  AND (core.tenantid = ?)";
1237                 params.add(ctx.getTenantId()); // Value for replaceable parameter 3 in the query
1238         }
1239
1240         // Piece together the SQL query from its parts
1241         String querySql = selectStatement + joinClauses + whereClause + orderByClause + limitClause;
1242
1243         // Note: PostgreSQL 9.2 introduced a change that may improve performance
1244         // of certain queries using JDBC PreparedStatements.  See comments on
1245         // CSPACE-5943 for details.
1246         //
1247         // See a comment above for the reason that the joinControl SQL statement,
1248         // along with its corresponding prepared statement builder, is commented out for now.
1249         // PreparedStatementBuilder joinControlBuilder = new PreparedStatementBuilder(joinControlSql);
1250         PreparedStatementSimpleBuilder queryBuilder = new PreparedStatementSimpleBuilder(querySql, params);
1251         List<PreparedStatementBuilder> builders = new ArrayList<>();
1252         // builders.add(joinControlBuilder);
1253         builders.add(queryBuilder);
1254         String dataSourceName = JDBCTools.NUXEO_DATASOURCE_NAME;
1255         String repositoryName = ctx.getRepositoryName();
1256         final Boolean EXECUTE_WITHIN_TRANSACTION = true;
1257         Set<String> docIds = new HashSet<>();
1258         try {
1259                 String cspaceInstanceId = ServiceMain.getInstance().getCspaceInstanceId();
1260             List<CachedRowSet> resultsList = JDBCTools.executePreparedQueries(builders,
1261                 dataSourceName, repositoryName, cspaceInstanceId, EXECUTE_WITHIN_TRANSACTION);
1262
1263             // At least one set of results is expected, from the second prepared
1264             // statement to be executed.
1265             // If fewer results are returned, return an empty list of document models
1266             if (resultsList == null || resultsList.size() < 1) {
1267                 return result; // return an empty list of document models
1268             }
1269             // The join control query (if enabled - it is currently commented
1270             // out as per comments above) will not return results, so query results
1271             // will be the first set of results (rowSet) returned in the list
1272             CachedRowSet queryResults = resultsList.get(0);
1273
1274             // If the result from executing the query is null or contains zero rows,
1275             // return an empty list of document models
1276             if (queryResults == null) {
1277                 return result; // return an empty list of document models
1278             }
1279             queryResults.last();
1280             if (queryResults.getRow() == 0) {
1281                 return result; // return an empty list of document models
1282             }
1283
1284             // Otherwise, get the document IDs from the results of the query
1285             String id;
1286             queryResults.beforeFirst();
1287             while (queryResults.next()) {
1288                 id = queryResults.getString(1);
1289                 if (Tools.notBlank(id)) {
1290                     docIds.add(id);
1291                 }
1292             }
1293         } catch (SQLException sqle) {
1294             logger.warn("Could not obtain document IDs via SQL query '" + querySql + "': " + sqle.getMessage());
1295             return result; // return an empty list of document models
1296         }
1297
1298         // Get a list of document models, using the list of IDs obtained from the query
1299         //
1300         // FIXME: Check whether we have a 'get document models from list of CSIDs'
1301         // utility method like this, and if not, add this to the appropriate
1302         // framework class
1303         DocumentModel docModel;
1304         for (String docId : docIds) {
1305             docModel = NuxeoUtils.getDocumentModel(repoSession, docId);
1306             if (docModel == null) {
1307                 logger.warn("Could not obtain document model for document with ID " + docId);
1308             } else {
1309                 result.add(docModel);
1310             }
1311         }
1312
1313         // Order the results
1314         final String COMMON_PART_SCHEMA = handler.getServiceContext().getCommonPartLabel();
1315         final String DISPLAY_NAME_XPATH =
1316                 "//" + handler.getJDBCQueryParams().get(TERM_GROUP_LIST_NAME) + "/[0]/termDisplayName";
1317         Collections.sort(result, new Comparator<DocumentModel>() {
1318             @Override
1319             public int compare(DocumentModel doc1, DocumentModel doc2) {
1320                 String termDisplayName1 = null;
1321                 String termDisplayName2 = null;
1322                 try {
1323                         termDisplayName1 = (String) NuxeoUtils.getXPathValue(doc1, COMMON_PART_SCHEMA, DISPLAY_NAME_XPATH);
1324                         termDisplayName2 = (String) NuxeoUtils.getXPathValue(doc2, COMMON_PART_SCHEMA, DISPLAY_NAME_XPATH);
1325                 } catch (NuxeoDocumentException e) {
1326                         throw new RuntimeException(e);  // We need to throw a RuntimeException because the compare() method of the Comparator interface does not support throwing an Exception
1327                 }
1328                 return termDisplayName1.compareToIgnoreCase(termDisplayName2);
1329             }
1330         });
1331
1332         return result;
1333     }
1334
1335
1336     private DocumentModelList getFilteredCMIS(CoreSessionInterface repoSession,
1337                 ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx, DocumentHandler handler, QueryContext queryContext)
1338             throws DocumentNotFoundException, DocumentException {
1339
1340         DocumentModelList result = new DocumentModelListImpl();
1341         try {
1342             String query = handler.getCMISQuery(queryContext);
1343
1344             DocumentFilter docFilter = handler.getDocumentFilter();
1345             int pageSize = docFilter.getPageSize();
1346             int offset = docFilter.getOffset();
1347             if (logger.isDebugEnabled()) {
1348                 logger.debug("Executing CMIS query: " + query.toString()
1349                         + "with pageSize: " + pageSize + " at offset: " + offset);
1350             }
1351
1352             // If we have limit and/or offset, then pass true to get totalSize
1353             // in returned DocumentModelList.
1354             Profiler profiler = new Profiler(this, 2);
1355             profiler.log("Executing CMIS query: " + query.toString());
1356             profiler.start();
1357             //
1358             IterableQueryResult queryResult = makeCMISQLQuery(repoSession, query, queryContext);
1359             try {
1360                 int totalSize = (int) queryResult.size();
1361                 ((DocumentModelListImpl) result).setTotalSize(totalSize);
1362                 // Skip the rows before our offset
1363                 if (offset > 0) {
1364                     queryResult.skipTo(offset);
1365                 }
1366                 int nRows = 0;
1367                 for (Map<String, Serializable> row : queryResult) {
1368                     if (logger.isTraceEnabled()) {
1369                         logger.trace(" Hierarchy Table ID is:" + row.get(IQueryManager.CMIS_TARGET_NUXEO_ID)
1370                                 + " nuxeo:pathSegment is: " + row.get(IQueryManager.CMIS_TARGET_NAME));
1371                     }
1372                     String nuxeoId = (String) row.get(IQueryManager.CMIS_TARGET_NUXEO_ID);
1373                     DocumentModel docModel = NuxeoUtils.getDocumentModel(repoSession, nuxeoId);
1374                     result.add(docModel);
1375                     nRows++;
1376                     if (nRows >= pageSize && pageSize != 0) { // A page size of zero means that they want all of them
1377                         logger.debug("Got page full of items - quitting");
1378                         break;
1379                     }
1380                 }
1381             } finally {
1382                 queryResult.close();
1383             }
1384             //
1385             profiler.stop();
1386
1387         } catch (Exception e) {
1388             if (logger.isDebugEnabled()) {
1389                 logger.debug("Caught exception ", e);
1390             }
1391             throw new NuxeoDocumentException(e);
1392         }
1393
1394         //
1395         // Since we're not supporting paging yet for CMIS queries, we need to perform
1396         // a workaround for the paging information we return in our list of results
1397         //
1398         /*
1399          if (result != null) {
1400          docFilter.setStartPage(0);
1401          if (totalSize > docFilter.getPageSize()) {
1402          docFilter.setPageSize(totalSize);
1403          ((DocumentModelListImpl)result).setTotalSize(totalSize);
1404          }
1405          }
1406          */
1407
1408         return result;
1409     }
1410
1411     private String logException(Exception e, String msg) {
1412         String result = null;
1413
1414         String exceptionMessage = e.getMessage();
1415         exceptionMessage = exceptionMessage != null ? exceptionMessage : "<No details provided>";
1416         result = msg = msg + ". Caught exception:" + exceptionMessage;
1417
1418         if (logger.isTraceEnabled() == true) {
1419             logger.error(msg, e);
1420         } else {
1421             logger.error(msg);
1422         }
1423
1424         return result;
1425     }
1426
1427     /**
1428      * update given document in the Nuxeo repository
1429      *
1430      * @param ctx service context under which this method is invoked
1431      * @param csid of the document
1432      * @param handler should be used by the caller to provide and transform the
1433      * document
1434      * @throws BadRequestException
1435      * @throws DocumentNotFoundException
1436      * @throws TransactionException if the transaction times out or otherwise
1437      * cannot be successfully completed
1438      * @throws DocumentException
1439      */
1440     @Override
1441     public void update(ServiceContext ctx, String csid, DocumentHandler handler)
1442             throws BadRequestException, DocumentNotFoundException, TransactionException,
1443             DocumentException {
1444         if (handler == null) {
1445             throw new IllegalArgumentException(
1446                     "RepositoryJavaClient.update: document handler is missing.");
1447         }
1448
1449         CoreSessionInterface repoSession = null;
1450         try {
1451             handler.prepare(Action.UPDATE);
1452             repoSession = getRepositorySession(ctx);
1453             DocumentRef docRef = NuxeoUtils.createPathRef(ctx, csid);
1454             DocumentModel doc = null;
1455             try {
1456                 doc = repoSession.getDocument(docRef);
1457             } catch (ClientException ce) {
1458                 String msg = logException(ce, "Could not find document to update with CSID=" + csid);
1459                 throw new DocumentNotFoundException(msg, ce);
1460             }
1461             // Check for a versioned document, and check In and Out before we proceed.
1462             if (((DocumentModelHandler) handler).supportsVersioning()) {
1463                 /* Once we advance to 5.5 or later, we can add this.
1464                  * See also https://jira.nuxeo.com/browse/NXP-8506
1465                  if(!doc.isVersionable()) {
1466                  throw new NuxeoDocumentException("Configuration for: "
1467                  +handler.getServiceContextPath()+" supports versioning, but Nuxeo config does not!");
1468                  }
1469                  */
1470                 /* Force a version number - Not working. Apparently we need to configure the uid schema??
1471                  if(doc.getProperty("uid","major_version") == null) {
1472                  doc.setProperty("uid","major_version",1);
1473                  }
1474                  if(doc.getProperty("uid","minor_version") == null) {
1475                  doc.setProperty("uid","minor_version",0);
1476                  }
1477                  */
1478                 doc.checkIn(VersioningOption.MINOR, null);
1479                 doc.checkOut();
1480             }
1481
1482             //
1483             // Set reposession to handle the document
1484             //
1485             ((DocumentModelHandler) handler).setRepositorySession(repoSession);
1486             DocumentWrapper<DocumentModel> wrapDoc = new DocumentWrapperImpl<DocumentModel>(doc);
1487             handler.handle(Action.UPDATE, wrapDoc);
1488             repoSession.saveDocument(doc);
1489             repoSession.save();
1490             handler.complete(Action.UPDATE, wrapDoc);
1491         } catch (BadRequestException bre) {
1492             throw bre;
1493         } catch (DocumentException de) {
1494             throw de;
1495         } catch (CSWebApplicationException wae) {
1496             throw wae;
1497         } catch (Exception e) {
1498             throw new NuxeoDocumentException(e);
1499         } finally {
1500             if (repoSession != null) {
1501                 releaseRepositorySession(ctx, repoSession);
1502             }
1503         }
1504     }
1505
1506     /**
1507      * Save a documentModel to the Nuxeo repository.
1508      *
1509      * @param ctx service context under which this method is invoked
1510      * @param repoSession
1511      * @param docModel the document to save
1512      * @param fSaveSession if TRUE, will call CoreSessionInterface.save() to save
1513      * accumulated changes.
1514      * @throws ClientException
1515      * @throws DocumentException
1516      */
1517     public void saveDocWithoutHandlerProcessing(
1518             ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx,
1519             CoreSessionInterface repoSession,
1520             DocumentModel docModel,
1521             boolean fSaveSession)
1522             throws ClientException, DocumentException {
1523
1524         try {
1525             repoSession.saveDocument(docModel);
1526             if (fSaveSession) {
1527                 repoSession.save();
1528             }
1529         } catch (ClientException ce) {
1530             throw ce;
1531         } catch (Exception e) {
1532             if (logger.isDebugEnabled()) {
1533                 logger.debug("Caught exception ", e);
1534             }
1535             throw new NuxeoDocumentException(e);
1536         }
1537     }
1538
1539     /**
1540      * Save a list of documentModels to the Nuxeo repository.
1541      *
1542      * @param ctx service context under which this method is invoked
1543      * @param repoSession a repository session
1544      * @param docModelList a list of document models
1545      * @param fSaveSession if TRUE, will call CoreSessionInterface.save() to save
1546      * accumulated changes.
1547      * @throws ClientException
1548      * @throws DocumentException
1549      */
1550     public void saveDocListWithoutHandlerProcessing(
1551             ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx,
1552             CoreSessionInterface repoSession,
1553             DocumentModelList docList,
1554             boolean fSaveSession)
1555             throws ClientException, DocumentException {
1556         try {
1557             DocumentModel[] docModelArray = new DocumentModel[docList.size()];
1558             repoSession.saveDocuments(docList.toArray(docModelArray));
1559             if (fSaveSession) {
1560                 repoSession.save();
1561             }
1562         } catch (ClientException ce) {
1563             throw ce;
1564         } catch (Exception e) {
1565             logger.error("Caught exception ", e);
1566             throw new NuxeoDocumentException(e);
1567         }
1568     }
1569
1570     @Override
1571         public void deleteWithWhereClause(@SuppressWarnings("rawtypes") ServiceContext ctx, String whereClause,
1572                         @SuppressWarnings("rawtypes") DocumentHandler handler) throws
1573                         DocumentNotFoundException, DocumentException {
1574         if (ctx == null) {
1575             throw new IllegalArgumentException(
1576                     "delete(ctx, specifier): ctx is missing");
1577         }
1578         if (logger.isDebugEnabled()) {
1579             logger.debug("Deleting document with whereClause=" + whereClause);
1580         }
1581
1582         DocumentWrapper<DocumentModel> foundDocWrapper = this.findDoc(ctx, whereClause);
1583         if (foundDocWrapper != null) {
1584                 DocumentModel docModel = foundDocWrapper.getWrappedObject();
1585                 String csid = docModel.getName();
1586                 this.delete(ctx, csid, handler);
1587         }
1588     }
1589
1590     /**
1591      * delete a document from the Nuxeo repository
1592      *
1593      * @param ctx service context under which this method is invoked
1594      * @param id of the document
1595      * @throws DocumentException
1596      */
1597     @Override
1598     public boolean delete(ServiceContext ctx, String id, DocumentHandler handler) throws DocumentNotFoundException,
1599             DocumentException, TransactionException {
1600         boolean result = true;
1601
1602         if (ctx == null) {
1603             throw new IllegalArgumentException(
1604                     "delete(ctx, ix, handler): ctx is missing");
1605         }
1606         if (handler == null) {
1607             throw new IllegalArgumentException(
1608                     "delete(ctx, ix, handler): handler is missing");
1609         }
1610         if (logger.isDebugEnabled()) {
1611             logger.debug("Deleting document with CSID=" + id);
1612         }
1613         CoreSessionInterface repoSession = null;
1614         try {
1615             handler.prepare(Action.DELETE);
1616             repoSession = getRepositorySession(ctx);
1617             DocumentWrapper<DocumentModel> wrapDoc = null;
1618             try {
1619                 DocumentRef docRef = NuxeoUtils.createPathRef(ctx, id);
1620                 wrapDoc = new DocumentWrapperImpl<DocumentModel>(repoSession.getDocument(docRef));
1621                 ((DocumentModelHandler) handler).setRepositorySession(repoSession);
1622                 if (handler.handle(Action.DELETE, wrapDoc)) {
1623                         repoSession.removeDocument(docRef);
1624                 } else {
1625                         result = false; // delete failed for some reason
1626                 }
1627             } catch (ClientException ce) {
1628                 String msg = logException(ce, "Could not find document to delete with CSID=" + id);
1629                 throw new DocumentNotFoundException(msg, ce);
1630             }
1631             repoSession.save();
1632             handler.complete(Action.DELETE, wrapDoc);
1633         } catch (DocumentException de) {
1634             throw de;
1635         } catch (Exception e) {
1636             if (logger.isDebugEnabled()) {
1637                 logger.debug("Caught exception ", e);
1638             }
1639             throw new NuxeoDocumentException(e);
1640         } finally {
1641             if (repoSession != null) {
1642                 releaseRepositorySession(ctx, repoSession);
1643             }
1644         }
1645
1646         return result;
1647     }
1648
1649     /* (non-Javadoc)
1650      * @see org.collectionspace.services.common.storage.StorageClient#delete(org.collectionspace.services.common.context.ServiceContext, java.lang.String, org.collectionspace.services.common.document.DocumentHandler)
1651      */
1652     @Override
1653     @Deprecated
1654     public void delete(@SuppressWarnings("rawtypes") ServiceContext ctx, String id)
1655             throws DocumentNotFoundException, DocumentException {
1656         throw new UnsupportedOperationException();
1657         // Use the other delete instead
1658     }
1659
1660     @Override
1661     public Hashtable<String, String> retrieveWorkspaceIds(RepositoryDomainType repoDomain) throws Exception {
1662         return NuxeoConnectorEmbedded.getInstance().retrieveWorkspaceIds(repoDomain);
1663     }
1664
1665     @Override
1666     public String createDomain(RepositoryDomainType repositoryDomain) throws Exception {
1667         CoreSessionInterface repoSession = null;
1668         String domainId = null;
1669         try {
1670             //
1671             // Open a connection to the domain's repo/db
1672             //
1673             String repoName = repositoryDomain.getRepositoryName();
1674             repoSession = getRepositorySession(repoName); // domainName=storageName=repoName=databaseName
1675             //
1676             // First create the top-level domain directory
1677             //
1678             String domainName = repositoryDomain.getStorageName();
1679             DocumentRef parentDocRef = new PathRef("/");
1680             DocumentModel parentDoc = repoSession.getDocument(parentDocRef);
1681             DocumentModel domainDoc = repoSession.createDocumentModel(parentDoc.getPathAsString(),
1682                     domainName, NUXEO_CORE_TYPE_DOMAIN);
1683             domainDoc.setPropertyValue("dc:title", domainName);
1684             domainDoc.setPropertyValue("dc:description", "A CollectionSpace domain "
1685                     + domainName);
1686             domainDoc = repoSession.createDocument(domainDoc);
1687             domainId = domainDoc.getId();
1688             repoSession.save();
1689             //
1690             // Next, create a "Workspaces" root directory to contain the workspace folders for the individual service documents
1691             //
1692             DocumentModel workspacesRoot = repoSession.createDocumentModel(domainDoc.getPathAsString(),
1693                     NuxeoUtils.Workspaces, NUXEO_CORE_TYPE_WORKSPACEROOT);
1694             workspacesRoot.setPropertyValue("dc:title", NuxeoUtils.Workspaces);
1695             workspacesRoot.setPropertyValue("dc:description", "A CollectionSpace workspaces directory for "
1696                     + domainDoc.getPathAsString());
1697             workspacesRoot = repoSession.createDocument(workspacesRoot);
1698             String workspacesRootId = workspacesRoot.getId();
1699             repoSession.save();
1700
1701             if (logger.isDebugEnabled()) {
1702                 logger.debug("Created tenant domain name=" + domainName
1703                         + " id=" + domainId + " "
1704                         + NuxeoUtils.Workspaces + " id=" + workspacesRootId);
1705                 logger.debug("Path to Domain: " + domainDoc.getPathAsString());
1706                 logger.debug("Path to Workspaces root: " + workspacesRoot.getPathAsString());
1707             }
1708         } catch (Exception e) {
1709             if (logger.isDebugEnabled()) {
1710                 logger.debug("Could not create tenant domain name=" + repositoryDomain.getStorageName() + " caught exception ", e);
1711             }
1712             throw e;
1713         } finally {
1714             if (repoSession != null) {
1715                 releaseRepositorySession(null, repoSession);
1716             }
1717         }
1718
1719         return domainId;
1720     }
1721
1722     @Override
1723     public String getDomainId(RepositoryDomainType repositoryDomain) throws Exception {
1724         String domainId = null;
1725         CoreSessionInterface repoSession = null;
1726
1727         String repoName = repositoryDomain.getRepositoryName();
1728         String domainStorageName = repositoryDomain.getStorageName();
1729         if (domainStorageName != null && !domainStorageName.isEmpty()) {
1730             try {
1731                 repoSession = getRepositorySession(repoName);
1732                 DocumentRef docRef = new PathRef("/" + domainStorageName);
1733                 DocumentModel domain = repoSession.getDocument(docRef);
1734                 domainId = domain.getId();
1735             } catch (Exception e) {
1736                 if (logger.isTraceEnabled()) {
1737                     logger.trace("Caught exception ", e);  // The document doesn't exist, this let's us know we need to create it
1738                 }
1739                 //there is no way to identify if document does not exist due to
1740                 //lack of typed exception for getDocument method
1741                 return null;
1742             } finally {
1743                 if (repoSession != null) {
1744                     releaseRepositorySession(null, repoSession);
1745                 }
1746             }
1747         }
1748
1749         return domainId;
1750     }
1751
1752     /*
1753      * Returns the workspaces root directory for a given domain.
1754      */
1755     private DocumentModel getWorkspacesRoot(CoreSessionInterface repoSession,
1756             String domainName) throws Exception {
1757         DocumentModel result = null;
1758
1759         String domainPath = "/" + domainName;
1760         DocumentRef parentDocRef = new PathRef(domainPath);
1761         DocumentModelList domainChildrenList = repoSession.getChildren(
1762                 parentDocRef);
1763         Iterator<DocumentModel> witer = domainChildrenList.iterator();
1764         while (witer.hasNext()) {
1765             DocumentModel childNode = witer.next();
1766             if (NuxeoUtils.Workspaces.equalsIgnoreCase(childNode.getName())) {
1767                 result = childNode;
1768                 logger.trace("Found workspaces directory at: " + result.getPathAsString());
1769                 break;
1770             }
1771         }
1772
1773         if (result == null) {
1774             throw new ClientException("Could not find workspace root directory in: "
1775                     + domainPath);
1776         }
1777
1778         return result;
1779     }
1780
1781     /* (non-Javadoc)
1782      * @see org.collectionspace.services.common.repository.RepositoryClient#createWorkspace(java.lang.String, java.lang.String)
1783      */
1784     @Override
1785     public String createWorkspace(RepositoryDomainType repositoryDomain, String workspaceName) throws Exception {
1786         CoreSessionInterface repoSession = null;
1787         String workspaceId = null;
1788         try {
1789             String repoName = repositoryDomain.getRepositoryName();
1790             repoSession = getRepositorySession(repoName);
1791
1792             String domainStorageName = repositoryDomain.getStorageName();
1793             DocumentModel parentDoc = getWorkspacesRoot(repoSession, domainStorageName);
1794             if (logger.isTraceEnabled()) {
1795                 for (String facet : parentDoc.getFacets()) {
1796                     logger.trace("Facet: " + facet);
1797                 }
1798             }
1799
1800             DocumentModel doc = repoSession.createDocumentModel(parentDoc.getPathAsString(),
1801                     workspaceName, NuxeoUtils.WORKSPACE_DOCUMENT_TYPE);
1802             doc.setPropertyValue("dc:title", workspaceName);
1803             doc.setPropertyValue("dc:description", "A CollectionSpace workspace for "
1804                     + workspaceName);
1805             doc = repoSession.createDocument(doc);
1806             workspaceId = doc.getId();
1807             repoSession.save();
1808             if (logger.isDebugEnabled()) {
1809                 logger.debug("Created workspace name=" + workspaceName
1810                         + " id=" + workspaceId);
1811             }
1812         } catch (Exception e) {
1813             if (logger.isDebugEnabled()) {
1814                 logger.debug("createWorkspace caught exception ", e);
1815             }
1816             throw e;
1817         } finally {
1818             if (repoSession != null) {
1819                 releaseRepositorySession(null, repoSession);
1820             }
1821         }
1822         return workspaceId;
1823     }
1824
1825     /* (non-Javadoc)
1826      * @see org.collectionspace.services.common.repository.RepositoryClient#getWorkspaceId(java.lang.String, java.lang.String)
1827      */
1828     @Override
1829     @Deprecated
1830     public String getWorkspaceId(String tenantDomain, String workspaceName) throws Exception {
1831         String workspaceId = null;
1832
1833         CoreSessionInterface repoSession = null;
1834         try {
1835             repoSession = getRepositorySession((ServiceContext<PoxPayloadIn, PoxPayloadOut>) null);
1836             DocumentRef docRef = new PathRef(
1837                     "/" + tenantDomain
1838                     + "/" + NuxeoUtils.Workspaces
1839                     + "/" + workspaceName);
1840             DocumentModel workspace = repoSession.getDocument(docRef);
1841             workspaceId = workspace.getId();
1842         } catch (DocumentException de) {
1843             throw de;
1844         } catch (Exception e) {
1845             if (logger.isDebugEnabled()) {
1846                 logger.debug("Caught exception ", e);
1847             }
1848             throw new NuxeoDocumentException(e);
1849         } finally {
1850             if (repoSession != null) {
1851                 releaseRepositorySession(null, repoSession);
1852             }
1853         }
1854
1855         return workspaceId;
1856     }
1857
1858     public CoreSessionInterface getRepositorySession(ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx) throws Exception {
1859         return getRepositorySession(ctx, ctx.getRepositoryName(), ctx.getTimeoutSecs());
1860     }
1861
1862     public CoreSessionInterface getRepositorySession(String repoName) throws Exception {
1863         return getRepositorySession(null, repoName, ServiceContext.DEFAULT_TX_TIMEOUT);
1864     }
1865
1866     /**
1867      * Gets the repository session. - Package access only. If the 'ctx' param is
1868      * null then the repo name must be non-mull and vice-versa
1869      *
1870      * @return the repository session
1871      * @throws Exception the exception
1872      */
1873     public CoreSessionInterface getRepositorySession(ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx,
1874                 String repoName,
1875                 int timeoutSeconds) throws Exception {
1876         CoreSessionInterface repoSession = null;
1877
1878         Profiler profiler = new Profiler("getRepositorySession():", 2);
1879         profiler.start();
1880         //
1881         // To get a connection to the Nuxeo repo, we need either a valid ServiceContext instance or a repository name
1882         //
1883         if (ctx != null) {
1884                 repoSession = (CoreSessionInterface) ctx.getCurrentRepositorySession(); // First see if the context already has a repo session
1885                 if (repoSession == null) {
1886                     repoName = ctx.getRepositoryName(); // Notice we are overriding the passed in 'repoName' since we have a valid service context passed in to us
1887                 }
1888         } else if (repoName == null || repoName.trim().isEmpty()) {
1889             String errMsg = String.format("We can't get a connection to the Nuxeo repo because the service context passed in was null and no repository name was passed in either.");
1890             logger.error(errMsg);
1891             throw new Exception(errMsg);
1892         }
1893         if (repoSession == null) {
1894             //
1895             // If we couldn't find a repoSession from the service context (or the context was null) then we need to create a new one using
1896             // just the repository name.
1897             //
1898             NuxeoClientEmbedded client = NuxeoConnectorEmbedded.getInstance().getClient();
1899             repoSession = client.openRepository(repoName, timeoutSeconds);
1900         } else {
1901             if (logger.isTraceEnabled() == true) {
1902                 logger.trace("Reusing the current context's repository session.");
1903             }
1904         }
1905
1906         try {
1907                 if (logger.isTraceEnabled()) {
1908                     logger.trace("Testing call to getRepository() repository root: " + repoSession.getRootDocument());
1909                 }
1910         } catch (Throwable e) {
1911                 logger.trace("Test call to Nuxeo's getRepository() repository root failed", e);
1912         }
1913
1914         profiler.stop();
1915
1916         if (ctx != null) {
1917             ctx.setCurrentRepositorySession(repoSession); // For reusing, save the repository session in the current service context
1918         }
1919
1920         return repoSession;
1921     }
1922
1923     /**
1924      * Release repository session. - Package access only.
1925      *
1926      * @param repoSession the repo session
1927      */
1928     public void releaseRepositorySession(ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx, CoreSessionInterface repoSession) throws TransactionException {
1929         try {
1930             NuxeoClientEmbedded client = NuxeoConnectorEmbedded.getInstance().getClient();
1931             // release session
1932             if (ctx != null) {
1933                 ctx.clearCurrentRepositorySession(); //clear the current context of the now closed repo session
1934                 if (ctx.getCurrentRepositorySession() == null) {
1935                     client.releaseRepository(repoSession); //release the repo session if the service context's ref count is zeo.
1936                 }
1937             } else {
1938                 client.releaseRepository(repoSession); //repo session was acquired without a service context
1939             }
1940         } catch (TransactionRuntimeException tre) {
1941                 String causeMsg = null;
1942                 Throwable cause = tre.getCause();
1943                 if (cause != null) {
1944                         causeMsg = cause.getMessage();
1945                 }
1946
1947             TransactionException te; // a CollectionSpace specific tx exception
1948             if (causeMsg != null) {
1949                 te = new TransactionException(causeMsg, tre);
1950             } else {
1951                 te = new TransactionException(tre);
1952             }
1953
1954             logger.error(te.getMessage(), tre); // Log the standard transaction exception message, plus an exception-specific stack trace
1955             throw te;
1956         } catch (Exception e) {
1957             logger.error("Could not close the repository session.", e);
1958             // no need to throw this service specific exception
1959         }
1960     }
1961
1962     @Override
1963     public void doWorkflowTransition(ServiceContext ctx, String id,
1964             DocumentHandler handler, TransitionDef transitionDef)
1965             throws BadRequestException, DocumentNotFoundException,
1966             DocumentException {
1967         // This is a placeholder for when we change the StorageClient interface to treat workflow transitions as 1st class operations like 'get', 'create', 'update, 'delete', etc
1968     }
1969
1970     private String handleProvidedStartingWildcard(String partialTerm) {
1971         if (Tools.notBlank(partialTerm)) {
1972             if (partialTerm.substring(0, 1).equals(USER_SUPPLIED_WILDCARD)) {
1973                 StringBuffer buffer = new StringBuffer(partialTerm);
1974                 buffer.setCharAt(0, JDBCTools.SQL_WILDCARD.charAt(0));
1975                 partialTerm = buffer.toString();
1976             }
1977         }
1978         return partialTerm;
1979     }
1980
1981     /**
1982      * Replaces user-supplied wildcards with SQL wildcards, in a partial term
1983      * matching search expression.
1984      *
1985      * The scope of this replacement excludes the beginning character
1986      * in that search expression, as that character is treated specially.
1987      *
1988      * @param partialTerm
1989      * @return the partial term, with any user-supplied wildcards replaced
1990      * by SQL wildcards.
1991      */
1992     private String subtituteWildcardsInPartialTerm(String partialTerm) {
1993         if (Tools.isBlank(partialTerm)) {
1994             return partialTerm;
1995         }
1996         if (! partialTerm.contains(USER_SUPPLIED_WILDCARD)) {
1997             return partialTerm;
1998         }
1999         int len = partialTerm.length();
2000         // Partial term search expressions of 2 or fewer characters
2001         // currently aren't amenable to the use of wildcards
2002         if (len <= 2)  {
2003             logger.warn("Partial term match search expression of just 1-2 characters in length contains a user-supplied wildcard: " + partialTerm);
2004             logger.warn("Will handle that character as a literal value, rather than as a wildcard ...");
2005             return partialTerm;
2006         }
2007         return partialTerm.substring(0, 1) // first char
2008                 + partialTerm.substring(1, len).replaceAll(USER_SUPPLIED_WILDCARD_REGEX, JDBCTools.SQL_WILDCARD);
2009
2010     }
2011
2012     private int getMaxItemsLimitOnJdbcQueries(String maxListItemsLimit) {
2013         final int DEFAULT_ITEMS_LIMIT = 40;
2014         if (maxListItemsLimit == null) {
2015             return DEFAULT_ITEMS_LIMIT;
2016         }
2017         int itemsLimit;
2018         try {
2019             itemsLimit = Integer.parseInt(maxListItemsLimit);
2020             if (itemsLimit < 1) {
2021                 logger.warn("Value of configuration setting "
2022                         + IQueryManager.MAX_LIST_ITEMS_RETURNED_LIMIT_ON_JDBC_QUERIES
2023                         + " must be a positive integer; invalid current value is " + maxListItemsLimit);
2024                 logger.warn("Reverting to default value of " + DEFAULT_ITEMS_LIMIT);
2025                 itemsLimit = DEFAULT_ITEMS_LIMIT;
2026             }
2027         } catch (NumberFormatException nfe) {
2028             logger.warn("Value of configuration setting "
2029                         + IQueryManager.MAX_LIST_ITEMS_RETURNED_LIMIT_ON_JDBC_QUERIES
2030                         + " must be a positive integer; invalid current value is " + maxListItemsLimit);
2031             logger.warn("Reverting to default value of " + DEFAULT_ITEMS_LIMIT);
2032             itemsLimit = DEFAULT_ITEMS_LIMIT;
2033         }
2034         return itemsLimit;
2035     }
2036
2037     /**
2038      * Identifies whether a restriction on tenant ID - to return only records
2039      * pertaining to the current tenant - is required in a JDBC query.
2040      *
2041      * @param tenantBinding a tenant binding configuration.
2042      * @param ctx a service context.
2043      * @return true if a restriction on tenant ID is required in the query;
2044      * false if a restriction is not required.
2045      */
2046     private boolean restrictJDBCQueryByTenantID(TenantBindingType tenantBinding, ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx) {
2047         boolean restrict = true;
2048         // If data for the current service, in the current tenant, is isolated
2049         // within its own separate, per-tenant repository, as contrasted with
2050         // being intermingled with other tenants' data in the default repository,
2051         // no restriction on Tenant ID is required in the query.
2052         String repositoryDomainName = ConfigUtils.getRepositoryName(tenantBinding, ctx.getRepositoryDomainName());
2053         if (!(repositoryDomainName.equals(ConfigUtils.DEFAULT_NUXEO_REPOSITORY_NAME))) {
2054             restrict = false;
2055         }
2056         // If a configuration setting for this tenant identifies that JDBC
2057         // queries should not be restricted by tenant ID (perhaps because
2058         // there is always expected to be only one tenant's data present in
2059         // the system), no restriction on Tenant ID is required in the query.
2060         String queriesRestrictedByTenantId = TenantBindingUtils.getPropertyValue(tenantBinding,
2061                 IQueryManager.JDBC_QUERIES_ARE_TENANT_ID_RESTRICTED);
2062         if (Tools.notBlank(queriesRestrictedByTenantId) &&
2063                 queriesRestrictedByTenantId.equalsIgnoreCase(Boolean.FALSE.toString())) {
2064             restrict = false;
2065         }
2066         return restrict;
2067     }
2068 }