Metacat

/**

 *  '$RCSfile$'

 *  Copyright: 2000 Regents of the University of California and the

 *              National Center for Ecological Analysis and Synthesis

 *

 *   '$Author: leinfelder $'

 *     '$Date: 2013-03-12 16:44:41 -0700 (Tue, 12 Mar 2013) $'

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

package edu.ucsb.nceas.metacat.dataone;

import java.text.SimpleDateFormat;

import java.util.HashMap;

import org.apache.log4j.Logger;

import org.dataone.service.exceptions.InvalidRequest;

import org.dataone.service.exceptions.NotImplemented;

import org.dataone.service.exceptions.ServiceFailure;

import org.dataone.service.types.v1.Identifier;

import org.dataone.service.types.v1.Node;

import org.dataone.service.types.v1.SystemMetadata;

import edu.ucsb.nceas.ezid.EZIDException;

import edu.ucsb.nceas.ezid.EZIDService;

import edu.ucsb.nceas.ezid.profile.DataCiteProfile;

import edu.ucsb.nceas.ezid.profile.DataCiteProfileResourceTypeValues;

import edu.ucsb.nceas.ezid.profile.ErcMissingValueCode;

import edu.ucsb.nceas.ezid.profile.InternalProfile;

import edu.ucsb.nceas.ezid.profile.InternalProfileValues;

import edu.ucsb.nceas.metacat.properties.PropertyService;

import edu.ucsb.nceas.utilities.PropertyNotFoundException;

/**

 * 

 * Singleton for interacting with the EZID DOI library.

 * Allows DOI minting/initial registration, creating and updating 

 * existing DOI registrations.

 * 

 * @author leinfelder

 */

public class DOIService {

	private Logger logMetacat = Logger.getLogger(DOIService.class);

	private static DOIService instance = null;

	public static DOIService getInstance() {

		if (instance == null) {

			instance = new DOIService();

		}

		return instance;

	}

	/**

	 * Constructor, private for singleton access

	 */

	private DOIService() {

	}

	/**

	 * submits DOI metadata information about the object to EZID

	 * @param sysMeta

	 * @return

	 * @throws EZIDException 

	 * @throws ServiceFailure 

	 * @throws NotImplemented 

	 */

	public boolean registerDOI(SystemMetadata sysMeta) throws EZIDException, NotImplemented, ServiceFailure {

		// for DOIs

		String ezidUsername = null;

		String ezidPassword = null;

		String shoulder = null;

		boolean doiEnabled = false;

		try {

            doiEnabled = new Boolean(PropertyService.getProperty("guid.ezid.enabled")).booleanValue();

			shoulder = PropertyService.getProperty("guid.ezid.doishoulder.1");

			ezidUsername = PropertyService.getProperty("guid.ezid.username");

			ezidPassword = PropertyService.getProperty("guid.ezid.password");

		} catch (PropertyNotFoundException e) {

			logMetacat.warn("DOI support is not configured at this node.", e);

			return false;

		}

		// only continue if we have the feature turned on

		if (doiEnabled) {

			String identifier = sysMeta.getIdentifier().getValue();

			// only continue if this DOI is in our configured shoulder

			if (identifier.startsWith(shoulder)) {

				// enter metadata about this identifier

				HashMap<String, String> metadata = null;

				// login to EZID service

				String ezidServiceBaseUrl = null;

				try {

					ezidServiceBaseUrl = PropertyService.getProperty("guid.ezid.baseurl");

				} catch (PropertyNotFoundException e) {

					logMetacat.warn("Using default EZID baseUrl");

				}

				EZIDService ezid = new EZIDService(ezidServiceBaseUrl);

				ezid.login(ezidUsername, ezidPassword);

				// check for existing metadata

				boolean create = false;

				try {

					metadata = ezid.getMetadata(identifier);

				} catch (EZIDException e) {

					// expected much of the time

					logMetacat.warn("No metadata found for given identifier: " + e.getMessage());

				}

				if (metadata == null) {

					create = true;

				}

				// confuses the API if we send the original metadata that it gave us, so start from scratch

				metadata = new HashMap<String, String>();

				// TODO: set title and creator to better values

				Node node = MNodeService.getInstance(null).getCapabilities();

				SimpleDateFormat sdf = new SimpleDateFormat("yyyy");

				String year = sdf .format(sysMeta.getDateUploaded());

				metadata.put(DataCiteProfile.TITLE.toString(), ErcMissingValueCode.UNKNOWN.toString());

				metadata.put(DataCiteProfile.CREATOR.toString(), sysMeta.getRightsHolder().getValue());

				metadata.put(DataCiteProfile.PUBLISHER.toString(), node.getName());

				metadata.put(DataCiteProfile.PUBLICATION_YEAR.toString(), year);

				metadata.put(DataCiteProfile.RESOURCE_TYPE.toString(), DataCiteProfileResourceTypeValues.DATASET.toString() + "/" + sysMeta.getFormatId().getValue());

				metadata.put(InternalProfile.TARGET.toString(), node.getBaseURL() + "/v1/object/" + identifier);

				metadata.put(InternalProfile.STATUS.toString(), InternalProfileValues.PUBLIC.toString());

				metadata.put(InternalProfile.EXPORT.toString(), InternalProfileValues.YES.toString());

				// set using the API

				if (create) {

					ezid.createIdentifier(identifier, metadata);

				} else {

					ezid.setMetadata(identifier, metadata);

				}

				ezid.logout();

			}

		}

		return true;

	}

