/*
 * Copyright (c) 2020 MarkLogic Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.marklogic.client.impl;

import java.nio.charset.CharsetEncoder;
import java.util.*;

import javax.xml.bind.DatatypeConverter;
import javax.xml.datatype.Duration;

import com.marklogic.client.query.SearchQueryDefinition;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.marklogic.client.DatabaseClientFactory.HandleFactoryRegistry;
import com.marklogic.client.FailedRequestException;
import com.marklogic.client.ForbiddenUserException;
import com.marklogic.client.ResourceNotFoundException;
import com.marklogic.client.Transaction;
import com.marklogic.client.bitemporal.TemporalDescriptor;
import com.marklogic.client.bitemporal.TemporalDocumentManager;
import com.marklogic.client.document.DocumentDescriptor;
import com.marklogic.client.document.DocumentManager;
import com.marklogic.client.document.DocumentMetadataPatchBuilder;
import com.marklogic.client.document.DocumentUriTemplate;
import com.marklogic.client.document.DocumentPage;
import com.marklogic.client.document.DocumentWriteSet;
import com.marklogic.client.document.ServerTransform;
import com.marklogic.client.impl.DocumentMetadataPatchBuilderImpl.DocumentPatchHandleImpl;
import com.marklogic.client.io.Format;
import com.marklogic.client.io.marker.AbstractReadHandle;
import com.marklogic.client.io.marker.AbstractWriteHandle;
import com.marklogic.client.io.marker.ContentHandle;
import com.marklogic.client.io.marker.DocumentMetadataReadHandle;
import com.marklogic.client.io.marker.DocumentMetadataWriteHandle;
import com.marklogic.client.io.marker.DocumentPatchHandle;
import com.marklogic.client.io.marker.SearchReadHandle;
import com.marklogic.client.io.SearchHandle;
import com.marklogic.client.query.QueryManager.QueryView;
import com.marklogic.client.util.RequestParameters;

abstract class DocumentManagerImpl<R extends AbstractReadHandle, W extends AbstractWriteHandle>
  extends AbstractLoggingManager implements DocumentManager<R, W>,
  TemporalDocumentManager<R, W> {
  static final private long DEFAULT_PAGE_LENGTH = 50;

  static final private Logger logger = LoggerFactory
    .getLogger(DocumentManagerImpl.class);

  private boolean isProcessedMetadataModified = false;
  final private Set<Metadata> processedMetadata = new HashSet<Metadata>() {
    @Override
    public boolean add(Metadata e) {
      isProcessedMetadataModified = true;
      return super.add(e);
    }

    @Override
    public boolean addAll(Collection<? extends Metadata> c) {
      isProcessedMetadataModified = true;
      return super.addAll(c);
    }
  };
  {
    processedMetadata.add(Metadata.ALL);
    // we need to know if the user modifies after us
    isProcessedMetadataModified = false;
  }

  private RESTServices services;
  private Format contentFormat;
  private HandleFactoryRegistry handleRegistry;
  private ServerTransform readTransform;
  private ServerTransform writeTransform;
  private long pageLength = DEFAULT_PAGE_LENGTH;
  private QueryView searchView = QueryView.RESULTS;
  private Format nonDocumentFormat = null;

  DocumentManagerImpl(RESTServices services, Format contentFormat) {
    super();
    this.services = services;
    this.contentFormat = contentFormat;
  }

  RESTServices getServices() {
    return services;
  }

  void setServices(RESTServices services) {
    this.services = services;
  }

  HandleFactoryRegistry getHandleRegistry() {
    return handleRegistry;
  }

  void setHandleRegistry(HandleFactoryRegistry handleRegistry) {
    this.handleRegistry = handleRegistry;
  }

  @Override
  public Format getContentFormat() {
    return contentFormat;
  }

  @Override
  public void setContentFormat(Format format) {
    contentFormat = format;
  }

  // select categories of metadata to read, write, or reset
  @Override
  public void setMetadataCategories(Set<Metadata> categories) {
    clearMetadataCategories();
    processedMetadata.addAll(categories);
  }

  @Override
  public void setMetadataCategories(Metadata... categories) {
    clearMetadataCategories();
    for (Metadata category : categories)
      processedMetadata.add(category);
  }

  @Override
  public Set<Metadata> getMetadataCategories() {
    return processedMetadata;
  }

  @Override
  public void clearMetadataCategories() {
    processedMetadata.clear();
  }

  @Override
  public DocumentDescriptor exists(String uri) throws ForbiddenUserException,
    FailedRequestException {
    return exists(uri, null);
  }

  @Override
  public DocumentDescriptor exists(String uri, Transaction transaction)
    throws ForbiddenUserException, FailedRequestException {
    return services.head(requestLogger, uri, transaction);
  }

  // shortcut readers
  @Override
  public <T> T readAs(String uri, Class<T> as)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    return readAs(uri, null, as, null);
  }

  @Override
  public <T> T readAs(String uri, Class<T> as, ServerTransform transform)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    return readAs(uri, null, as, transform);
  }

  @Override
  public <T> T readAs(String uri, DocumentMetadataReadHandle metadataHandle,
                      Class<T> as) throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    return readAs(uri, metadataHandle, as, null);
  }

  @Override
  public <T> T readAs(String uri, DocumentMetadataReadHandle metadataHandle,
                      Class<T> as, ServerTransform transform) throws ResourceNotFoundException,
    ForbiddenUserException, FailedRequestException {
    ContentHandle<T> handle = getHandleRegistry().makeHandle(as);

    if (null == read(uri, metadataHandle, castAbstractReadHandle(as, handle),
      transform)) {
      return null;
    }

    return handle.get();
  }

  R castAbstractReadHandle(Class<?> as, AbstractReadHandle handle) {
    try {
      @SuppressWarnings("unchecked")
      R readHandle = (R) handle;
      return readHandle;
    } catch (ClassCastException e) {
      throw new IllegalArgumentException("Handle "
        + handle.getClass().getName()
        + " cannot be used in the context to read " + as.getName());
    }
  }

  // strongly typed readers
  @Override
  public <T extends R> T read(String uri, T contentHandle)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    return read(uri, null, contentHandle, null, null);
  }

  @Override
  public <T extends R> T read(String uri, T contentHandle,
                              ServerTransform transform) throws ResourceNotFoundException,
    ForbiddenUserException, FailedRequestException {
    return read(uri, null, contentHandle, transform, null);
  }

  @Override
  public <T extends R> T read(String uri,
                              DocumentMetadataReadHandle metadataHandle, T contentHandle)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    return read(uri, metadataHandle, contentHandle, null, null);
  }

  @Override
  public <T extends R> T read(String uri,
                              DocumentMetadataReadHandle metadataHandle, T contentHandle,
                              ServerTransform transform) throws ResourceNotFoundException,
    ForbiddenUserException, FailedRequestException {
    return read(uri, metadataHandle, contentHandle, transform, null);
  }

  @Override
  public <T extends R> T read(String uri, T contentHandle,
                              Transaction transaction) throws ResourceNotFoundException,
    ForbiddenUserException, FailedRequestException {
    return read(uri, null, contentHandle, null, transaction);
  }

  @Override
  public <T extends R> T read(String uri, T contentHandle,
                              ServerTransform transform, Transaction transaction)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    return read(uri, null, contentHandle, transform, transaction);
  }

  @Override
  public <T extends R> T read(String uri,
                              DocumentMetadataReadHandle metadataHandle, T contentHandle,
                              Transaction transaction) throws ResourceNotFoundException,
    ForbiddenUserException, FailedRequestException {
    return read(uri, metadataHandle, contentHandle, null, transaction);
  }

  @Override
  public <T extends R> T read(String uri,
                              DocumentMetadataReadHandle metadataHandle, T contentHandle,
                              ServerTransform transform, Transaction transaction)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    // return read(new DocumentDescriptorImpl(docId, true), metadataHandle,
    // contentHandle, transform, transaction, null, null);
    return read(new DocumentDescriptorImpl(uri, true), metadataHandle,
      contentHandle, transform, transaction, null, getReadParams());
  }

  /*
   * @Override public <T extends R> T read(String docId,
   * DocumentMetadataReadHandle metadataHandle, T contentHandle, ServerTransform
   * transform, Transaction transaction, String temporalCollection) throws
   * ResourceNotFoundException, ForbiddenUserException, FailedRequestException {
   * return read(new DocumentDescriptorImpl(docId, true), metadataHandle,
   * contentHandle, transform, transaction, temporalCollection, null); }
   */

  @Override
  public <T extends R> T read(DocumentDescriptor desc, T contentHandle)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    return read(desc, null, contentHandle, null, null);
  }

  @Override
  public <T extends R> T read(DocumentDescriptor desc, T contentHandle,
                              ServerTransform transform) throws ResourceNotFoundException,
    ForbiddenUserException, FailedRequestException {
    return read(desc, null, contentHandle, transform, null);
  }

  @Override
  public <T extends R> T read(DocumentDescriptor desc,
                              DocumentMetadataReadHandle metadataHandle, T contentHandle)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    return read(desc, metadataHandle, contentHandle, null, null);
  }

  @Override
  public <T extends R> T read(DocumentDescriptor desc,
                              DocumentMetadataReadHandle metadataHandle, T contentHandle,
                              ServerTransform transform) throws ResourceNotFoundException,
    ForbiddenUserException, FailedRequestException {
    return read(desc, metadataHandle, contentHandle, transform, null);
  }

  @Override
  public <T extends R> T read(DocumentDescriptor desc, T contentHandle,
                              Transaction transaction) throws ResourceNotFoundException,
    ForbiddenUserException, FailedRequestException {
    return read(desc, null, contentHandle, null, transaction);
  }

  @Override
  public <T extends R> T read(DocumentDescriptor desc, T contentHandle,
                              ServerTransform transform, Transaction transaction)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    return read(desc, null, contentHandle, transform, transaction);
  }

  @Override
  public <T extends R> T read(DocumentDescriptor desc,
                              DocumentMetadataReadHandle metadataHandle, T contentHandle,
                              Transaction transaction) throws ResourceNotFoundException,
    ForbiddenUserException, FailedRequestException {
    return read(desc, metadataHandle, contentHandle, null, transaction);
  }

  @Override
  public <T extends R> T read(DocumentDescriptor desc,
                              DocumentMetadataReadHandle metadataHandle, T contentHandle,
                              ServerTransform transform, Transaction transaction)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    return read(desc, metadataHandle, contentHandle, transform, transaction,
      null, getReadParams());
  }

  /*
   * @Override public <T extends R> T read(DocumentDescriptor desc,
   * DocumentMetadataReadHandle metadataHandle, T contentHandle, ServerTransform
   * transform, Transaction transaction, String temporalCollection) throws
   * ResourceNotFoundException, ForbiddenUserException, FailedRequestException {
   * return read(desc, metadataHandle, contentHandle, transform, transaction,
   * temporalCollection, getReadParams()); }
   */

  @SuppressWarnings("rawtypes")
  public <T extends R> T read(DocumentDescriptor desc,
                              DocumentMetadataReadHandle metadataHandle, T contentHandle,
                              ServerTransform transform, Transaction transaction,
                              String temporalCollection, RequestParameters extraParams)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    if (desc == null)
      throw new IllegalArgumentException(
        "Attempt to call read with null DocumentDescriptor");

    if (logger.isInfoEnabled())
      logger.info("Reading metadata and content for {}", desc.getUri());

    if (metadataHandle != null) {
      HandleImplementation metadataBase = HandleAccessor.checkHandle(
        metadataHandle, "metadata");
      Format metadataFormat = metadataBase.getFormat();
      if (metadataFormat != Format.JSON && metadataFormat != Format.XML) {
        if (logger.isWarnEnabled())
          logger.warn("Unsupported metadata format {}, using XML",
                  (metadataFormat == null) ? "null" : metadataFormat.name());
        metadataBase.setFormat(Format.XML);
      }
    }

    checkContentFormat(contentHandle);

    extraParams = addTemporalParams(extraParams, temporalCollection, null, null);

    boolean wasModified = services.getDocument(
      requestLogger,
      desc,
      transaction,
      (metadataHandle != null) ? processedMetadata : null,
      mergeTransformParameters((transform != null) ? transform
        : getReadTransform(), extraParams), metadataHandle, contentHandle);

    // TODO: after response, reset metadata and set flag

    return wasModified ? contentHandle : null;
  }

  @Override
  public DocumentPage read(String... uris) {
    return read(-1, null, null, uris);
  }

  public DocumentPage read(long serverTimestamp, String... uris) {
    return read(serverTimestamp, null, null, uris);
  }

  @Override
  public DocumentPage read(Transaction transaction, String... uris) {
    return read(-1, null, transaction, uris);
  }

  public DocumentPage read(long serverTimestamp, Transaction transaction, String... uris) {
    return read(serverTimestamp, null, transaction, uris);
  }

  @Override
  public DocumentPage read(ServerTransform transform, String... uris) {
    return read(-1, transform, null, uris);
  }

  public DocumentPage read(long serverTimestamp, ServerTransform transform, String... uris) {
    return read(serverTimestamp, transform, null, uris);
  }

  @Override
  public DocumentPage read(ServerTransform transform, Transaction transaction,
                           String... uris) {
    boolean withContent = true;
    return read(-1, transform, transaction, withContent, null, uris);
  }

  public DocumentPage read(long serverTimestamp, ServerTransform transform, Transaction transaction,
                           String... uris) {
    boolean withContent = true;
    return read(serverTimestamp, transform, transaction, withContent, null, uris);
  }

  /*
   * @Override public DocumentPage read(ServerTransform transform, Transaction
   * transaction, String temporalCollection, String[] uris) { boolean
   * withContent = true; return read(transform, transaction, withContent,
   * temporalCollection, uris); }
   */
  public DocumentPage read(long serverTimestamp, ServerTransform transform, Transaction transaction,
                           boolean withContent, String temporalCollection, String[] uris) {
    if (uris == null || uris.length == 0)
      throw new IllegalArgumentException("Attempt to call read with no uris");

    if (logger.isInfoEnabled())
      logger.info(
        "Reading metadata and content for multiple uris beginning with {}",
        uris[0]);

    RequestParameters extraParams = addTemporalParams(new RequestParameters(),
      temporalCollection, null, null);

    return services.getBulkDocuments(
      requestLogger,
      serverTimestamp,
      transaction,
      // the default for bulk is no metadata, which differs from the normal
      // default of ALL
      (isProcessedMetadataModified || !withContent) ? processedMetadata : null,
      nonDocumentFormat,
      mergeTransformParameters((transform != null) ? transform : getReadTransform(), extraParams),
      withContent,
      uris);
  }

  @Override
  public DocumentPage readMetadata(String... uris) {
    boolean withContent = false;
    return read(-1, null, null, withContent, null, uris);
  }

  @Override
  public DocumentPage readMetadata(Transaction transaction, String... uris) {
    boolean withContent = false;
    return read(-1, null, transaction, withContent, null, uris);
  }

  @Override
  public DocumentPage search(SearchQueryDefinition querydef, long start) {
    return search(querydef, start, -1, null, null, null);
  }

  @Override
  public DocumentPage search(SearchQueryDefinition querydef, long start, String forestName) {
    return search(querydef, start, -1, null, null, forestName);
  }

  public DocumentPage search(SearchQueryDefinition querydef, long start, long serverTimestamp) {
    return search(querydef, start, serverTimestamp, null, null, null);
  }

  @Override
  public DocumentPage search(SearchQueryDefinition querydef, long start,
                             SearchReadHandle searchHandle) {
    return search(querydef, start, -1, searchHandle, null, null);
  }

  @Override
  public DocumentPage search(SearchQueryDefinition querydef, long start,
                             SearchReadHandle searchHandle, String forestName) {
    return search(querydef, start, -1, searchHandle, null, forestName);
  }

  @Override
  public DocumentPage search(SearchQueryDefinition querydef, long start,
                             Transaction transaction) {
    return search(querydef, start, -1, null, transaction, null);
  }

  @Override
  public DocumentPage search(SearchQueryDefinition querydef, long start,
                             Transaction transaction, String forestName) {
    return search(querydef, start, -1, null, transaction, forestName);
  }

  public DocumentPage search(SearchQueryDefinition querydef, long start,
                             long serverTimestamp, Transaction transaction) {
    return search(querydef, start, serverTimestamp, null, transaction, null);
  }

  @Override
  public DocumentPage search(SearchQueryDefinition querydef, long start,
                             SearchReadHandle searchHandle, Transaction transaction) {
    return search(querydef, start, -1, searchHandle, transaction, null);
  }

  @Override
  public DocumentPage search(SearchQueryDefinition querydef, long start,
                             SearchReadHandle searchHandle, Transaction transaction, String forestName) {
    return search(querydef, start, -1, searchHandle, transaction, forestName);
  }

  private DocumentPage search(SearchQueryDefinition querydef, long start,
                              long serverTimestamp, SearchReadHandle searchHandle, Transaction transaction, String forestName) {

    if (searchHandle != null) {
      HandleImplementation searchBase = HandleAccessor.checkHandle(
        searchHandle, "search");
      if (searchHandle instanceof SearchHandle) {
        SearchHandle responseHandle = (SearchHandle) searchHandle;
        responseHandle.setHandleRegistry(getHandleRegistry());
        responseHandle.setQueryCriteria(querydef);
      }
      if (nonDocumentFormat != null
        && nonDocumentFormat != searchBase.getFormat()) {
        throw new UnsupportedOperationException(
          "The format supported by your handle:[" + searchBase.getFormat()
            + "] does not match the non-document format:["
            + nonDocumentFormat + "]");
      }
    }

    // the default for bulk is no metadata, which differs from the normal
    // default of ALL
    Set<Metadata> metadata = isProcessedMetadataModified ? processedMetadata
      : null;
    return services.getBulkDocuments(requestLogger, serverTimestamp, querydef, start,
      getPageLength(), transaction, searchHandle, searchView, metadata,
      nonDocumentFormat, getReadTransform(), null, forestName);
  }

  @Override
  public long getPageLength() {
    return pageLength;
  }

  @Override
  public void setPageLength(long length) {
    this.pageLength = length;
  }

  @Override
  public QueryView getSearchView() {
    return searchView;
  }

  @Override
  public void setSearchView(QueryView view) {
    this.searchView = view;
  }

  @Override
  public Format getNonDocumentFormat() {
    return nonDocumentFormat;
  }

  @Override
  public void setNonDocumentFormat(Format nonDocumentFormat) {
    if (nonDocumentFormat != Format.XML && nonDocumentFormat != Format.JSON) {
      throw new UnsupportedOperationException(
        "Only XML and JSON are valid response formats.  You specified:["
          + nonDocumentFormat + "]");
    }
    this.nonDocumentFormat = nonDocumentFormat;
  }

  @Override
  public DocumentWriteSet newWriteSet() {
    return new DocumentWriteSetImpl();
  }

  @Override
  public void write(DocumentWriteSet writeSet) {
    write(writeSet, null, null);
  }

  @Override
  public void write(DocumentWriteSet writeSet, ServerTransform transform) {
    write(writeSet, transform, null, null);
  }

  @Override
  public void write(DocumentWriteSet writeSet, Transaction transaction) {
    write(writeSet, null, transaction, null);
  }

  @Override
  public void write(DocumentWriteSet writeSet, ServerTransform transform,
                    Transaction transaction) {
    write(writeSet, transform, transaction, null);
  }

  @Override
  public void write(DocumentWriteSet writeSet, ServerTransform transform,
                    Transaction transaction, String temporalCollection) {
    if ( writeSet == null ) throw new IllegalArgumentException("writeSet must not be null");
    Format defaultFormat = contentFormat;
    RequestParameters extraParams = getWriteParams();
    String extraContentDispositionParams = "";
    if (extraParams != null && extraParams.size() > 0) {
      CharsetEncoder asciiEncoder = java.nio.charset.StandardCharsets.US_ASCII.newEncoder();
      StringBuilder extraParamBldr = new StringBuilder();
      for (Map.Entry<String, List<String>> entry: extraParams.entrySet()) {
        String key = entry.getKey();
        for (String value: entry.getValue()) {
          extraParamBldr.append("; ");
          extraParamBldr.append(key);
          extraParamBldr.append(Utilities.escapeMultipartParamAssignment(asciiEncoder, value));
        }
      }
      if (extraParamBldr.length() > 0) {
        extraContentDispositionParams = extraParamBldr.toString();
      }
    }
    services.postBulkDocuments(requestLogger, writeSet,
      (transform != null) ? transform : getWriteTransform(),
      transaction,
      defaultFormat, null, temporalCollection, extraContentDispositionParams);
  }

  // shortcut writers
  @Override
  public void writeAs(String uri, Object content)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    writeAs(uri, null, content, null);
  }

  @Override
  public void writeAs(String uri, Object content, ServerTransform transform)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    writeAs(uri, null, content, transform);
  }

  @Override
  public void writeAs(String uri, DocumentMetadataWriteHandle metadataHandle,
                      Object content) throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    writeAs(uri, metadataHandle, content, null);
  }

  @Override
  public void writeAs(String uri, DocumentMetadataWriteHandle metadataHandle,
                      Object content, ServerTransform transform)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    if (content == null) {
      throw new IllegalArgumentException("no content to write");
    }

    Class<?> as = content.getClass();

    W writeHandle = null;
    if (AbstractWriteHandle.class.isAssignableFrom(as)) {
      AbstractWriteHandle handle = (AbstractWriteHandle) content;
      writeHandle = castAbstractWriteHandle(null, handle);
    } else {
      ContentHandle<?> handle = getHandleRegistry().makeHandle(as);
      Utilities.setHandleContent(handle, content);
      writeHandle = castAbstractWriteHandle(as, handle);
    }

    write(uri, metadataHandle, writeHandle, transform);
  }

  W castAbstractWriteHandle(Class<?> as, AbstractWriteHandle handle) {
    try {
      @SuppressWarnings("unchecked")
      W writeHandle = (W) handle;
      return writeHandle;
    } catch (ClassCastException e) {
      if (as == null) {
        throw new IllegalArgumentException("Handle "
          + handle.getClass().getName()
          + " cannot be used in the context for writing");
      }
      throw new IllegalArgumentException("Handle "
        + handle.getClass().getName()
        + " cannot be used in the context to write " + as.getName());
    }
  }

  // strongly typed writers
  @Override
  public void write(String uri, W contentHandle)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    write(uri, null, contentHandle, null, null, null, null);
  }

  @Override
  public void write(String uri, W contentHandle, ServerTransform transform)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    write(uri, null, contentHandle, transform, null, null, null);
  }

  @Override
  public void write(String uri, DocumentMetadataWriteHandle metadata,
                    W contentHandle) throws ResourceNotFoundException,
    ForbiddenUserException, FailedRequestException {
    write(uri, metadata, contentHandle, null, null, null, null);
  }

  @Override
  public void write(String uri, DocumentMetadataWriteHandle metadata,
                    W contentHandle, ServerTransform transform)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    write(uri, metadata, contentHandle, transform, null, null, null);
  }

  @Override
  public void write(String uri, W contentHandle, Transaction transaction)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    write(uri, null, contentHandle, null, transaction, null, null);
  }

  @Override
  public void write(String uri, W contentHandle, ServerTransform transform,
                    Transaction transaction) throws ResourceNotFoundException,
    ForbiddenUserException, FailedRequestException {
    write(uri, null, contentHandle, transform, transaction, null, null);
  }

  @Override
  public void write(String uri, DocumentMetadataWriteHandle metadataHandle,
                    W contentHandle, Transaction transaction)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    write(uri, metadataHandle, contentHandle, null, transaction, null, null);
  }

  @Override
  public void write(String uri, DocumentMetadataWriteHandle metadataHandle,
                    W contentHandle, ServerTransform transform, Transaction transaction)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    write(uri, metadataHandle, contentHandle, transform, transaction, null, null);
  }

  @Override
  public TemporalDescriptor write(String uri, DocumentMetadataWriteHandle metadataHandle,
                                  W contentHandle, ServerTransform transform, Transaction transaction,
                                  String temporalCollection) throws ResourceNotFoundException,
    ForbiddenUserException, FailedRequestException {
    return write(uri, metadataHandle, contentHandle, transform, transaction,
      temporalCollection, null);
  }

  @Override
  public TemporalDescriptor write(String uri, DocumentMetadataWriteHandle metadataHandle,
                                  W contentHandle, ServerTransform transform, Transaction transaction,
                                  String temporalCollection, Calendar systemTime)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    return write(new DocumentDescriptorImpl(uri, true), null, metadataHandle, contentHandle,
      transform, transaction, temporalCollection, systemTime, getWriteParams());
  }

  @Override
  public TemporalDescriptor write(String uri, String temporalDocumentURI, DocumentMetadataWriteHandle metadataHandle,
                                  W contentHandle, ServerTransform transform, Transaction transaction,
                                  String temporalCollection) {
    return write(new DocumentDescriptorImpl(uri, true), temporalDocumentURI, metadataHandle, contentHandle,
      transform, transaction, temporalCollection, null, getWriteParams());
  }

  @Override
  public TemporalDescriptor write(String uri, String temporalDocumentURI, DocumentMetadataWriteHandle metadataHandle,
                                  W contentHandle, ServerTransform transform, Transaction transaction,
                                  String temporalCollection, Calendar systemTime) {
    return write(new DocumentDescriptorImpl(uri, true), temporalDocumentURI, metadataHandle, contentHandle,
      transform, transaction, temporalCollection, systemTime, getWriteParams());
  }

  protected TemporalDescriptor write(String uri, DocumentMetadataWriteHandle metadataHandle,
                                     W contentHandle, ServerTransform transform, Transaction transaction,
                                     String temporalCollection, Calendar systemTime,
                                     RequestParameters extraParams) throws ResourceNotFoundException,
    ForbiddenUserException, FailedRequestException {
    return write(new DocumentDescriptorImpl(uri, true), null, metadataHandle, contentHandle,
      transform, transaction, temporalCollection, systemTime, extraParams);
  }

  @Override
  public void write(DocumentDescriptor desc, W contentHandle)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    write(desc, null, contentHandle, null, null, null, null);
  }

  @Override
  public void write(DocumentDescriptor desc, W contentHandle,
                    ServerTransform transform) throws ResourceNotFoundException,
    ForbiddenUserException, FailedRequestException {
    write(desc, null, contentHandle, transform, null, null, null);
  }

  @Override
  public void write(DocumentDescriptor desc,
                    DocumentMetadataWriteHandle metadata, W contentHandle)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    write(desc, metadata, contentHandle, null, null, null, null);
  }

  @Override
  public void write(DocumentDescriptor desc,
                    DocumentMetadataWriteHandle metadata, W contentHandle,
                    ServerTransform transform) throws ResourceNotFoundException,
    ForbiddenUserException, FailedRequestException {
    write(desc, metadata, contentHandle, transform, null, null, null);
  }

  @Override
  public void write(DocumentDescriptor desc, W contentHandle,
                    Transaction transaction) throws ResourceNotFoundException,
    ForbiddenUserException, FailedRequestException {
    write(desc, null, contentHandle, null, transaction, null, null);
  }

  @Override
  public void write(DocumentDescriptor desc, W contentHandle,
                    ServerTransform transform, Transaction transaction)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    write(desc, null, contentHandle, transform, transaction, null, null);
  }

  @Override
  public void write(DocumentDescriptor desc,
                    DocumentMetadataWriteHandle metadataHandle, W contentHandle,
                    Transaction transaction) throws ResourceNotFoundException,
    ForbiddenUserException, FailedRequestException {
    write(desc, metadataHandle, contentHandle, null, transaction, null, null);
  }

  @Override
  public void write(DocumentDescriptor desc,
                    DocumentMetadataWriteHandle metadataHandle, W contentHandle,
                    ServerTransform transform, Transaction transaction)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    write(desc, metadataHandle, contentHandle, transform, transaction, null,
      null);
  }

  @Override
  public TemporalDescriptor write(DocumentDescriptor desc,
                                  DocumentMetadataWriteHandle metadataHandle, W contentHandle,
                                  ServerTransform transform, Transaction transaction,
                                  String temporalCollection) throws ResourceNotFoundException,
    ForbiddenUserException, FailedRequestException {
    return write(desc, metadataHandle, contentHandle, transform, transaction,
      temporalCollection, null);
  }

  @Override
  public TemporalDescriptor write(DocumentDescriptor desc,
                                  DocumentMetadataWriteHandle metadataHandle, W contentHandle,
                                  ServerTransform transform, Transaction transaction,
                                  String temporalCollection, Calendar systemTime)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    return write(desc, null, metadataHandle, contentHandle, transform, transaction,
      temporalCollection, null, getWriteParams());
  }

  @Override
  public TemporalDescriptor write(DocumentDescriptor desc, String temporalDocumentURI,
                                  DocumentMetadataWriteHandle metadataHandle, W contentHandle,
                                  ServerTransform transform, Transaction transaction,
                                  String temporalCollection) {
    return write(desc, temporalDocumentURI, metadataHandle, contentHandle, transform, transaction,
      temporalCollection, null);
  }

  @Override
  public TemporalDescriptor write(DocumentDescriptor desc, String temporalDocumentURI,
                                  DocumentMetadataWriteHandle metadataHandle, W contentHandle,
                                  ServerTransform transform, Transaction transaction,
                                  String temporalCollection, Calendar systemTime) {
    return write(desc, temporalDocumentURI, metadataHandle, contentHandle, transform, transaction,
      temporalCollection, null, getWriteParams());
  }

  @SuppressWarnings("rawtypes")
  protected TemporalDescriptor write(DocumentDescriptor desc, String temporalDocumentURI,
                                     DocumentMetadataWriteHandle metadataHandle, W contentHandle,
                                     ServerTransform transform, Transaction transaction,
                                     String temporalCollection, java.util.Calendar systemTime,
                                     RequestParameters extraParams) throws ResourceNotFoundException,
    ForbiddenUserException, FailedRequestException {
    if (desc == null)
      throw new IllegalArgumentException(
        "Writing document with null identifier");

    if (logger.isInfoEnabled())
      logger.info("Writing content for {}", desc.getUri());

    if (metadataHandle != null) {
      HandleImplementation metadataBase = HandleAccessor.checkHandle(
        metadataHandle, "metadata");
      Format metadataFormat = metadataBase.getFormat();
      if (metadataFormat != Format.JSON && metadataFormat != Format.XML) {
        if (logger.isWarnEnabled())
          logger.warn("Unsupported metadata format {}, using XML",
                  (metadataFormat == null) ? "null" : metadataFormat.name());
        metadataBase.setFormat(Format.XML);
      }
    }

    checkContentFormat(contentHandle);

    extraParams = addTemporalParams(extraParams, temporalCollection, temporalDocumentURI, systemTime);

    return services.putDocument(
      requestLogger,
      desc,
      transaction,
      (metadataHandle != null) ? processedMetadata : null,
      mergeTransformParameters((transform != null) ? transform
        : getWriteTransform(), extraParams), metadataHandle, contentHandle);
  }

  @Override
  public void delete(String uri) throws ResourceNotFoundException,
    ForbiddenUserException, FailedRequestException {
    delete(uri, null, null, null);
  }

  @Override
  public void delete(String uri, Transaction transaction)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    delete(new DocumentDescriptorImpl(uri, true), transaction, null, null);
  }

  @Override
  public void delete(String... uris)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException
  {
    if ( uris == null ) throw new IllegalArgumentException("uris must not be null");
    if ( uris.length == 0 ) throw new IllegalArgumentException("uris array must not be zero-length");
    services.delete(requestLogger, null, null, uris);
  }

  @Override
  public void delete(Transaction transaction, String... uris)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException
  {
    services.delete(requestLogger, transaction, null, uris);
  }

  @Override
  public void delete(DocumentDescriptor desc) throws ResourceNotFoundException,
    ForbiddenUserException, FailedRequestException {
    delete(desc, null, null, null);
  }

  @Override
  public void delete(DocumentDescriptor desc, Transaction transaction)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    delete(desc, transaction, null, null);
  }

  @Override
  public TemporalDescriptor delete(String uri, Transaction transaction,
                                   String temporalCollection) throws ResourceNotFoundException,
    ForbiddenUserException, FailedRequestException {
    return delete(new DocumentDescriptorImpl(uri, true), transaction,
      temporalCollection, null);
  }

  @Override
  public TemporalDescriptor delete(String uri, Transaction transaction,
                                   String temporalCollection, java.util.Calendar systemTime)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    return delete(new DocumentDescriptorImpl(uri, true), transaction,
      temporalCollection, systemTime);
  }

  @Override
  public TemporalDescriptor delete(DocumentDescriptor desc, Transaction transaction,
                                   String temporalCollection) throws ResourceNotFoundException,
    ForbiddenUserException, FailedRequestException {
    return delete(desc, transaction, temporalCollection, null);
  }

  @Override
  public TemporalDescriptor delete(DocumentDescriptor desc, Transaction transaction,
                                   String temporalCollection, java.util.Calendar systemTime)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    if (desc == null)
      throw new IllegalArgumentException(
        "Deleting document with null identifier");

    if (logger.isInfoEnabled())
      logger.info("Deleting {}", desc.getUri());

    RequestParameters extraParams = addTemporalParams(new RequestParameters(),
      temporalCollection, null, systemTime);

    return services.deleteDocument(requestLogger, desc, transaction, null, extraParams);
  }

  @Override
  public String advanceLsqt(String temporalCollection) {
    return services.advanceLsqt(requestLogger, temporalCollection, -1);
  }

  @Override
  public String advanceLsqt(String temporalCollection, long lag) {
    return services.advanceLsqt(requestLogger, temporalCollection, lag);
  }

  @Override
  public void wipe(String temporalDocumentURI, String temporalCollection) {
    wipe(temporalDocumentURI, null, temporalCollection);
  }

  @Override
  public void wipe(String temporalDocumentURI, Transaction transaction, String temporalCollection) {
    if (temporalDocumentURI == null || temporalCollection == null)
      throw new IllegalArgumentException("Temporal Document URI and Temporal collection cannot be null");

    if (logger.isInfoEnabled())
      logger.info("Wiping {} of {} temporal collection", temporalDocumentURI, temporalCollection);

    RequestParameters extraParams = addTemporalParams(new RequestParameters(), temporalCollection, null, null);
    services.wipeDocument(requestLogger, temporalDocumentURI, transaction, extraParams);
  }

  @Override
  public void protect(String temporalDocumentURI, String temporalCollection, ProtectionLevel level, Duration duration) {
    protect(temporalDocumentURI, temporalCollection, null, level, duration.toString(), null, null);
  }

  @Override
  public void protect(String temporalDocumentURI, String temporalCollection, ProtectionLevel level, Calendar expiryTime) {
    protect(temporalDocumentURI, temporalCollection, null, level, null, expiryTime, null);
  }

  @Override
  public void protect(String temporalDocumentURI, String temporalCollection, ProtectionLevel level, Duration duration, String archivePath) {
    protect(temporalDocumentURI, temporalCollection, null, level, duration.toString(), null, archivePath);
  }

  @Override
  public void protect(String temporalDocumentURI, String temporalCollection, ProtectionLevel level, Calendar expiryTime, String archivePath) {
    protect(temporalDocumentURI, temporalCollection, null, level, null, expiryTime, archivePath);
  }

  @Override
  public void protect(String temporalDocumentURI, String temporalCollection, ProtectionLevel level, Duration duration, Transaction transaction) {
    protect(temporalDocumentURI, temporalCollection, transaction, level, duration.toString(), null, null);
  }

  @Override
  public void protect(String temporalDocumentURI, String temporalCollection, ProtectionLevel level, Calendar expiryTime, Transaction transaction) {
    protect(temporalDocumentURI, temporalCollection, transaction, level, null, expiryTime, null);
  }

  @Override
  public void protect(String temporalDocumentURI, String temporalCollection, ProtectionLevel level, Duration duration, String archivePath, Transaction transaction) {
    protect(temporalDocumentURI, temporalCollection, transaction, level, duration.toString(), null, archivePath);
  }

  @Override
  public void protect(String temporalDocumentURI, String temporalCollection, ProtectionLevel level, Calendar expiryTime, String archivePath, Transaction transaction) {
    protect(temporalDocumentURI, temporalCollection, transaction, level, null, expiryTime, archivePath);
  }

  protected void protect(String temporalDocumentURI, String temporalCollection, Transaction transaction,
                         ProtectionLevel level, String duration, Calendar expiryTime, String archivePath) {
    if (level == null) {
      level = ProtectionLevel.NODELETE;
    }
    if(duration == null && expiryTime == null) {
      throw new IllegalArgumentException(
        "Need either duration or expiry time for protecting a document");
    }
    if (temporalDocumentURI == null || temporalCollection == null)
      throw new IllegalArgumentException(
        "Temporal Document URI and Temporal collection cannot be null");
    RequestParameters extraParams = addTemporalParams(new RequestParameters(), temporalCollection, null, null);
    services.protectDocument(requestLogger, temporalDocumentURI, transaction, extraParams, level, duration, expiryTime, archivePath);
  }

  // shortcut creators
  @Override
  public DocumentDescriptor createAs(DocumentUriTemplate template,
                                     Object content) throws ForbiddenUserException, FailedRequestException {
    return createAs(template, null, content, null);
  }

  @Override
  public DocumentDescriptor createAs(DocumentUriTemplate template,
                                     Object content, ServerTransform transform) throws ForbiddenUserException,
    FailedRequestException {
    return createAs(template, null, content, transform);
  }

  @Override
  public DocumentDescriptor createAs(DocumentUriTemplate template,
                                     DocumentMetadataWriteHandle metadataHandle, Object content)
    throws ForbiddenUserException, FailedRequestException {
    return createAs(template, metadataHandle, content, null);
  }

  @Override
  public DocumentDescriptor createAs(DocumentUriTemplate template,
                                     DocumentMetadataWriteHandle metadataHandle, Object content,
                                     ServerTransform transform) throws ForbiddenUserException,
    FailedRequestException {
    Class<?> as = content.getClass();
    W writeHandle = null;
    if (AbstractWriteHandle.class.isAssignableFrom(as)) {
      AbstractWriteHandle handle = (AbstractWriteHandle) content;
      writeHandle = castAbstractWriteHandle(null, handle);
    } else {
      ContentHandle<?> handle = getHandleRegistry().makeHandle(as);
      Utilities.setHandleContent(handle, content);
      writeHandle = castAbstractWriteHandle(as, handle);
    }
    return create(template, metadataHandle, writeHandle, transform);
  }

  // strongly typed creators
  @Override
  public DocumentDescriptor create(DocumentUriTemplate template, W contentHandle)
    throws ForbiddenUserException, FailedRequestException {
    return create(template, null, contentHandle, null, null, null, null, null);
  }

  @Override
  public DocumentDescriptor create(DocumentUriTemplate template,
                                   W contentHandle, ServerTransform transform)
    throws ForbiddenUserException, FailedRequestException {
    return create(template, null, contentHandle, transform, null, null, null, null);
  }

  @Override
  public DocumentDescriptor create(DocumentUriTemplate template,
                                   W contentHandle, Transaction transaction) throws ForbiddenUserException,
    FailedRequestException {
    return create(template, null, contentHandle, null, transaction, null, null, null);
  }

  @Override
  public DocumentDescriptor create(DocumentUriTemplate template,
                                   W contentHandle, ServerTransform transform, Transaction transaction)
    throws ForbiddenUserException, FailedRequestException {
    return create(template, null, contentHandle, transform, transaction, null, null, null);
  }

  @Override
  public DocumentDescriptor create(DocumentUriTemplate template,
                                   DocumentMetadataWriteHandle metadataHandle, W contentHandle)
    throws ForbiddenUserException, FailedRequestException {
    return create(template, metadataHandle, contentHandle, null, null, null, null, null);
  }

  @Override
  public DocumentDescriptor create(DocumentUriTemplate template,
                                   DocumentMetadataWriteHandle metadataHandle, W contentHandle,
                                   ServerTransform transform) throws ForbiddenUserException,
    FailedRequestException {
    return create(template, metadataHandle, contentHandle, transform, null,
      null, null, null);
  }

  @Override
  public DocumentDescriptor create(DocumentUriTemplate template,
                                   DocumentMetadataWriteHandle metadataHandle, W contentHandle,
                                   Transaction transaction) throws ForbiddenUserException,
    FailedRequestException {
    return create(template, metadataHandle, contentHandle, null, transaction,
      null, null, null);
  }

  @Override
  public DocumentDescriptor create(DocumentUriTemplate template,
                                   DocumentMetadataWriteHandle metadataHandle, W contentHandle,
                                   ServerTransform transform, Transaction transaction)
    throws ForbiddenUserException, FailedRequestException {
    return create(template, metadataHandle, contentHandle, transform,
      transaction, null, null, null);
  }

  @Override
  public TemporalDescriptor create(DocumentUriTemplate template,
                                   DocumentMetadataWriteHandle metadataHandle, W contentHandle,
                                   ServerTransform transform, Transaction transaction,
                                   String temporalCollection) throws ForbiddenUserException,
    FailedRequestException {
    return create(template, metadataHandle, contentHandle, transform,
      transaction, temporalCollection, null, null);
  }

  @Override
  public TemporalDescriptor create(DocumentUriTemplate template,
                                   DocumentMetadataWriteHandle metadataHandle, W contentHandle,
                                   ServerTransform transform, Transaction transaction,
                                   String temporalCollection, Calendar systemTime) {
    return create(template, metadataHandle, contentHandle, transform,
      transaction, temporalCollection, null, null);
  }

  @SuppressWarnings("rawtypes")
  protected DocumentDescriptorImpl create(DocumentUriTemplate template,
                                          DocumentMetadataWriteHandle metadataHandle, W contentHandle,
                                          ServerTransform transform, Transaction transaction,
                                          String temporalCollection, Calendar systemTime,
                                          RequestParameters extraParams) {
    if ( logger.isInfoEnabled() ) logger.info("Creating content");
    if ( extraParams == null ) extraParams = getWriteParams();

    if (metadataHandle != null) {
      HandleImplementation metadataBase = HandleAccessor.checkHandle(
        metadataHandle, "metadata");
      Format metadataFormat = metadataBase.getFormat();
      if (metadataFormat != Format.JSON && metadataFormat != Format.XML) {
        if (logger.isWarnEnabled())
          logger.warn("Unsupported metadata format {}, using XML",
                  (metadataFormat == null) ? "null" : metadataFormat.name());
        metadataBase.setFormat(Format.XML);
      }
    }

    extraParams = addTemporalParams(extraParams, temporalCollection, null, systemTime);

    checkContentFormat(contentHandle);

    return services.postDocument(
      requestLogger,
      template,
      transaction,
      (metadataHandle != null) ? processedMetadata : null,
      mergeTransformParameters((transform != null) ? transform
        : getWriteTransform(), extraParams), metadataHandle, contentHandle);
  }

  @Override
  public void patchAs(String uri, Object patch) throws ForbiddenUserException,
    FailedRequestException {
    if (patch == null) {
      throw new IllegalArgumentException("no patch to apply");
    }

    Class<?> as = patch.getClass();

    DocumentPatchHandle patchHandle = null;
    if (DocumentPatchHandle.class.isAssignableFrom(as)) {
      patchHandle = (DocumentPatchHandle) patch;
    } else {
      ContentHandle<?> handle = getHandleRegistry().makeHandle(as);
      if (!DocumentPatchHandle.class.isAssignableFrom(handle.getClass())) {
        throw new IllegalArgumentException("Handle "
          + handle.getClass().getName()
          + " cannot be used to apply patch as " + as.getName());
      }
      Utilities.setHandleContent(handle, patch);
      patchHandle = (DocumentPatchHandle) handle;
    }

    patch(uri, patchHandle);
  }

  @Override
  public void patch(String uri, DocumentPatchHandle patch)
    throws ForbiddenUserException, FailedRequestException {
    patch(uri, patch, null);
  }

  @Override
  public void patch(String uri, DocumentPatchHandle patch,
                    Transaction transaction) throws ForbiddenUserException,
    FailedRequestException {
    patch(new DocumentDescriptorImpl(uri, true), patch, transaction);
  }

  @Override
  public void patch(DocumentDescriptor desc, DocumentPatchHandle patch)
    throws ForbiddenUserException, FailedRequestException {
    patch(desc, patch, null);
  }

  @Override
  public void patch(DocumentDescriptor desc, DocumentPatchHandle patch,
                    Transaction transaction) throws ForbiddenUserException,
    FailedRequestException {
    if (logger.isInfoEnabled())
      logger.info("Patching document");

    DocumentPatchHandleImpl builtPatch = (patch instanceof DocumentPatchHandleImpl) ? (DocumentPatchHandleImpl) patch
      : null;
    services.patchDocument(requestLogger, desc, transaction,
      (builtPatch != null) ? builtPatch.getMetadata() : processedMetadata,
      (builtPatch != null) ? builtPatch.isOnContent() : true, patch);
  }

  @Override
  public void patch(String uri, String temporalCollection, DocumentPatchHandle patch) {
    patch(uri, null, temporalCollection, null, patch, null);
  }

  @Override
  public void patch(String uri, String temporalCollection, DocumentPatchHandle patch, Transaction transaction) {
    patch(uri, null, temporalCollection, null, patch, transaction);
  }

  @Override
  public void patch(String uri, String temporalDocumentURI, String temporalCollection, String sourceDocumentURI, DocumentPatchHandle patch) {
    patch(uri, temporalDocumentURI, temporalCollection, sourceDocumentURI, patch, null);
  }

  @Override
  public void patch(String uri, String temporalDocumentURI,  String temporalCollection, String sourceDocumentURI, DocumentPatchHandle patch, Transaction transaction) {
    if (uri == null) {
      throw new IllegalArgumentException("Document URI cannot be null");
    }
    if (temporalCollection == null) {
      throw new IllegalArgumentException("Need temporal collection to patch a temporal document");
    }
    if (logger.isInfoEnabled())
      logger.info("Patching document");

    RequestParameters extraParams = null;
    extraParams = addTemporalParams(extraParams, temporalCollection, temporalDocumentURI, null);
    DocumentPatchHandleImpl builtPatch = (patch instanceof DocumentPatchHandleImpl) ? (DocumentPatchHandleImpl) patch
      : null;
    services.patchDocument(requestLogger, new DocumentDescriptorImpl(uri, true), transaction, (builtPatch != null) ? builtPatch.getMetadata() : processedMetadata,
      (builtPatch != null) ? builtPatch.isOnContent() : true, extraParams, sourceDocumentURI, patch);
  }

  @Override
  public <T extends DocumentMetadataReadHandle> T readMetadata(String uri,
                                                               T metadataHandle) throws ResourceNotFoundException,
    ForbiddenUserException, FailedRequestException {
    return readMetadata(uri, metadataHandle, null);
  }

  @Override
  public <T extends DocumentMetadataReadHandle> T readMetadata(String uri,
                                                               T metadataHandle, Transaction transaction)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    read(uri, metadataHandle, null, transaction);

    return metadataHandle;
  }

  @Override
  public void writeMetadata(String uri,
                            DocumentMetadataWriteHandle metadataHandle)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    writeMetadata(uri, metadataHandle, null);
  }

  @Override
  public void writeMetadata(String uri,
                            DocumentMetadataWriteHandle metadataHandle, Transaction transaction)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    write(uri, metadataHandle, (W) null, transaction);
  }

  @Override
  public void writeDefaultMetadata(String uri)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    writeDefaultMetadata(uri, null);
  }

  @Override
  public void writeDefaultMetadata(String uri, Transaction transaction)
    throws ResourceNotFoundException, ForbiddenUserException,
    FailedRequestException {
    if (uri == null)
      throw new IllegalArgumentException(
        "Resetting document metadata with null identifier");

    if (logger.isInfoEnabled())
      logger.info("Resetting metadata for {}", uri);

    services.deleteDocument(requestLogger,
      new DocumentDescriptorImpl(uri, true), transaction, processedMetadata,
      getWriteParams());
  }

  @Override
  public void writeDefaultMetadata(String... uris)
    throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
  {
    writeDefaultMetadata((Transaction) null, uris);
  }
  @Override
  public void writeDefaultMetadata(Transaction transaction, String... uris)
    throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
  {
    if (uris.length == 0)
      throw new IllegalArgumentException(
              "Resetting document metadata with empty identifier list");
    services.delete(requestLogger, transaction, processedMetadata, uris);
  }

  @Override
  public ServerTransform getReadTransform() {
    return readTransform;
  }

  @Override
  public void setReadTransform(ServerTransform transform) {
    this.readTransform = transform;
  }

  @Override
  public ServerTransform getWriteTransform() {
    return writeTransform;
  }

  @Override
  public void setWriteTransform(ServerTransform transform) {
    this.writeTransform = transform;
  }

  @Override
  public DocumentDescriptor newDescriptor(String uri) {
    return new DocumentDescriptorImpl(uri, false);
  }

  @Override
  public DocumentUriTemplate newDocumentUriTemplate(String extension) {
    return new DocumentUriTemplateImpl(extension);
  }

  @Override
  public DocumentMetadataPatchBuilder newPatchBuilder(Format pathFormat) {
    return new DocumentMetadataPatchBuilderImpl(pathFormat);
  }

  private void checkContentFormat(Object contentHandle) {
    checkContentFormat(HandleAccessor.checkHandle(contentHandle, "content"));
  }

  @SuppressWarnings("rawtypes")
  private void checkContentFormat(HandleImplementation contentBase) {
    if (contentBase == null)
      return;

    if (contentFormat != null && contentFormat != Format.UNKNOWN) {
      Format currFormat = contentBase.getFormat();
      if (currFormat != contentFormat) {
        contentBase.setFormat(contentFormat);
        if (currFormat != Format.UNKNOWN)
          contentBase.setMimetype(contentFormat.getDefaultMimetype());
      }
    }
  }

  protected RequestParameters mergeTransformParameters(
    ServerTransform transform, RequestParameters extraParams) {
    if (transform == null)
      return extraParams;

    if (extraParams == null)
      extraParams = new RequestParameters();

    transform.merge(extraParams);

    return extraParams;
  }

  // hooks for extension
  protected RequestParameters getReadParams() {
    return null;
  }

  protected RequestParameters getWriteParams() {
    return null;
  }

  protected RequestParameters addTemporalParams(RequestParameters params,
                                                String temporalCollection, String temporalDocumentURI, Calendar systemTime) {
    if (params == null)
      params = new RequestParameters();
    if (temporalCollection != null)
      params.add("temporal-collection", temporalCollection);
    if (temporalDocumentURI != null)
      params.add("temporal-document", temporalDocumentURI);
    if (systemTime != null) {
      String formattedSystemTime = DatatypeConverter.printDateTime(systemTime);
      params.add("system-time", formattedSystemTime);
    }
    return params;
  }
}
