org.dspace.external.provider.impl.SHERPAv2PublisherDataProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dspace-api Show documentation
DSpace core data model and service APIs.
There is a newer version: 8.0
/**
 * The contents of this file are subject to the license and copyright
 * detailed in the LICENSE and NOTICE files at the root of the source
 * tree and available online at
 *
 * http://www.dspace.org/license/
 */
package org.dspace.external.provider.impl;

import java.io.IOException;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;

import org.apache.commons.collections4.CollectionUtils;
import org.apache.commons.lang3.StringUtils;
import org.dspace.app.sherpa.SHERPAService;
import org.dspace.app.sherpa.v2.SHERPAPublisher;
import org.dspace.app.sherpa.v2.SHERPAPublisherResponse;
import org.dspace.app.sherpa.v2.SHERPAUtils;
import org.dspace.content.dto.MetadataValueDTO;
import org.dspace.external.model.ExternalDataObject;
import org.dspace.external.provider.AbstractExternalDataProvider;

/**
 * This class is the implementation of the ExternalDataProvider interface that will deal with SHERPAPublisher External
 * data lookups.
 * This provider is a refactored version of SherpaPublisherDataPublisher, rewritten to work with SHERPA v2 API
 *
 * It uses a more simple response object than the normal publication / policy search
 *
 * @author Kim Shepherd
 */
public class SHERPAv2PublisherDataProvider extends AbstractExternalDataProvider {

    // Source identifier (eg 'sherpaPublisher') configured in spring configuration
    private String sourceIdentifier;
    // SHERPA service configured in spring configuration
    private SHERPAService sherpaService;

    @Override
    public String getSourceIdentifier() {
        return sourceIdentifier;
    }

    /**
     * Initialise the client that we need to call the endpoint
     * @throws IOException  If something goes wrong
     */
    public void init() throws IOException {}

    /**
     * Get a single publisher based on a "id equals string" query
     * @param id    The publisher ID which will be used as query string
     * @return external data object representing publisher
     */
    @Override
    public Optional getExternalDataObject(String id) {
        // Sanitise the given ID / title query
        id = SHERPAUtils.sanitiseQuery(id);

        // Search for publishers matching this ID in SHERPA. Limit to 1 result since this is for a single object
        SHERPAPublisherResponse sherpaResponse =
            sherpaService.performPublisherRequest("publisher", "id", "equals", id, 0, 1);

        // If there is at least one publisher, retrieve it and transform it to an ExternalDataObject
        if (CollectionUtils.isNotEmpty(sherpaResponse.getPublishers())) {
            SHERPAPublisher sherpaPublisher = sherpaResponse.getPublishers().get(0);
            // Construct external data object from returned publisher
            ExternalDataObject externalDataObject = constructExternalDataObjectFromSherpaPublisher(sherpaPublisher);
            return Optional.of(externalDataObject);
        }
        return Optional.empty();
    }

    /**
     * Search SHERPA v2 API for publisher results based on a 'contains word' query for publisher name
     * @param query The query for the search
     * @param start The start of the search
     * @param limit The max amount of records to be returned by the search
     * @return a list of external data objects
     */
    @Override
    public List searchExternalDataObjects(String query, int start, int limit) {
        // Search SHERPA for publishers with the query term in the title (name)
        SHERPAPublisherResponse sherpaResponse = sherpaService.performPublisherRequest(
            "publisher", "name", "contains word", query, start, limit);

        // If at least one publisher was found, convert to a list of ExternalDataObjects and return
        if (CollectionUtils.isNotEmpty(sherpaResponse.getPublishers())) {
            List list = sherpaResponse.getPublishers().stream().map(
                sherpaPublisher -> constructExternalDataObjectFromSherpaPublisher(sherpaPublisher)).collect(
                Collectors.toList());

            // Unlike the previous API version we can request offset and limit, so no need to build a
            // sublist from this list, we can just return the list.
            return list;
        }

        // Return an empty list if nothing was found
        return Collections.emptyList();
    }

    private ExternalDataObject constructExternalDataObjectFromSherpaPublisher(SHERPAPublisher sherpaPublisher) {
        ExternalDataObject externalDataObject = new ExternalDataObject();
        externalDataObject.setSource(sourceIdentifier);

        // Set publisher name
        if (StringUtils.isNotBlank(sherpaPublisher.getName())) {
            externalDataObject.addMetadata(new MetadataValueDTO(
                "dc", "title", null, null, sherpaPublisher.getName()));
            externalDataObject.setDisplayValue(sherpaPublisher.getName());
            externalDataObject.setValue(sherpaPublisher.getName());
        }
        // Set publisher ID
        if (StringUtils.isNotBlank(sherpaPublisher.getIdentifier())) {
            externalDataObject.setId(sherpaPublisher.getIdentifier());
            externalDataObject.addMetadata(new MetadataValueDTO(
                "dc", "identifier", "sherpaPublisher", null,
                sherpaPublisher.getIdentifier()));
        }

        // Set home URL
        if (StringUtils.isNotBlank(sherpaPublisher.getUri())) {
            externalDataObject.addMetadata(new MetadataValueDTO(
                "dc", "identifier", "other", null, sherpaPublisher.getUri()));
        }

        return externalDataObject;
    }

    @Override
    public boolean supports(String source) {
        return StringUtils.equalsIgnoreCase(sourceIdentifier, source);
    }

    /**
     * Get number of results returned from a SHERPA v2 publication search
     * @param query The query to be search on and give the total amount of results
     * @return int representing number of publisher results
     */
    @Override
    public int getNumberOfResults(String query) {
        // Search SHERPA for publishers with the query term in the title (name)
        // a limit of 0 means the limit parameter won't be added to the API query
        SHERPAPublisherResponse sherpaResponse = sherpaService.performPublisherRequest(
            "publication", "title", "contains word", query, 0, 0);

        // Return the number of publishers in the response object
        if (CollectionUtils.isNotEmpty(sherpaResponse.getPublishers())) {
            return sherpaResponse.getPublishers().size();
        }

        // If other checks have failed return 0
        return 0;
    }

    /**
     * Generic setter for the sourceIdentifier
     * @param sourceIdentifier   The sourceIdentifier to be set on this SHERPAv2PublisherDataProvider
     */
    public void setSourceIdentifier(String sourceIdentifier) {
        this.sourceIdentifier = sourceIdentifier;
    }

    /**
     * Generic setter for the SHERPA Service
     * @param sherpaService     THe SHERPA service to be set on this SHERPAv2PublisherDataProvider
     */
    public void setSherpaService(SHERPAService sherpaService) {
        this.sherpaService = sherpaService;
    }

}