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