org.dspace.sword.CommunityCollectionGenerator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dspace-sword Show documentation
DSpace SWORD Deposit Service Provider Extension
The newest version!
/**
 * 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.sword;

import java.util.List;

import org.apache.commons.lang3.StringUtils;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.dspace.content.Community;
import org.dspace.content.DSpaceObject;
import org.dspace.content.MetadataValue;
import org.dspace.content.factory.ContentServiceFactory;
import org.dspace.content.service.CommunityService;
import org.purl.sword.base.Collection;

public class CommunityCollectionGenerator extends ATOMCollectionGenerator {
    private static Logger log = LogManager.getLogger(CommunityCollectionGenerator.class);

    protected CommunityService communityService = ContentServiceFactory
        .getInstance().getCommunityService();

    public CommunityCollectionGenerator(SWORDService service) {
        super(service);
        log.debug("Created instance of CommunityCollectionGenerator");
    }

    public Collection buildCollection(DSpaceObject dso)
        throws DSpaceSWORDException {
        if (!(dso instanceof Community)) {
            log.error(
                "buildCollection passed something other than a Community object");
            throw new DSpaceSWORDException(
                "Incorrect ATOMCollectionGenerator instantiated");
        }

        // get the things we need out of the service
        SWORDConfiguration swordConfig = swordService.getSwordConfig();
        SWORDUrlManager urlManager = swordService.getUrlManager();

        Community com = (Community) dso;
        Collection scol = new Collection();

        // prepare the parameters to be put in the sword collection
        String location = urlManager.getDepositLocation(com);
        scol.setLocation(location);

        // collection title is just the community name
        String title = communityService.getName(com);
        if (StringUtils.isNotBlank(title)) {
            scol.setTitle(title);
        }

        // FIXME: the community has no obvious licence
        // the collection policy is the licence to which the collection adheres
        // String collectionPolicy = col.getLicense();

        // abstract is the short description of the collection
        List abstracts = communityService
            .getMetadataByMetadataString(com, "short_description");
        if (abstracts != null && !abstracts.isEmpty()) {
            String firstValue = abstracts.get(0).getValue();
            if (StringUtils.isNotBlank(firstValue)) {
                scol.setAbstract(firstValue);
            }
        }

        // do we support mediated deposit
        scol.setMediation(swordConfig.isMediated());

        // NOTE: for communities, there are no MIME types that it accepts.
        // the list of mime types that we accept

        // offer up the collections from this item as deposit targets
        String subService = urlManager.constructSubServiceUrl(com);
        scol.setService(subService);

        log.debug("Created ATOM Collection for DSpace Community");

        return scol;
    }
}