	/**

	 * Generate a DOI using the EZID service as configured

	 * @return

	 * @throws EZIDException 

	 * @throws InvalidRequest 

	 */

	public Identifier generateDOI() throws EZIDException, InvalidRequest {

		Identifier identifier = new Identifier();

		// look up configuration values

		String shoulder = null;

		String ezidUsername = null;

		String ezidPassword = null;

		boolean doiEnabled = false;

		try {

            doiEnabled = new Boolean(PropertyService.getProperty("guid.ezid.enabled")).booleanValue();

			shoulder = PropertyService.getProperty("guid.ezid.doishoulder.1");

			ezidUsername = PropertyService.getProperty("guid.ezid.username");

			ezidPassword = PropertyService.getProperty("guid.ezid.password");

		} catch (PropertyNotFoundException e1) {

			throw new InvalidRequest("2193", "DOI shoulder is not configured at this node.");

		}

		// only continue if we have the feature turned on

		if (!doiEnabled) {

			throw new InvalidRequest("2193", "DOI scheme is not enabled at this node.");

		}

		// add only the minimal metadata required for this DOI

		HashMap<String, String> metadata = new HashMap<String, String>();

		metadata.put(DataCiteProfile.TITLE.toString(), ErcMissingValueCode.UNKNOWN.toString());

		metadata.put(DataCiteProfile.CREATOR.toString(), ErcMissingValueCode.UNKNOWN.toString());

		metadata.put(DataCiteProfile.PUBLISHER.toString(), ErcMissingValueCode.UNKNOWN.toString());

		metadata.put(DataCiteProfile.PUBLICATION_YEAR.toString(), ErcMissingValueCode.UNKNOWN.toString());

		metadata.put(InternalProfile.STATUS.toString(), InternalProfileValues.RESERVED.toString());

		metadata.put(InternalProfile.EXPORT.toString(), InternalProfileValues.NO.toString());

		// call the EZID service

		String ezidServiceBaseUrl = null;

		try {

			ezidServiceBaseUrl = PropertyService.getProperty("guid.ezid.baseurl");

		} catch (PropertyNotFoundException e) {

			logMetacat.warn("Using default EZID baseUrl");

		}

		EZIDService ezid = new EZIDService(ezidServiceBaseUrl);

		ezid.login(ezidUsername, ezidPassword);

		String doi = ezid.mintIdentifier(shoulder, metadata);

		identifier.setValue(doi);

		ezid.logout();

		return identifier;

	}

}