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