com.marklogic.client.impl.ExtensionLibrariesManagerImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of marklogic-client-api Show documentation
The official MarkLogic Java client API.
The newest version!
/*
 * Copyright © 2024 MarkLogic Corporation. All Rights Reserved.
 */
package com.marklogic.client.impl;

import java.util.ArrayList;
import java.util.List;

import javax.xml.stream.XMLEventReader;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.events.XMLEvent;

import com.marklogic.client.DatabaseClientFactory.HandleFactoryRegistry;
import com.marklogic.client.FailedRequestException;
import com.marklogic.client.ForbiddenUserException;
import com.marklogic.client.MarkLogicIOException;
import com.marklogic.client.ResourceNotFoundException;
import com.marklogic.client.ResourceNotResendableException;
import com.marklogic.client.admin.ExtensionLibrariesManager;
import com.marklogic.client.admin.ExtensionLibraryDescriptor;
import com.marklogic.client.admin.ExtensionLibraryDescriptor.Permission;
import com.marklogic.client.io.XMLEventReaderHandle;
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.util.RequestParameters;

public class ExtensionLibrariesManagerImpl
  extends AbstractLoggingManager
  implements ExtensionLibrariesManager
{
  private RESTServices          services;
  private HandleFactoryRegistry handleRegistry;

  public ExtensionLibrariesManagerImpl(RESTServices services) {
    super();
    this.services = services;
  }

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

  @Override
  public ExtensionLibraryDescriptor[] list()
    throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException {
    return list("/ext");
  }
  @Override
  public ExtensionLibraryDescriptor[] list(String directory)
    throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException {

    XMLEventReaderHandle handle = services.getResource(requestLogger, directory, null, null, new XMLEventReaderHandle());

    XMLEventReader reader = handle.get();
    List modules = new ArrayList<>();
    while (reader.hasNext()) {
      XMLEvent event;
      try {
        event = reader.nextEvent();
        if (event.isCharacters()) {
          String modulePath = event.asCharacters().getData();
          ExtensionLibraryDescriptor module = new ExtensionLibraryDescriptor();
          module.setPath(modulePath);
          modules.add(module);
        }
      } catch (XMLStreamException e) {
        throw new MarkLogicIOException(e);
      }

    }
    return modules.toArray(new ExtensionLibraryDescriptor[] {});
  }

  @Override
  public  T readAs(String modulePath, Class as)
    throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException {
    ContentHandle handle = getHandleRegistry().makeHandle(as);
    read(modulePath, handle);
    return handle.get();
  }
  @Override
  public  T read(ExtensionLibraryDescriptor modulesDescriptor, Class as)
    throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException {
    ContentHandle handle = getHandleRegistry().makeHandle(as);
    read(modulesDescriptor, handle);
    return handle.get();
  }
  @Override
  public  T read(String modulePath, T readHandle)
    throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException {
    checkPath(modulePath);
    return services.getResource(requestLogger, modulePath, null, null, readHandle);
  }
  @Override
  public  T read(ExtensionLibraryDescriptor modulesDescriptor, T readHandle)
    throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException {
    return read(modulesDescriptor.getPath(), readHandle);
  }

  @Override
  public void writeAs(String modulePath, Object content)
    throws ResourceNotFoundException, ResourceNotResendableException, ForbiddenUserException, FailedRequestException {
    write(modulePath, getContentHandle(content));
  }
  @Override
  public void writeAs(ExtensionLibraryDescriptor modulesDescriptor, Object content)
    throws ResourceNotFoundException, ResourceNotResendableException, ForbiddenUserException, FailedRequestException {
    write(modulesDescriptor, getContentHandle(content));
  }
  private AbstractWriteHandle getContentHandle(Object content) {
    if (content == null) {
      throw new IllegalArgumentException("no content to write");
    }

    Class as = content.getClass();

    AbstractWriteHandle contentHandle = null;
    if (AbstractWriteHandle.class.isAssignableFrom(as)) {
      contentHandle = (AbstractWriteHandle) content;
    } else {
      ContentHandle handle = getHandleRegistry().makeHandle(as);
      Utilities.setHandleContent(handle, content);
      contentHandle = handle;
    }

    return contentHandle;
  }

  @Override
  public void write(String modulePath, AbstractWriteHandle contentHandle)
    throws ResourceNotFoundException, ResourceNotResendableException, ForbiddenUserException, FailedRequestException {
    checkPath(modulePath);
    services.putResource(requestLogger, modulePath, null, null, contentHandle, null);
  }
  @Override
  public void write(ExtensionLibraryDescriptor modulesDescriptor, AbstractWriteHandle contentHandle)
    throws ResourceNotFoundException, ResourceNotResendableException, ForbiddenUserException, FailedRequestException {
    RequestParameters requestParams = new RequestParameters();
    for (Permission perm : modulesDescriptor.getPermissions()) {
      requestParams.add("perm:" + perm.getRoleName(), perm.getCapability());
    }
    checkPath(modulesDescriptor.getPath());
    services.putResource(requestLogger, modulesDescriptor.getPath(), null, requestParams, contentHandle, null);
  }

  private void checkPath(String libraryPath) {
    if ( libraryPath == null ) throw new IllegalArgumentException("libraryPath must not be null");
    if ( ! libraryPath.startsWith("/ext/") ) throw new IllegalArgumentException(
      "libraryPath (the modules database path under which you install an asset) must begin with /ext/");
  }

  @Override
  public void delete(String modulePath)
    throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException {
    checkPath(modulePath);
    services.deleteResource(requestLogger, modulePath, null, null, null);
  }
  @Override
  public void delete(ExtensionLibraryDescriptor modulesDescriptor)
    throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException {
    delete(modulesDescriptor.getPath());
  }
}