org.lockss.laaws.config.impl.PluginHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of laaws-configuration-service Show documentation
LOCKSS Configuration Service
The newest version!
/*

Copyright (c) 2014-2020 Board of Trustees of Leland Stanford Jr. University,
all rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 */
package org.lockss.laaws.config.impl;

import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import org.lockss.app.LockssDaemon;
import org.lockss.plugin.Plugin;
import org.lockss.plugin.PluginManager;
import org.lockss.util.Logger;
import org.lockss.ws.entities.PluginWsResult;

/**
 * Helper of the web service implementation of plugin queries.
 */
public class PluginHelper {
  /**
   * The fully-qualified name of the class of the objects used as source in a
   * query.
   */
  static String SOURCE_FQCN = PluginWsSource.class.getCanonicalName();

  /**
   * The fully-qualified name of the class of the objects returned by the query.
   */
  static String RESULT_FQCN = PluginWsResult.class.getCanonicalName();

  //
  // Property names used in plugin queries.
  //
  static String PLUGIN_ID = "pluginId";
  static String NAME = "name";
  static String VERSION = "version";
  static String TYPE = "type";
  static String DEFINITION = "definition";
  static String REGISTRY = "registry";
  static String URL = "url";
  static String AU_COUNT = "auCount";
  static String PUBLISHING_PLATFORM = "publishingPlatform";

  /**
   * All the property names used in plugin queries.
   */
  @SuppressWarnings("serial")
  static final Set PROPERTY_NAMES = new HashSet() {
    {
      add(PLUGIN_ID);
      add(NAME);
      add(VERSION);
      add(TYPE);
      add(DEFINITION);
      add(REGISTRY);
      add(URL);
      add(AU_COUNT);
      add(PUBLISHING_PLATFORM);
    }
  };

  private static Logger log = Logger.getLogger();

  /**
   * Provides the universe of plugin-related objects used as the source for a
   * query.
   * 
   * @return a List with the universe.
   */
  List createUniverse() {
    final String DEBUG_HEADER = "createUniverse(): ";

    // Get all the plugins.
    Collection allPlugins =
	((PluginManager) LockssDaemon.getManager(LockssDaemon.PLUGIN_MANAGER))
	.getRegisteredPlugins();
    if (log.isDebug3())
      log.debug3(DEBUG_HEADER + "allPlugins.size() = " + allPlugins.size());

    // Initialize the universe.
    List universe =
	new ArrayList(allPlugins.size());

    // Loop through all the plugins.
    for (Plugin plugin : allPlugins) {
      // Add the object initialized with this plugin to the universe of objects.
      universe.add(new PluginWsSource(plugin));
    }

    if (log.isDebug2())
      log.debug2(DEBUG_HEADER + "universe.size() = " + universe.size());
    return universe;
  }

  /**
   * Provides a printable copy of a collection of plugin-related query results.
   * 
   * @param results
   *          A {@code Collection} with the query results.
   * @return a String with the requested printable copy.
   */
  String nonDefaultToString(Collection results) {
    StringBuilder builder = new StringBuilder("[");
    boolean isFirst = true;

    // Loop through through all the results in the collection.
    for (PluginWsResult result : results) {
      // Handle the first result differently.
      if (!isFirst) {
	builder.append(", ");
      } else {
	isFirst = false;
      }

      builder.append(nonDefaultToString(result));
    }

    // Add this result to the printable copy.
    return builder.append("]").toString();
  }

  /**
   * Provides a printable copy of a plugin-related query result.
   * 
   * @param result
   *          A PluginWsResult with the query result.
   * @return a String with the requested printable copy.
   */
  private String nonDefaultToString(PluginWsResult result) {
    StringBuilder builder = new StringBuilder("PluginWsResult [");
    boolean isFirst = true;

    if (result.getPluginId() != null) {
      builder.append("pluginId=").append(result.getPluginId());
      isFirst = false;
    }

    if (result.getName() != null) {
      if (!isFirst) {
	builder.append(", ");
      } else {
	isFirst = false;
      }

      builder.append("name=").append(result.getName());
    }

    if (result.getVersion() != null) {
      if (!isFirst) {
	builder.append(", ");
      } else {
	isFirst = false;
      }

      builder.append("version=").append(result.getVersion());
    }

    if (result.getType() != null) {
      if (!isFirst) {
	builder.append(", ");
      } else {
	isFirst = false;
      }

      builder.append("type=").append(result.getType());
    }

    if (result.getDefinition() != null) {
      if (!isFirst) {
	builder.append(", ");
      } else {
	isFirst = false;
      }

      builder.append("definition=").append(result.getDefinition());
    }

    if (result.getRegistry() != null) {
      if (!isFirst) {
	builder.append(", ");
      } else {
	isFirst = false;
      }

      builder.append("registry=").append(result.getRegistry());
    }

    if (result.getUrl() != null) {
      if (!isFirst) {
	builder.append(", ");
      } else {
	isFirst = false;
      }

      builder.append("url=").append(result.getUrl());
    }

    if (result.getAuCount() != null) {
      if (!isFirst) {
	builder.append(", ");
      } else {
	isFirst = false;
      }

      builder.append("auCount=").append(result.getAuCount());
    }

    if (result.getPublishingPlatform() != null) {
      if (!isFirst) {
	builder.append(", ");
      } else {
	isFirst = false;
      }

      builder.append("publishingPlatform=")
      .append(result.getPublishingPlatform());
    }

    return builder.append("]").toString();
  }
}