com.marklogic.client.impl.RuleManagerImpl 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 com.marklogic.client.FailedRequestException;
import com.marklogic.client.ForbiddenUserException;
import com.marklogic.client.ResourceNotFoundException;
import com.marklogic.client.DatabaseClientFactory.HandleFactoryRegistry;
import com.marklogic.client.alerting.RuleDefinition;
import com.marklogic.client.alerting.RuleManager;
import com.marklogic.client.document.ServerTransform;
import com.marklogic.client.io.Format;
import com.marklogic.client.io.marker.ContentHandle;
import com.marklogic.client.io.marker.RuleListReadHandle;
import com.marklogic.client.io.marker.RuleReadHandle;
import com.marklogic.client.io.marker.RuleWriteHandle;
import com.marklogic.client.io.marker.StructureWriteHandle;
import com.marklogic.client.query.QueryDefinition;
import com.marklogic.client.query.QueryManager;

public class RuleManagerImpl
  extends AbstractLoggingManager
  implements RuleManager
{

  final static private String RULES_BASE = "/alert/rules";

  private RESTServices          services;
  private HandleFactoryRegistry handleRegistry;

  public RuleManagerImpl(RESTServices services) {
    this.services = services;
  }

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

  @Override
  public boolean exists(String ruleName) {
    return services.exists(RULES_BASE + "/" + ruleName);
  }

  @Override
  public  T readRuleAs(String ruleName, Class as)
    throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException {
    ContentHandle handle = getHandleRegistry().makeHandle(as);
    if (!RuleReadHandle.class.isAssignableFrom(handle.getClass())) {
      throw new IllegalArgumentException(
        "Handle "+handle.getClass().getName()+
          " cannot be used to read rule as "+as.getName()
      );
    }

    readRule(ruleName, (RuleReadHandle) handle);

    return handle.get();
  }
  @Override
  @SuppressWarnings({ "unchecked", "rawtypes" })
  public  T readRule(String ruleName, T ruleHandle)
    throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException {
    if (ruleName == null) {
      throw new IllegalArgumentException("Cannot read null rule name");
    }

    HandleImplementation ruleBase = HandleAccessor.checkHandle(ruleHandle,
      "rule");

    Format ruleFormat = ruleBase.getFormat();
    switch (ruleFormat) {
      case UNKNOWN:
        ruleFormat = Format.XML;
        break;
      case JSON:
      case XML:
        break;
      default:
        throw new UnsupportedOperationException(
          "Only JSON and XML rules are possible.");
    }

    String mimetype = ruleFormat.getDefaultMimetype();
    ruleBase.receiveContent(services.getValue(requestLogger, RULES_BASE,
      ruleName, false, mimetype, ruleBase.receiveAs()));

    return ruleHandle;
  }

  @Override
  public void writeRuleAs(String ruleName, Object ruleSource)
    throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException {
    if (ruleSource == null) {
      throw new IllegalArgumentException("no source to write");
    }

    Class as = ruleSource.getClass();

    RuleWriteHandle sourceHandle = null;
    if (RuleWriteHandle.class.isAssignableFrom(as)) {
      sourceHandle = (RuleWriteHandle) ruleSource;
    } else {
      ContentHandle handle = getHandleRegistry().makeHandle(as);
      if (!RuleWriteHandle.class.isAssignableFrom(handle.getClass())) {
        throw new IllegalArgumentException(
          "Handle "+handle.getClass().getName()+
            " cannot be used to write rule source as "+as.getName()
        );
      }
      Utilities.setHandleContent(handle, ruleSource);
      sourceHandle = (RuleWriteHandle) handle;
    }

    if (sourceHandle instanceof RuleDefinition) {
      ((RuleDefinition) sourceHandle).setName(ruleName);
    }
    writeRule(ruleName, sourceHandle);
  }

  @Override
  public void writeRule(RuleDefinition ruleHandle) {
    String ruleName = ruleHandle.getName();
    writeRule(ruleName, ruleHandle);
  }
  @SuppressWarnings("rawtypes")
  @Override
  public void writeRule(String ruleName, RuleWriteHandle writeHandle)
    throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException {
    if (writeHandle instanceof RuleDefinition) {
      String name = ((RuleDefinition) writeHandle).getName();
      if (name != null)
        ruleName = name;
    }
    HandleImplementation ruleBase = HandleAccessor.checkHandle(writeHandle,
      "rule");

    if (ruleBase == null)
      throw new IllegalArgumentException("Could not write null rule: "
        + ruleName);

    Format ruleFormat = ruleBase.getFormat();
    switch (ruleFormat) {
      case UNKNOWN:
        ruleFormat = Format.XML;
        break;
      case JSON:
      case XML:
        break;
      default:
        throw new UnsupportedOperationException(
          "Only JSON and XML rules are supported.");
    }

    String mimetype = ruleFormat.getDefaultMimetype();

    services.putValue(requestLogger, RULES_BASE, ruleName, mimetype, ruleBase);
  }

  @Override
  public void delete(String ruleName) throws ForbiddenUserException,
    FailedRequestException {
    services.deleteValue(null, RULES_BASE, ruleName);
  }

  @Override
  public  T match(QueryDefinition docQuery, T ruleListHandle) {
    return match(docQuery, 1, QueryManager.DEFAULT_PAGE_LENGTH, new String[] {}, ruleListHandle);
  }
  @Override
  public  T match(QueryDefinition docQuery, long start,
                                                long pageLength, String[] candidateRules, T ruleListHandle) {
    return match(docQuery, start, pageLength, candidateRules, ruleListHandle, null);
  }
  @Override
  public  T match(QueryDefinition docQuery, long start,
                                                long pageLength, String[] candidateRules, T ruleListHandle, ServerTransform transform) {

    HandleAccessor.receiveContent(ruleListHandle,
      services.match(docQuery, start, pageLength, candidateRules, transform));
    ;
    return ruleListHandle;
  }

  @Override
  public  T match(String[] docIds, T ruleListHandle) {
    return match(docIds, new String[] {}, ruleListHandle);
  }
  @Override
  public  T match(String[] docIds, String[] candidateRules, T ruleListHandle) {
    return match(docIds, candidateRules, ruleListHandle, null);
  }
  @Override
  public  T match(String[] docIds, String[] candidateRules, T ruleListHandle, ServerTransform transform) {
    HandleAccessor.receiveContent(ruleListHandle,
      services.match(docIds, candidateRules, transform));
    return ruleListHandle;
  }

  @Override
  public  T matchAs(Object content, T ruleListHandle) {
    return matchAs(content, null, ruleListHandle, null);
  }
  @Override
  public  T matchAs(Object content, String[] candidateRules, T ruleListHandle) {
    return matchAs(content, candidateRules, ruleListHandle, null);
  }
  @Override
  public  T matchAs(Object content,
                                                  String[] candidateRules, T ruleListHandle, ServerTransform transform) {
    if (content == null) {
      throw new IllegalArgumentException("no content for matching rules");
    }

    Class as = content.getClass();

    StructureWriteHandle matchHandle = null;
    if (StructureWriteHandle.class.isAssignableFrom(as)) {
      matchHandle = (StructureWriteHandle) content;
    } else {
      ContentHandle handle = getHandleRegistry().makeHandle(as);
      if (!StructureWriteHandle.class.isAssignableFrom(handle.getClass())) {
        throw new IllegalArgumentException(
          "Handle "+handle.getClass().getName()+
            " cannot be used to match rules as "+as.getName()
        );
      }
      Utilities.setHandleContent(handle, content);
      matchHandle = (StructureWriteHandle) handle;
    }

    return match(matchHandle, candidateRules, ruleListHandle, transform);
  }
  @Override
  public  T match(StructureWriteHandle document, T ruleListHandle) {
    return match(document, new String[] {}, ruleListHandle);
  }
  @Override
  public  T match(StructureWriteHandle document,
                                                String[] candidateRules, T ruleListHandle) {
    return match(document, candidateRules, ruleListHandle, null);
  }
  @SuppressWarnings("rawtypes")
  @Override
  public  T match(StructureWriteHandle document,
                                                String[] candidateRules, T ruleListHandle, ServerTransform transform) {

    HandleImplementation searchBase = HandleAccessor.checkHandle(document, "match");

    Format searchFormat = searchBase.getFormat();
    switch(searchFormat) {
      case UNKNOWN:
        searchFormat = Format.XML;
        break;
      case JSON:
      case XML:
        break;
      default:
        throw new UnsupportedOperationException("Only XML and JSON queries can filter for rule matches.");
    }

    String mimeType = searchFormat.getDefaultMimetype();


    HandleAccessor.receiveContent(ruleListHandle,
      services.match(document, candidateRules, mimeType, transform));
    return ruleListHandle;
  }

}