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

   1 /**
   2  *  This document is a part of the source code and related artifacts
   3  *  for CollectionSpace, an open source collections management system
   4  *  for museums and related institutions:
   5
   6  *  http://www.collectionspace.org
   7  *  http://wiki.collectionspace.org
   8
   9  *  Copyright 2009 University of California at Berkeley
  10
  11  *  Licensed under the Educational Community License (ECL), Version 2.0.
  12  *  You may not use this file except in compliance with this License.
  13
  14  *  You may obtain a copy of the ECL 2.0 License at
  15
  16  *  https://source.collectionspace.org/collection-space/LICENSE.txt
  17
  18  *  Unless required by applicable law or agreed to in writing, software
  19  *  distributed under the License is distributed on an "AS IS" BASIS,
  20  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  21  *  See the License for the specific language governing permissions and
  22  *  limitations under the License.
  23  */
  24 package org.collectionspace.services.common.document;
  25
  26 import java.util.HashMap;
  27 import java.util.List;
  28 import java.util.Map;
  29 import java.util.StringTokenizer;
  30
  31 import org.collectionspace.services.common.api.RefName;
  32 import org.collectionspace.services.common.context.ServiceContext;
  33 import org.collectionspace.services.common.query.QueryContext;
  34
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37
  38 /**
  39  * AbstractDocumentHandler
  40  *
  41  * $LastChangedRevision: $
  42  * $LastChangedDate: $
  43  * @param <T>
  44  * @param <TL>
  45  * @param <WT>
  46  * @param <WTL>
  47  */
  48 @SuppressWarnings({"unchecked", "rawtypes"})
  49 public abstract class AbstractDocumentHandlerImpl<T, TL, WT, WTL>
  50         implements DocumentHandler<T, TL, WT, WTL> {
  51
  52     /** The logger. */
  53     private final Logger logger = LoggerFactory.getLogger(AbstractDocumentHandlerImpl.class);
  54
  55     /** The properties. */
  56     private Map<String, Object> properties = new HashMap<String, Object>();
  57
  58     /** The doc filter. */
  59     private DocumentFilter docFilter = null;
  60
  61     /** The service context. */
  62     private ServiceContext serviceContext;
  63
  64     /**
  65      * Instantiates a new abstract document handler impl.
  66      */
  67     public AbstractDocumentHandlerImpl() {
  68         // Empty constructor
  69     }
  70
  71     abstract protected String getRefnameDisplayName(DocumentWrapper<WT> docWrapper);
  72
  73     /*
  74      * Should return a reference name for the wrapper object
  75      */
  76     abstract protected RefName.RefNameInterface getRefName(DocumentWrapper<WT> docWrapper, String tenantName, String serviceName);
  77
  78     /* (non-Javadoc)
  79      * @see org.collectionspace.services.common.document.DocumentHandler#getServiceContext()
  80      */
  81         @Override
  82     public ServiceContext getServiceContext() {
  83         return serviceContext;
  84     }
  85
  86     /* (non-Javadoc)
  87      * @see org.collectionspace.services.common.document.DocumentHandler#setServiceContext(org.collectionspace.services.common.context.ServiceContext)
  88      */
  89     @Override
  90     public void setServiceContext(ServiceContext ctx) {
  91         serviceContext = ctx;
  92     }
  93
  94     /**
  95      * @return the properties
  96      */
  97     @Override
  98     public Map<String, Object> getProperties() {
  99         return properties;
 100     }
 101
 102     /**
 103      * @param properties the properties to set
 104      */
 105     @Override
 106     public void setProperties(Map<String, Object> properties) {
 107         this.properties = properties;
 108     }
 109
 110 //    public void initializeDocumentFilter(ServiceContext ctx) {
 111 //      DocumentFilter docFilter = this.createDocumentFilter(ctx);
 112 //      this.setDocumentFilter(docFilter);
 113 //    }
 114     /* (non-Javadoc)
 115  * @see org.collectionspace.services.common.document.DocumentHandler#createDocumentFilter()
 116  */
 117 @Override
 118     public abstract DocumentFilter createDocumentFilter();
 119
 120     /**
 121      * @return the DocumentFilter
 122      */
 123     @Override
 124     public DocumentFilter getDocumentFilter() {
 125         return docFilter;
 126     }
 127
 128     /**
 129      * @param properties the DocumentFilter to set
 130      */
 131     @Override
 132     public void setDocumentFilter(DocumentFilter docFilter) {
 133         this.docFilter = docFilter;
 134     }
 135
 136     /* (non-Javadoc)
 137      * @see org.collectionspace.services.common.document.DocumentHandler#prepare(org.collectionspace.services.common.document.DocumentHandler.Action)
 138      */
 139     @Override
 140     final public void prepare(Action action) throws Exception {
 141         switch (action) {
 142             case CREATE:
 143                 validate(action);
 144                 prepareCreate();
 145                 break;
 146
 147             case UPDATE:
 148                 validate(action);
 149                 prepareUpdate();
 150                 break;
 151
 152             case GET:
 153                 prepareGet();
 154                 break;
 155
 156             case GET_ALL:
 157                 prepareGetAll();
 158                 break;
 159
 160             case DELETE:
 161                 validate(action);
 162                 prepareDelete();
 163                 break;
 164
 165             case SYNC:
 166                 prepareSync();
 167                 break;
 168
 169                         case WORKFLOW:
 170                                 logger.error("Should never get to this code path.  If you did, there is a bug in the code.");
 171                                 Thread.dumpStack();
 172                                 break;
 173
 174                         default:
 175                                 logger.error("Should never get to this code path.  If you did, there is a bug in the code.");
 176                                 Thread.dumpStack();
 177                                 break;
 178         }
 179     }
 180
 181     /* (non-Javadoc)
 182      * @see org.collectionspace.services.common.document.DocumentHandler#prepareCreate()
 183      */
 184     @Override
 185     public void prepareCreate() throws Exception {
 186     }
 187
 188     /* (non-Javadoc)
 189      * @see org.collectionspace.services.common.document.DocumentHandler#prepareUpdate()
 190      */
 191     @Override
 192     public void prepareUpdate() throws Exception {
 193     }
 194
 195     /* (non-Javadoc)
 196      * @see org.collectionspace.services.common.document.DocumentHandler#prepareGet()
 197      */
 198     @Override
 199     public void prepareGet() throws Exception {
 200     }
 201
 202     /* (non-Javadoc)
 203      * @see org.collectionspace.services.common.document.DocumentHandler#prepareGetAll()
 204      */
 205     @Override
 206     public void prepareGetAll() throws Exception {
 207     }
 208
 209     /* (non-Javadoc)
 210      * @see org.collectionspace.services.common.document.DocumentHandler#prepareDelete()
 211      */
 212     @Override
 213     public void prepareDelete() throws Exception {
 214     }
 215
 216     /* (non-Javadoc)
 217      * @see org.collectionspace.services.common.document.DocumentHandler#prepareDelete()
 218      */
 219     @Override
 220     public void prepareSync() throws Exception {
 221         // Do nothing. Subclasses can override if they want/need to.
 222     }
 223
 224     /* (non-Javadoc)
 225      * @see org.collectionspace.services.common.document.DocumentHandler#handle(org.collectionspace.services.common.document.DocumentHandler.Action, org.collectionspace.services.common.document.DocumentWrapper)
 226      */
 227     @Override
 228     final public boolean handle(Action action, DocumentWrapper<?> wrapDoc) throws Exception {
 229         boolean result = true;
 230
 231         switch (action) {
 232             case CREATE:
 233                 handleCreate((DocumentWrapper<WT>) wrapDoc);
 234                 break;
 235
 236             case UPDATE:
 237                 handleUpdate((DocumentWrapper<WT>) wrapDoc);
 238                 break;
 239
 240             case GET:
 241                 handleGet((DocumentWrapper<WT>) wrapDoc);
 242                 break;
 243
 244             case GET_ALL:
 245                 handleGetAll((DocumentWrapper<WTL>) wrapDoc);
 246                 break;
 247
 248             case DELETE:
 249                 result = handleDelete((DocumentWrapper<WT>) wrapDoc);
 250                 break;
 251
 252             case SYNC:
 253                 result = handleSync((DocumentWrapper<Object>) wrapDoc);
 254                 break;
 255
 256                         case WORKFLOW:
 257                                 logger.error("Should never get to this code path.  If you did, there is a bug in the code.");
 258                                 Thread.dumpStack();
 259                                 break;
 260
 261                         default:
 262                                 logger.error("Should never get to this code path.  If you did, there is a bug in the code.");
 263                                 Thread.dumpStack();
 264                                 break;
 265         }
 266
 267         return result;
 268     }
 269
 270     /* (non-Javadoc)
 271      * @see org.collectionspace.services.common.document.DocumentHandler#handleCreate(org.collectionspace.services.common.document.DocumentWrapper)
 272      */
 273     @Override
 274     public abstract void handleCreate(DocumentWrapper<WT> wrapDoc) throws Exception;
 275
 276     /* (non-Javadoc)
 277      * @see org.collectionspace.services.common.document.DocumentHandler#handleUpdate(org.collectionspace.services.common.document.DocumentWrapper)
 278      */
 279     @Override
 280     public abstract void handleUpdate(DocumentWrapper<WT> wrapDoc) throws Exception;
 281
 282     /* (non-Javadoc)
 283      * @see org.collectionspace.services.common.document.DocumentHandler#handleGet(org.collectionspace.services.common.document.DocumentWrapper)
 284      */
 285     @Override
 286     public abstract void handleGet(DocumentWrapper<WT> wrapDoc) throws Exception;
 287
 288     /* (non-Javadoc)
 289      * @see org.collectionspace.services.common.document.DocumentHandler#handleGetAll(org.collectionspace.services.common.document.DocumentWrapper)
 290      */
 291     @Override
 292     public abstract void handleGetAll(DocumentWrapper<WTL> wrapDoc) throws Exception;
 293
 294     /* (non-Javadoc)
 295      * @see org.collectionspace.services.common.document.DocumentHandler#handleDelete(org.collectionspace.services.common.document.DocumentWrapper)
 296      */
 297     @Override
 298     public boolean handleDelete(DocumentWrapper<WT> wrapDoc) throws Exception {
 299         return true;
 300     }
 301
 302     /* (non-Javadoc)
 303      * @see org.collectionspace.services.common.document.DocumentHandler#handleDelete(org.collectionspace.services.common.document.DocumentWrapper)
 304      */
 305     @Override
 306     public boolean handleSync(DocumentWrapper<Object> wrapDoc) throws Exception {
 307         // Do nothing. Subclasses can override if they want/need to.
 308         return true;
 309     }
 310
 311
 312     /* (non-Javadoc)
 313      * @see org.collectionspace.services.common.document.DocumentHandler#complete(org.collectionspace.services.common.document.DocumentHandler.Action, org.collectionspace.services.common.document.DocumentWrapper)
 314      */
 315         @Override
 316     final public void complete(Action action, DocumentWrapper<?> wrapDoc) throws Exception {
 317         switch (action) {
 318             case CREATE:
 319                 completeCreate((DocumentWrapper<WT>) wrapDoc);
 320                 break;
 321
 322             case UPDATE:
 323                 completeUpdate((DocumentWrapper<WT>) wrapDoc);
 324                 break;
 325
 326             case GET:
 327                 completeGet((DocumentWrapper<WT>) wrapDoc);
 328                 break;
 329
 330             case GET_ALL:
 331                 completeGetAll((DocumentWrapper<WTL>) wrapDoc);
 332                 break;
 333
 334             case DELETE:
 335                 completeDelete((DocumentWrapper<WT>) wrapDoc);
 336                 break;
 337
 338             case SYNC:
 339                 completeSync((DocumentWrapper<Object>) wrapDoc);
 340                 break;
 341
 342                         case WORKFLOW:
 343                                 logger.error("Should never get to this code path.  If you did, there is a bug in the code.");
 344                                 Thread.dumpStack();
 345                                 break;
 346
 347                         default:
 348                                 logger.error("Should never get to this code path.  If you did, there is a bug in the code.");
 349                                 Thread.dumpStack();
 350                                 break;
 351         }
 352     }
 353
 354     /* (non-Javadoc)
 355      * @see org.collectionspace.services.common.document.DocumentHandler#completeCreate(org.collectionspace.services.common.document.DocumentWrapper)
 356      */
 357     @Override
 358     public void completeCreate(DocumentWrapper<WT> wrapDoc) throws Exception {
 359     }
 360
 361     /* (non-Javadoc)
 362      * @see org.collectionspace.services.common.document.DocumentHandler#completeUpdate(org.collectionspace.services.common.document.DocumentWrapper)
 363      */
 364     @Override
 365     public void completeUpdate(DocumentWrapper<WT> wrapDoc) throws Exception {
 366         //no specific action needed
 367     }
 368
 369     /* (non-Javadoc)
 370      * @see org.collectionspace.services.common.document.DocumentHandler#completeGet(org.collectionspace.services.common.document.DocumentWrapper)
 371      */
 372     @Override
 373     public void completeGet(DocumentWrapper<WT> wrapDoc) throws Exception {
 374     }
 375
 376     /* (non-Javadoc)
 377      * @see org.collectionspace.services.common.document.DocumentHandler#completeGetAll(org.collectionspace.services.common.document.DocumentWrapper)
 378      */
 379     @Override
 380     public void completeGetAll(DocumentWrapper<WTL> wrapDoc) throws Exception {
 381     }
 382
 383     /* (non-Javadoc)
 384      * @see org.collectionspace.services.common.document.DocumentHandler#completeDelete(org.collectionspace.services.common.document.DocumentWrapper)
 385      */
 386     @Override
 387     public void completeDelete(DocumentWrapper<WT> wrapDoc) throws Exception {
 388     }
 389
 390     /* (non-Javadoc)
 391      * @see org.collectionspace.services.common.document.DocumentHandler#completeDelete(org.collectionspace.services.common.document.DocumentWrapper)
 392      */
 393     @Override
 394     public void completeSync(DocumentWrapper<Object> wrapDoc) throws Exception {
 395     }
 396
 397     /* (non-Javadoc)
 398      * @see org.collectionspace.services.common.document.DocumentHandler#extractCommonPart(org.collectionspace.services.common.document.DocumentWrapper)
 399      */
 400     @Override
 401     public abstract T extractCommonPart(DocumentWrapper<WT> wrapDoc)
 402             throws Exception;
 403
 404     /* (non-Javadoc)
 405      * @see org.collectionspace.services.common.document.DocumentHandler#fillCommonPart(java.lang.Object, org.collectionspace.services.common.document.DocumentWrapper)
 406      */
 407     @Override
 408     public abstract void fillCommonPart(T obj, DocumentWrapper<WT> wrapDoc)
 409             throws Exception;
 410
 411     /* (non-Javadoc)
 412      * @see org.collectionspace.services.common.document.DocumentHandler#extractCommonPartList(org.collectionspace.services.common.document.DocumentWrapper)
 413      */
 414     @Override
 415     public abstract TL extractCommonPartList(DocumentWrapper<WTL> wrapDoc)
 416             throws Exception;
 417
 418     /* (non-Javadoc)
 419      * @see org.collectionspace.services.common.document.DocumentHandler#fillCommonPartList(java.lang.Object, org.collectionspace.services.common.document.DocumentWrapper)
 420      */
 421     @Override
 422     final public void fillCommonPartList(TL obj, DocumentWrapper<WTL> wrapDoc) throws Exception {
 423         throw new UnsupportedOperationException("bulk create/update not yet supported");
 424     }
 425
 426     /* (non-Javadoc)
 427      * @see org.collectionspace.services.common.document.DocumentHandler#getCommonPart()
 428      */
 429     @Override
 430     public abstract T getCommonPart();
 431
 432     /* (non-Javadoc)
 433      * @see org.collectionspace.services.common.document.DocumentHandler#setCommonPart(java.lang.Object)
 434      */
 435     @Override
 436     public abstract void setCommonPart(T obj);
 437
 438     /* (non-Javadoc)
 439      * @see org.collectionspace.services.common.document.DocumentHandler#getCommonPartList()
 440      */
 441     @Override
 442     public abstract TL getCommonPartList();
 443
 444     /* (non-Javadoc)
 445      * @see org.collectionspace.services.common.document.DocumentHandler#setCommonPartList(java.lang.Object)
 446      */
 447     @Override
 448     public abstract void setCommonPartList(TL obj);
 449
 450     /* (non-Javadoc)
 451      * @see org.collectionspace.services.common.document.DocumentHandler#getQProperty(java.lang.String)
 452      */
 453     @Override
 454     public abstract String getQProperty(String prop) throws DocumentException;
 455
 456     /*
 457      * Strip Nuxeo's schema name from the start of the field / element name.
 458      * (non-Javadoc)
 459      * @see org.collectionspace.services.common.document.DocumentHandler#getUnQProperty(java.lang.String)
 460      */
 461     @Override
 462     public String getUnQProperty(String qProp) {
 463         StringTokenizer tkz = new StringTokenizer(qProp, ":");
 464         if (tkz.countTokens() != 2) {
 465             String msg = "Property must be in the form xxx:yyy, "
 466                     + "e.g. collectionobjects_common:objectNumber";
 467             logger.error(msg);
 468             throw new IllegalArgumentException(msg);
 469         }
 470         tkz.nextToken(); //skip
 471         return tkz.nextToken();
 472     }
 473
 474     /**
 475      * Should return
 476      * @throws Exception
 477      * @throws DocumentException
 478      */
 479     @Override
 480     public String getDocumentsToIndexQuery(String indexId, String csid) throws DocumentException, Exception {
 481         return null;
 482     }
 483
 484     /* (non-Javadoc)
 485      * @see org.collectionspace.services.common.document.DocumentHandler#getServiceContextPath()
 486      */
 487     @Override
 488     public String getServiceContextPath() {
 489         return "/" + getServiceContext().getServiceName().toLowerCase() + "/";
 490     }
 491
 492     /**
 493      * Validate.
 494      *
 495      * @param action the action
 496      * @throws Exception the exception
 497      */
 498     private void validate(Action action) throws Exception {
 499         List<ValidatorHandler> valHandlers = serviceContext.getValidatorHandlers();
 500         for (ValidatorHandler handler : valHandlers) {
 501             handler.validate(action, serviceContext);
 502         }
 503     }
 504
 505     /**
 506      * Creates the CMIS query from the service context.  Each document handler is responsible for returning a valid CMIS query using the
 507      * information in the current service context -which includes things like the query parameters, etc.
 508      * @throws DocumentException
 509      */
 510     @Override
 511     public String getCMISQuery(QueryContext queryContext) throws DocumentException {
 512         //
 513         // By default, return nothing.  Child classes can override if they want.
 514         //
 515         return null;
 516     }
 517
 518     @Override
 519     public boolean isCMISQuery() {
 520         return false;
 521     }
 522
 523     @Override
 524     public boolean isJDBCQuery() {
 525         return false;
 526     }
 527
 528     @Override
 529     public Map<String,String> getJDBCQueryParams() {
 530         return new HashMap<>();
 531     }
 532
 533 }