D-Net

{"type_source": "SVN", "goal": "package -U -T 4C source:jar", "url": "http://svn-public.driver.research-infrastructures.eu/driver/dnet40/modules/cnr-data-information-oai-publisher-common/trunk/", "deploy_repository": "dnet4-snapshots", "version": "4", "mail": "sandro.labruzzo@isti.cnr.it,michele.artini@isti.cnr.it, claudio.atzori@isti.cnr.it, alessia.bardi@isti.cnr.it", "deploy_repository_url": "http://maven.research-infrastructures.eu/nexus/content/repositories/dnet4-snapshots", "name": "cnr-data-information-oai-publisher-common"}

package eu.dnetlib.data.information.oai.publisher;

public enum OAIError {

	badArgument {

		@Override

		public String getMessage() {

			return "The request includes illegal arguments, is missing required arguments, includes a repeated argument, or values for arguments have an illegal syntax.";

		}

	},

	badVerb {

		@Override

		public String getMessage() {

			return "Value of the verb argument is not a legal OAI-PMH verb, the verb argument is missing, or the verb argument is repeated.";

		}

	},

	cannotDisseminateFormat {

		@Override

		public String getMessage() {

			return "The metadata format identified by the value given for the metadataPrefix argument is not supported by the item or by the repository.";

		}

	},

	idDoesNotExist {

		@Override

		public String getMessage() {

			return "The value of the identifier argument is unknown or illegal in this repository.";

		}

	},

	noMetadataFormats {

		@Override

		public String getMessage() {

			return "There are no metadata formats available for the specified item.";

		}

	},

	noSetHierarchy {

		@Override

		public String getMessage() {

			return "The repository does not support sets.";

		}

	},

	noRecordsMatch {

		@Override

		public String getMessage() {

			return "The combination of the values of the from, until, set and metadataPrefix arguments results in an empty list.";

		}

	},

	badResumptionToken {

		@Override

		public String getMessage() {

			return "The value of the resumptionToken argument is invalid or expired.";

		}

	};

	public abstract String getMessage();

}

package eu.dnetlib.data.information.oai.publisher;

import eu.dnetlib.data.information.oai.publisher.OAIController.DELETED_SUPPORT;

public class OAIProperties {

	/**

	 * forwarded url header name, default "X-Forwarded-Url".

	 */

	private String forwardedUrlHeaderName = "X-Forwarded-Url";

	/**

	 * optional base url. If present it overrides the X-Forwarded-Url.

	 */

	private String baseUrl;

	private String repoName = "Driver Service for supporting Open Archive Initiative requests";

	private String repoEmail = "artini@isti.cnr.it";

	private String earliestDatestamp = "1970-01-01";

	private DELETED_SUPPORT deletedRecordSupport;

	private String dateGranularity = "YYYY-MM-DD";

	public String getBaseUrl() {

		return baseUrl;

	}

	public void setBaseUrl(String baseUrl) {

		this.baseUrl = baseUrl;

	}

	public String getRepoName() {

		return repoName;

	}

	public void setRepoName(String repoName) {

		this.repoName = repoName;

	}

	public String getRepoEmail() {

		return repoEmail;

	}

	public void setRepoEmail(String repoEmail) {

		this.repoEmail = repoEmail;

	}

	public String getEarliestDatestamp() {

		return earliestDatestamp;

	}

	public void setEarliestDatestamp(String earliestDatestamp) {

		this.earliestDatestamp = earliestDatestamp;

	}

	public String getDeletedRecordSupport() {

		return deletedRecordSupport.toString();

	}

	public void setDeletedRecordSupport(String deletedRecordSupport) {

		this.deletedRecordSupport = DELETED_SUPPORT.valueOf(deletedRecordSupport.trim().toUpperCase());

	}

	public String getDateGranularity() {

		return dateGranularity;

	}

	public void setDateGranularity(String dateGranularity) {

		this.dateGranularity = dateGranularity;

	}

	public String getForwardedUrlHeaderName() {

		return forwardedUrlHeaderName;

	}

	public void setForwardedUrlHeaderName(String forwardedUrlHeaderName) {

		this.forwardedUrlHeaderName = forwardedUrlHeaderName;

	}

}

package eu.dnetlib.data.information.oai.publisher;

import javax.xml.ws.WebFault;

import eu.dnetlib.common.rmi.RMIException;

/**

 * OAI publisher specific exception.

 * 

 * @author michele

 * 

 */

@WebFault

public class OaiPublisherException extends RMIException {

	/**

	 * serialization.

	 */

	private static final long serialVersionUID = 6833698764790681184L;

	/**

	 * Creates an exception.

	 * 

	 * @param e

	 *            exception

	 */

	public OaiPublisherException(final Throwable e) {

		super(e);

	}

	/**

	 * Creates an exception.

	 * 

	 * @param message

	 *            message

	 * @param e

	 *            exception

	 */

	public OaiPublisherException(final String message, final Throwable e) {

		super(message, e);

	}

	/**

	 * Creates an exception.

	 * 

	 * @param message

	 *            message

	 */

	public OaiPublisherException(final String message) {

		super(message);

	}

}

package eu.dnetlib.data.information.oai.publisher.core;

import java.util.List;

import javax.annotation.Resource;

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

import org.springframework.beans.factory.annotation.Autowired;

import eu.dnetlib.data.information.oai.publisher.CannotDisseminateFormatException;

import eu.dnetlib.data.information.oai.publisher.OaiPublisherException;

import eu.dnetlib.data.information.oai.publisher.conf.ISLookUpClient;

import eu.dnetlib.data.information.oai.publisher.conf.OAIConfigurationExistReader;

import eu.dnetlib.data.information.oai.publisher.info.ListDocumentsInfo;

import eu.dnetlib.data.information.oai.publisher.info.ListRecordsInfo;

import eu.dnetlib.data.information.oai.publisher.info.MDFInfo;

import eu.dnetlib.data.information.oai.publisher.info.RecordInfo;

import eu.dnetlib.data.information.oai.publisher.info.ResumptionToken;

import eu.dnetlib.data.information.oai.publisher.info.SetInfo;

import eu.dnetlib.data.information.oai.sets.SetCollection;

import eu.dnetlib.miscutils.cache.EhCache;

/**

 * Core OAI servlet implementation.

 * 

 * @author michele,alessia

 * 

 */

public abstract class AbstractOAICore {

	private static final Log log = LogFactory.getLog(AbstractOAICore.class); // NOPMD by marko on 11/24/08 5:02 PM

	private String currentDBName;

	@Autowired

	private SetCollection setCollection;

	@Autowired

	private OAIConfigurationExistReader oaiConfigurationExistReader;

	@Autowired

	private ISLookUpClient lookupClient;

	@Resource

	private EhCache<String, MDFInfo> mdFormatsCache;

	/**

	 * page size.

	 */

	protected int pageSize = 100;

	/**

	 * Returns informations about a record. It contains basic information about a record, such as "prefix", "identifier", "datestamp",

	 * "setspec", "metadata".

	 * 

	 * @param identifier

	 *            record identifier

	 * @param prefix

	 *            metadata prefix

	 * @return a recordInfo instance

	 * @throws OaiPublisherException

	 *             could happen

	 */

	public RecordInfo getInfoRecord(final String identifier, final String prefix) throws OaiPublisherException {

		MDFInfo mdf = obtainMDFInfo(prefix);

		return getRecordById(mdf, identifier);

	}

	/**

	 * List records.

	 * 

	 * @param onlyIdentifiers

	 *            only return record identifiers

	 * @param metadataPrefix

	 *            metadata prefix

	 * @param set

	 *            set name

	 * @param from

	 *            from date

	 * @param until

	 *            to date

	 * @return ListRecordsInfo

	 * @throws OaiPublisherException

	 *             could happen

	 */

	public ListRecordsInfo listRecords(final boolean onlyIdentifiers, final String metadataPrefix, final String set, final String from, final String until)

			throws OaiPublisherException {

		final ListRecordsInfo res = new ListRecordsInfo();

		if (from != null) {

			res.setFrom(from);

			res.setWithSize(false);

		}

		if (until != null) {

			res.setUntil(until);

			res.setWithSize(false);

		}

		if (metadataPrefix != null) {

			res.setMetadataprefix(metadataPrefix);

		}

		if (set != null) {

			res.setSet(set);

		}

		ListDocumentsInfo documents = getDocuments(onlyIdentifiers, set, metadataPrefix, from, until);

		ResumptionToken resumptionToken = documents.getResumptionToken();

		int cursor = documents.getCursor();

		int nMaxElements = documents.getnMaxElements();

		if (onlyIdentifiers) {

			res.setIdentifiers(documents.getDocs());

		} else {

			res.setDocuments(documents.getDocs());

		}

		if ((resumptionToken != null)) {

			res.setResumptiontoken(resumptionToken.serialize());

			res.setCursor(cursor);

			res.setSize(nMaxElements);

		}

		return res;

	}

	/**

	 * List records.

	 * 

	 * @param onlyIdentifiers

	 *            only resource identifiers.

	 * @param resumptionTokenParameter

	 *            resumption token

	 * @return ListRecordsInfo

	 * @throws OaiPublisherException

	 *             could happen

	 */

	public ListRecordsInfo listRecords(final boolean onlyIdentifiers, final String resumptionToken) throws OaiPublisherException {

		ListDocumentsInfo docs = getDocuments(onlyIdentifiers, resumptionToken);

		final ListRecordsInfo res = new ListRecordsInfo();

		if (docs.getMetadataPrefix() != null) {

			res.setMetadataprefix(docs.getMetadataPrefix());

		}

		if (onlyIdentifiers) {

			res.setIdentifiers(docs.getDocs());

		} else {

			res.setDocuments(docs.getDocs());

		}

		ResumptionToken newResumptionToken = docs.getResumptionToken();

		if ((newResumptionToken != null)) {

			res.setResumptiontoken(newResumptionToken.serialize());

			res.setCursor(docs.getCursor());

			res.setSize(docs.getnMaxElements());

			res.setWithSize(!newResumptionToken.hasDateRange());

		}

		return res;

	}

	public List<? extends SetInfo> listSets() throws OaiPublisherException {

		return this.setCollection.getAllSets(true, getCurrentDBName());

	}

	public List<MDFInfo> listMetadataFormats() throws OaiPublisherException {

		return this.oaiConfigurationExistReader.getMetadataFormatInfo(true);

	}

	public boolean existSet(final String setSpec) {

		return this.setCollection.containEnabledSet(setSpec, getCurrentDBName());

	}

	protected MDFInfo obtainMDFInfo(final String metadataPrefix) throws OaiPublisherException {

		MDFInfo mdf = this.mdFormatsCache.get(metadataPrefix);

		if (mdf == null) {

			log.fatal("Not using cache for " + metadataPrefix);

			mdf = oaiConfigurationExistReader.getMetadataFormatInfo(metadataPrefix);

			if (mdf == null) throw new CannotDisseminateFormatException("Invalid metadataPrefix " + metadataPrefix);

			this.mdFormatsCache.put(metadataPrefix, mdf);

		}

		return mdf;

	}

	/**

	 * Set the current DB from the configuration on the IS.

	 */

	public void setCurrentDBFromIS() throws OaiPublisherException {

		try {

			currentDBName = getLookupClient().getCurrentDB();

		} catch (Exception e) {

			throw new OaiPublisherException(e);

		}

	}

	protected abstract RecordInfo getRecordById(final MDFInfo mdf, final String id) throws OaiPublisherException;

	protected abstract ListDocumentsInfo getDocuments(final boolean onlyIdentifiers,

			final String set,

			final String metadataPrefix,

			final String from,

			final String until) throws OaiPublisherException;

	protected abstract ListDocumentsInfo getDocuments(final boolean onlyIdentifiers, final String resumptionToken) throws OaiPublisherException;

	public String getCurrentDBName() {

		return currentDBName;

	}

	public void setCurrentDBName(final String currentDBName) {

		this.currentDBName = currentDBName;

	}

	public SetCollection getSetCollection() {

		return setCollection;

	}

	public void setSetCollection(final SetCollection setCollection) {

		this.setCollection = setCollection;

	}

	public OAIConfigurationExistReader getOaiConfigurationExistReader() {

		return oaiConfigurationExistReader;

	}

	public void setOaiConfigurationExistReader(final OAIConfigurationExistReader oaiConfigurationExistReader) {

		this.oaiConfigurationExistReader = oaiConfigurationExistReader;

	}

	public ISLookUpClient getLookupClient() {

		return lookupClient;

	}

	public void setLookupClient(final ISLookUpClient lookupClient) {

		this.lookupClient = lookupClient;

	}

	public EhCache<String, MDFInfo> getMdFormatsCache() {

		return mdFormatsCache;

	}

	public void setMdFormatsCache(final EhCache<String, MDFInfo> mdFormatsCache) {

		this.mdFormatsCache = mdFormatsCache;

	}

}

package eu.dnetlib.data.information.oai.publisher;

public class OaiPublisherRuntimeException extends RuntimeException {

	/**

	 * 

	 */

	private static final long serialVersionUID = -4295850381530160166L;

	public OaiPublisherRuntimeException() {

		super();

	}

	public OaiPublisherRuntimeException(final Throwable e) {

		super(e);

	}

	public OaiPublisherRuntimeException(final String msg, final Throwable e) {

		super(msg, e);

	}

	public OaiPublisherRuntimeException(final String msg) {

		super(msg);

	}

}

package eu.dnetlib.data.information.oai.publisher;

import java.text.SimpleDateFormat;

import java.util.*;

import java.util.Map.Entry;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import eu.dnetlib.data.information.oai.publisher.core.AbstractOAICore;

import eu.dnetlib.data.information.oai.publisher.info.ListRecordsInfo;

import eu.dnetlib.data.information.oai.publisher.info.RecordInfo;

import org.apache.commons.lang.StringUtils;

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.stereotype.Controller;

import org.springframework.ui.ModelMap;

import org.springframework.web.bind.annotation.ModelAttribute;

import org.springframework.web.bind.annotation.RequestMapping;

/**

 * OAI Servlet.

 * 

 * @author michele

 * 

 */

@Controller

public final class OAIController {

	public enum OAI_VERBS {

		IDENTIFY, LIST_IDENTIFIERS, LIST_RECORDS, LIST_METADATA_FORMATS, LIST_SETS, GET_RECORD, UNSUPPORTED_VERB;

		public static OAI_VERBS getVerb(final String theVerb) {

			if (StringUtils.isBlank(theVerb)) return UNSUPPORTED_VERB;

			if (theVerb.equalsIgnoreCase("Identify")) return IDENTIFY;

			if (theVerb.equalsIgnoreCase("ListIdentifiers")) return LIST_IDENTIFIERS;

			if (theVerb.equalsIgnoreCase("ListRecords")) return LIST_RECORDS;

			if (theVerb.equalsIgnoreCase("ListMetadataFormats")) return LIST_METADATA_FORMATS;

			if (theVerb.equalsIgnoreCase("ListSets")) return LIST_SETS;

			if (theVerb.equalsIgnoreCase("GetRecord")) return GET_RECORD;

			if (theVerb.equalsIgnoreCase("listidentifiers")) return LIST_IDENTIFIERS;

			return UNSUPPORTED_VERB;

		}

	}

	public enum DELETED_SUPPORT {

		NO, TRANSIENT, PERSISTENT;

		@Override

		public String toString() {

			switch (this) {

			case TRANSIENT:

				return "transient";

			case PERSISTENT:

				return "persistent";

			default:

				return "no";

			}

		}

	}

	/**

	 * logger.

	 */

	private static final Log log = LogFactory.getLog(OAIController.class); // NOPMD by marko on 11/24/08 5:02 PM

	/**

	 * Default content type.

	 */

	private static final String DEFAULT_CONTENT_TYPE = "text/xml;charset=utf-8";

	/**

	 * OAI servlet core. Most of the logic is here

	 */

	@Autowired

	private AbstractOAICore core;

	@Autowired

	private OAIProperties oaiProperties;

	@RequestMapping("/oai/clearCaches.do")

	public void clearOaiCaches() throws OaiPublisherException {

		core.getMdFormatsCache().clear();

		core.setCurrentDBFromIS();

		core.getLookupClient().evictCaches();

	}

	@RequestMapping("/oai/oai.do")

	public String oai(final ModelMap map, final HttpServletRequest request, final HttpServletResponse response) throws Exception {

		response.setContentType(OAIController.DEFAULT_CONTENT_TYPE);

		String theVerb = "";

		try {

			final Map<String, String> params = cleanParameters(request.getParameterMap());

			if (params == null) return oaiError(OAIError.badArgument, map);

			theVerb = params.get("verb");

			OAI_VERBS requestedVerb = OAI_VERBS.getVerb(theVerb);

			switch (requestedVerb) {

			case IDENTIFY:

				return oaiIdentify(params, map);

			case LIST_METADATA_FORMATS:

				return oaiListMetadataFormats(params, map);

			case LIST_SETS:

				return oaiListSets(params, map);

			case GET_RECORD:

				return oaiGetRecord(params, map);

			case LIST_IDENTIFIERS:

				return oaiListIdentifiersOrRecords(params, map);

			case LIST_RECORDS:

				return oaiListIdentifiersOrRecords(params, map);

			default:

				return oaiError(OAIError.badVerb, map);

			}

		} catch (final CannotDisseminateFormatException e) {

			log.debug("ERROR", e);

			return oaiError(OAIError.cannotDisseminateFormat, theVerb, map);

		} catch (final NoRecordsMatchException e) {

			log.debug("ERROR", e);

			return oaiError(OAIError.noRecordsMatch, theVerb, map);

		} catch (final BadResumptionTokenException e) {

			log.debug("ERROR", e);

			return oaiError(OAIError.badResumptionToken, theVerb, map);

		} catch (final Exception e) {

			log.error("ERROR", e);

			return oaiError(e, map);

		}

	}

	private Map<String, String> cleanParameters(final Map<?, ?> startParams) {

		final HashMap<String, String> params = new HashMap<String, String>();

		final Iterator<?> iter = startParams.entrySet().iterator();

		while (iter.hasNext()) {

			final Entry<?, ?> entry = (Entry<?, ?>) iter.next();

			final String key = entry.getKey().toString();

			final String[] arr = (String[]) entry.getValue();

			if (arr.length == 0) return null;

			final String value = arr[0];

			if (key.equals("verb")) {

				params.put("verb", value);

			} else if (key.equals("from")) {

				params.put("from", value);

			} else if (key.equals("until")) {

				params.put("until", value);

			} else if (key.equals("metadataPrefix")) {

				params.put("metadataPrefix", value);

			} else if (key.equals("identifier")) {

				params.put("identifier", value);

			} else if (key.equals("set")) {

				params.put("set", value);

			} else if (key.equals("resumptionToken")) {

				params.put("resumptionToken", value);

			} else return null;

		}

		return params;

	}

	private String oaiIdentify(final Map<String, String> params, final ModelMap map) throws Exception {

		String verb = null;

		if (params.containsKey("verb")) {

			verb = params.get("verb");

			params.remove("verb");

		}

		if (params.entrySet().size() > 0) return oaiError(OAIError.badArgument, verb, map);

		return "oai/OAI_Identify";

	}

	private String oaiGetRecord(final Map<String, String> params, final ModelMap map) throws Exception {

		String verb = null;

		String prefix = null;

		String identifier = null;

		if (params.containsKey("verb")) {

			verb = params.get("verb");

			params.remove("verb");

		}

		if (params.containsKey("metadataPrefix")) {

			prefix = params.get("metadataPrefix");

			params.remove("metadataPrefix");

		} else return oaiError(OAIError.badArgument, verb, map);

		if (params.containsKey("identifier")) {

			identifier = params.get("identifier");

			params.remove("identifier");

		} else return oaiError(OAIError.badArgument, verb, map);

		if (params.entrySet().size() > 0) return oaiError(OAIError.badArgument, verb, map);

		this.core.setCurrentDBFromIS();

		RecordInfo record = core.getInfoRecord(identifier, prefix);

		if (record == null) return oaiError(OAIError.idDoesNotExist, map);

		map.addAttribute("record", record);

		return "oai/OAI_GetRecord";

	}

	private String oaiListIdentifiersOrRecords(final Map<String, String> params, final ModelMap map) throws Exception {

		OAI_VERBS verb = null;

		String metadataPrefix = null;

		String resumptionToken = null;

		String set = null;

		String from = null;

		String until = null;

		if (params.containsKey("verb")) {

			verb = OAI_VERBS.getVerb(params.get("verb"));

			params.remove("verb");

		}

		if (params.containsKey("resumptionToken")) {

			resumptionToken = params.get("resumptionToken");

			params.remove("resumptionToken");

			this.core.setCurrentDBFromIS();

		} else {

			this.core.setCurrentDBFromIS();

			if (params.containsKey("metadataPrefix")) {

				metadataPrefix = params.get("metadataPrefix");

				params.remove("metadataPrefix");

			} else return oaiError(OAIError.badArgument, verb.toString(), map);

			if (params.containsKey("from")) {

				from = params.get("from");

				params.remove("from");

			}

			if (params.containsKey("until")) {

				until = params.get("until");

				params.remove("until");

			}

			if (params.containsKey("set")) {

				set = params.get("set");

				params.remove("set");

			}

		}

		if (params.entrySet().size() > 0) return oaiError(OAIError.badArgument, verb.toString(), map);

		if (StringUtils.isNotBlank(set) && !this.core.existSet(set)) return oaiError(OAIError.badArgument, verb.toString(), map);

		boolean onlyIdentifiers = true;

		if (verb == OAI_VERBS.LIST_RECORDS) {

			onlyIdentifiers = false;

		}

		ListRecordsInfo infos;

		if (StringUtils.isBlank(resumptionToken)) {

			infos = core.listRecords(onlyIdentifiers, metadataPrefix, set, from, until);

		} else {

			infos = core.listRecords(onlyIdentifiers, resumptionToken);

		}

		map.addAttribute("info", infos);

		if (verb == OAI_VERBS.LIST_RECORDS) return "oai/OAI_ListRecords";

		return "oai/OAI_ListIdentifiers";

	}

	private String oaiListSets(final Map<String, String> params, final ModelMap map) throws Exception {

		String verb = null;

		if (params.containsKey("verb")) {

			verb = params.get("verb");

			params.remove("verb");

		}

		if (params.entrySet().size() > 0) return oaiError(OAIError.badArgument, verb, map);

		this.core.setCurrentDBFromIS();

		map.addAttribute("sets", core.listSets());

		return "oai/OAI_ListSets";

	}

	private String oaiListMetadataFormats(final Map<String, String> params, final ModelMap map) throws Exception {

		String id = null;

		String verb = null;

		if (params.containsKey("verb")) {

			verb = params.get("verb");

			params.remove("verb");

		}

		if (params.containsKey("identifier")) {

			id = params.get("identifier");

			params.remove("identifier");

		}

		if (params.entrySet().size() > 0) return oaiError(OAIError.badArgument, verb, map);

		this.core.setCurrentDBFromIS();

		map.addAttribute("formats", core.listMetadataFormats());

		if (id != null) {

			map.addAttribute("identifier", id);

			return "oai/OAI_ListMetadataFormats_withid";

		}

		return "oai/OAI_ListMetadataFormats";

	}

	private String oaiError(final OAIError errCode, final String verb, final ModelMap map) throws Exception {

		if (StringUtils.isBlank(verb)) return oaiError(errCode, map);

		map.addAttribute("verb", verb);

		map.addAttribute("errcode", errCode.name());

		map.addAttribute("errmsg", errCode.getMessage());

		return "oai/OAI_Error";

	}

	private String oaiError(final OAIError errCode, final ModelMap map) throws Exception {

		map.addAttribute("errcode", errCode.name());

		map.addAttribute("errmsg", errCode.getMessage());

		return "oai/OAI_Error_noverb";

	}

	private String oaiError(final Exception e, final ModelMap map) throws Exception {

		map.addAttribute("errcode", "InternalException");

		map.addAttribute("errmsg", e.getMessage());

		return "oai/OAI_Error_noverb";

	}

	/*

	 * Default Attribute

	 */

	@ModelAttribute("url")

	public String url(final HttpServletRequest request) {

		String forwardedUrl = request.getHeader(getForwardedUrlHeaderName());

		String baseURL = getBaseUrl();

		if (StringUtils.isNotBlank(baseURL)) return baseURL;

		else if (StringUtils.isNotBlank(forwardedUrl)) return forwardedUrl;

		else return request.getRequestURL() + "";

	}

	/**

	 * Model attribute for the date of response.

	 * <p>

	 * According to OAI-PMH protocol, it must be in UTC with format YYYY-MM-DDThh:mm:ssZ, where Z is the time zone ('Z' for "Zulu Time",

	 * i.e. UTC).

	 * </p>

	 * <p>

	 * See http://www.openarchives.org/OAI/openarchivesprotocol.html#Dates

	 * </p>

	 */

	@ModelAttribute("date")

	public String date() {

		SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssZ");

		formatter.setTimeZone(TimeZone.getTimeZone("UTC"));

		String date = formatter.format(new Date());

		return date.replace("+0000", "Z");

	}

	@ModelAttribute("repoName")

	public String getRepoName() {

		return oaiProperties.getRepoName();

	}

	@ModelAttribute("email")

	public String getRepoEmail() {

		return oaiProperties.getRepoEmail();

	}

	@ModelAttribute("earliestDatestamp")

	public String getEarliestDatestamp() {

		return oaiProperties.getEarliestDatestamp();

	}

	public String getBaseUrl() {

		return oaiProperties.getBaseUrl();

	}

	public String getForwardedUrlHeaderName() {

		return oaiProperties.getForwardedUrlHeaderName();

	}

	@ModelAttribute("deletedRecord")

	public String getDeletedRecordSupport() {

		return oaiProperties.getDeletedRecordSupport();

	}

	@ModelAttribute("granularity")

	public String getDateGranularity() {

		return oaiProperties.getDateGranularity();

	}

}

<?xml version="1.0" encoding="UTF-8"?>

<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" 

         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/

         http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">

  <responseDate>$date$</responseDate>

  <request>$url$</request>

  <error code="$errcode$">$errmsg$</error>

</OAI-PMH>

CACHES CLEARED

<?xml version="1.0" encoding="UTF-8"?>

<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" 

         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/

         http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">

 	<responseDate>$date$</responseDate>

	<request verb="ListMetadataFormats">$url$</request>

 	<ListMetadataFormats>

	$formats:{

		<metadataFormat>

			<metadataPrefix>$it.prefix$</metadataPrefix>

			<schema>$it.schema$</schema>

			<metadataNamespace>$it.namespace$</metadataNamespace>

		</metadataFormat>

	}$

	</ListMetadataFormats>

</OAI-PMH>

<?xml version="1.0" encoding="UTF-8"?>

<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" 

         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/

         http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">

  <responseDate>$date$</responseDate>

  <request verb="$verb$">$url$</request>

  <error code="$errcode$">$errmsg$</error>

</OAI-PMH>

<?xml version="1.0" encoding="UTF-8"?>

<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/"

	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

	xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/

         http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">

<responseDate>$date$</responseDate>

<request verb="ListSets">$url$</request>

<ListSets>

$sets:{

<set>

	<setSpec>$it.setSpec$</setSpec>

	<setName>$it.setName$</setName>

	$if(it.setDescription)$

	<setDescription>

		<oaidc:dc xmlns:oaidc="http://www.openarchives.org/OAI/2.0/oai_dc/" 

  			xmlns="http://purl.org/dc/elements/1.1/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

        	xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd">

        	<description>$it.setDescription$</description>

    	</oaidc:dc>

	</setDescription>

	$endif$

</set>

}$

</ListSets>

</OAI-PMH>

<?xml version="1.0" encoding="UTF-8"?>

<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/"

	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

	xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">

<responseDate>$date$</responseDate>

<request verb="Identify">$url$</request>

<Identify>

<repositoryName>$repoName$</repositoryName>

<baseURL>$url$</baseURL>

<protocolVersion>2.0</protocolVersion>

<adminEmail>$email$</adminEmail>

<earliestDatestamp>$earliestDatestamp$</earliestDatestamp>

<deletedRecord>$deletedRecord$</deletedRecord>

<granularity>$granularity$</granularity>

</Identify>

</OAI-PMH>

<?xml version="1.0" encoding="UTF-8"?>

<oai:OAI-PMH xmlns:oai="http://www.openarchives.org/OAI/2.0/"

	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

	xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/

         http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">

	<oai:responseDate>$date$</oai:responseDate>

	<oai:request verb="ListRecords" $info.from$ $info.until$ $info.metadataprefix$ $info.set$>$url$</oai:request>

	<oai:ListRecords>

	$info.documents:{

	<oai:record>

        $if(it.deleted)$

		<oai:header status="deleted">

		$else$

		<oai:header>

		$endif$

			<oai:identifier>$it.identifier$</oai:identifier>

					<oai:datestamp>$it.normalizedDatestamp$</oai:datestamp>

            $it.setspecs:{set|

			<oai:setSpec>$set$</oai:setSpec>

			}$

            </oai:header>

            $if(!it.deleted)$

            <oai:metadata>

			 $it.metadata$ 

			</oai:metadata>

			$endif$

			$if(it.provenance)$

        	<oai:about>$it.provenance$</oai:about>

        	$endif$

		</oai:record>

	}$

	$if(info.resumptiontoken)$

	<oai:resumptionToken cursor="$info.cursor$" 

	$if(info.withSize)$

		completeListSize="$info.size$" 

	$endif$ 

	>$info.resumptiontoken$</oai:resumptionToken>

$endif$

</oai:ListRecords>

</oai:OAI-PMH>

<?xml version="1.0" encoding="UTF-8"?>

<oai:OAI-PMH xmlns:oai="http://www.openarchives.org/OAI/2.0/"

	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

	xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/

				http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">

<oai:responseDate>$date$</oai:responseDate>

<oai:request verb="GetRecord" identifier="$record.identifier$"

	metadataPrefix="$record.prefix$">$url$</oai:request>

<oai:GetRecord>

<oai:record>

$if(record.deleted)$

	<oai:header status="deleted">

$else$

	<oai:header>

$endif$

	<oai:identifier>$record.identifier$</oai:identifier>

	<oai:datestamp>$record.normalizedDatestamp$</oai:datestamp>

	$record.setspecs:{set|

	<oai:setSpec>$set$</oai:setSpec>

	}$ 

</oai:header>

$if(!record.deleted)$

<oai:metadata>

	$record.metadata$ 

</oai:metadata>

$endif$

$if(record.provenance)$

<oai:about>

$record.provenance$

</oai:about>

$endif$

</oai:record>

</oai:GetRecord>

</oai:OAI-PMH>

<?xml version="1.0" encoding="UTF-8"?>

<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" 

         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/

         http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">

 	<responseDate>$date$</responseDate>

	<request verb="ListMetadataFormats" identifier="$identifier$">$url$</request>

 	<ListMetadataFormats>

	$formats:{

		<metadataFormat>

			<metadataPrefix>$it.prefix$</metadataPrefix>

			<schema>$it.schema$</schema>

			<metadataNamespace>$it.namespace$</metadataNamespace>

		</metadataFormat>

	}$

	</ListMetadataFormats>

</OAI-PMH>

<?xml version="1.0" encoding="UTF-8"?>

<oai:OAI-PMH xmlns:oai="http://www.openarchives.org/OAI/2.0/"

	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

	xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">

<oai:responseDate>$date$</oai:responseDate>

<oai:request verb="ListIdentifiers" $info.from$ $info.until$ $info.metadataprefix$ $info.set$>$url$</oai:request>

<oai:ListIdentifiers>

$info.identifiers:{

	$if(it.deleted)$ 

  	<oai:header status="deleted">

  	$else$

	<oai:header>

	$endif$

		<oai:identifier>$it.identifier$</oai:identifier>

		<oai:datestamp>$it.normalizedDatestamp$</oai:datestamp>

		$it.setspecs:{set|

		<oai:setSpec>$set$</oai:setSpec>

	}$ 

	</oai:header>

}$ 

$if(info.resumptiontoken)$

	<oai:resumptionToken cursor="$info.cursor$" 

	$if(info.withSize)$

		completeListSize="$info.size$" 

	$endif$ 

	>$info.resumptiontoken$</oai:resumptionToken>

$endif$

</oai:ListIdentifiers>

</oai:OAI-PMH>

<ehcache>

	<!-- Sets the path to the directory where cache .data files are created. 

		If the path is a Java System Property it is replaced by its value in the 

		running VM. The following properties are translated: user.home - User's home 

		directory user.dir - User's current working directory java.io.tmpdir - Default 

		temp file path -->

	<diskStore path="java.io.tmpdir" />

	<!--Default Cache configuration. These will applied to caches programmatically 

		created through the CacheManager. The following attributes are required for 

		defaultCache: maxInMemory - Sets the maximum number of objects that will 

		be created in memory eternal - Sets whether elements are eternal. If eternal, 

		timeouts are ignored and the element is never expired. timeToIdleSeconds 

		- Sets the time to idle for an element before it expires. i.e. The maximum 

		amount of time between accesses before an element expires Is only used if 

		the element is not eternal. Optional attribute. A value of 0 means that an 

		Element can idle for infinity timeToLiveSeconds - Sets the time to live for 

		an element before it expires. i.e. The maximum time between creation time 

		and when an element expires. Is only used if the element is not eternal. 

		overflowToDisk - Sets whether elements can overflow to disk when the in-memory 

		cache has reached the maxInMemory limit. -->

<!-- 	<defaultCache maxElementsInMemory="1000" overflowToDisk="true" -->

<!-- 		eternal="true" diskPersistent="false" timeToIdleSeconds="0" -->

<!-- 		timeToLiveSeconds="0" memoryStoreEvictionPolicy="LRU" -->

<!-- 		diskExpiryThreadIntervalSeconds="120" diskSpoolBufferSizeMB="5" /> -->

	<cache name="metadataFormats" maxElementsInMemory="10" eternal="false"

		timeToIdleSeconds="300" timeToLiveSeconds="500" overflowToDisk="false" />

</ehcache>

<?xml version="1.0" encoding="UTF-8"?>

<beans xmlns="http://www.springframework.org/schema/beans"

	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"

	xmlns:util="http://www.springframework.org/schema/util"

	xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd 

	http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util.xsd">

	<bean id="oaiCacheManager"

		class="org.springframework.cache.ehcache.EhCacheManagerFactoryBean"

		p:cacheManagerName="oaiCacheManger"

		p:configLocation="classpath:/eu/dnetlib/data/information/oai/cache/ehcache.xml" />

	<bean id="mdformatsEhCache" class="net.sf.ehcache.Cache"

		factory-bean="oaiCacheManager" factory-method="getCache">

		<constructor-arg value="metadataFormats" />

	</bean>

	<bean id="mdFormatsCache" class="eu.dnetlib.miscutils.cache.EhCache"

		p:cache-ref="mdformatsEhCache" />

</beans>

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

	<parent>

		<groupId>eu.dnetlib</groupId>

		<artifactId>dnet-parent</artifactId>

		<version>1.0.0-SNAPSHOT</version>

		<relativePath />

	</parent>

	<modelVersion>4.0.0</modelVersion>

	<groupId>eu.dnetlib</groupId>

	<artifactId>cnr-data-information-oai-publisher-common</artifactId>

	<packaging>jar</packaging>

	<version>5.2.1-SNAPSHOT</version>

	<scm>

		<developerConnection>scm:svn:https://svn.driver.research-infrastructures.eu/driver/dnet40/modules/cnr-data-information-oai-publisher-common/trunk</developerConnection>

	</scm>

	<dependencies>

		<dependency>

			<groupId>eu.dnetlib</groupId>

			<artifactId>dnet-oai-utils</artifactId>

			<version>[3.2.0,4.0.0)</version>

		</dependency>

		<dependency>

			<groupId>javax.servlet</groupId>

			<artifactId>javax.servlet-api</artifactId>

			<version>${javax.servlet.version}</version>

			<scope>provided</scope>

		</dependency>

	</dependencies>

</project>

{"type_source": "SVN", "goal": "package -U -T 4C source:jar", "url": "http://svn-public.driver.research-infrastructures.eu/driver/dnet40/modules/cnr-data-information-oai-publisher-common/trunk/", "deploy_repository": "dnet4-snapshots", "version": "4", "mail": "sandro.labruzzo@isti.cnr.it,michele.artini@isti.cnr.it, claudio.atzori@isti.cnr.it, alessia.bardi@isti.cnr.it", "deploy_repository_url": "http://maven.research-infrastructures.eu/nexus/content/repositories/dnet4-snapshots", "name": "cnr-data-information-oai-publisher-common"}

package eu.dnetlib.data.information.oai.publisher;

import eu.dnetlib.data.information.oai.publisher.OAIController.DELETED_SUPPORT;

public class OAIProperties {

	/**

	 * forwarded url header name, default "X-Forwarded-Url".

	 */

	private String forwardedUrlHeaderName = "X-Forwarded-Url";

	/**

	 * optional base url. If present it overrides the X-Forwarded-Url.

	 */

	private String baseUrl;

	private String repoName = "Driver Service for supporting Open Archive Initiative requests";

	private String repoEmail = "artini@isti.cnr.it";

	private String earliestDatestamp = "1970-01-01";

	private DELETED_SUPPORT deletedRecordSupport;

	private String dateGranularity = "YYYY-MM-DD";

	public String getBaseUrl() {

		return baseUrl;

	}

	public void setBaseUrl(String baseUrl) {

		this.baseUrl = baseUrl;

	}

	public String getRepoName() {

		return repoName;

	}

	public void setRepoName(String repoName) {

		this.repoName = repoName;

	}

	public String getRepoEmail() {

		return repoEmail;

	}

	public void setRepoEmail(String repoEmail) {

		this.repoEmail = repoEmail;

	}

	public String getEarliestDatestamp() {

		return earliestDatestamp;

	}

	public void setEarliestDatestamp(String earliestDatestamp) {

		this.earliestDatestamp = earliestDatestamp;

	}

	public String getDeletedRecordSupport() {

		return deletedRecordSupport.toString();

	}

	public void setDeletedRecordSupport(String deletedRecordSupport) {

		this.deletedRecordSupport = DELETED_SUPPORT.valueOf(deletedRecordSupport.trim().toUpperCase());

	}

	public String getDateGranularity() {

		return dateGranularity;

	}

	public void setDateGranularity(String dateGranularity) {

		this.dateGranularity = dateGranularity;

	}

	public String getForwardedUrlHeaderName() {

		return forwardedUrlHeaderName;

	}

	public void setForwardedUrlHeaderName(String forwardedUrlHeaderName) {

		this.forwardedUrlHeaderName = forwardedUrlHeaderName;

	}

}

package eu.dnetlib.data.information.oai.publisher;

import javax.xml.ws.WebFault;

import eu.dnetlib.common.rmi.RMIException;

/**

 * OAI publisher specific exception.

 * 

 * @author michele

 * 

 */

@WebFault

public class OaiPublisherException extends RMIException {

	/**

	 * serialization.

	 */

	private static final long serialVersionUID = 6833698764790681184L;

	/**

	 * Creates an exception.

	 * 

	 * @param e

	 *            exception

	 */

	public OaiPublisherException(final Throwable e) {

		super(e);

	}

	/**

	 * Creates an exception.

	 * 

	 * @param message

	 *            message

	 * @param e

	 *            exception

	 */

	public OaiPublisherException(final String message, final Throwable e) {

		super(message, e);

	}

	/**

	 * Creates an exception.

	 * 

	 * @param message

	 *            message

	 */

	public OaiPublisherException(final String message) {

		super(message);

	}

}

package eu.dnetlib.data.information.oai.publisher.core;

import java.util.List;

import javax.annotation.Resource;

import org.apache.commons.lang.StringUtils;

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

import org.springframework.beans.factory.annotation.Autowired;

import eu.dnetlib.data.information.oai.publisher.CannotDisseminateFormatException;

import eu.dnetlib.data.information.oai.publisher.OaiPublisherException;

import eu.dnetlib.data.information.oai.publisher.conf.ISLookUpClient;

import eu.dnetlib.data.information.oai.publisher.conf.OAIConfigurationExistReader;

import eu.dnetlib.data.information.oai.publisher.info.ListDocumentsInfo;

import eu.dnetlib.data.information.oai.publisher.info.ListRecordsInfo;

import eu.dnetlib.data.information.oai.publisher.info.MDFInfo;

import eu.dnetlib.data.information.oai.publisher.info.RecordInfo;

import eu.dnetlib.data.information.oai.publisher.info.ResumptionToken;

import eu.dnetlib.data.information.oai.publisher.info.SetInfo;

import eu.dnetlib.data.information.oai.sets.SetCollection;

import eu.dnetlib.miscutils.cache.EhCache;

/**

 * Core OAI servlet implementation.

 * 

 * @author michele,alessia

 * 

 */

public abstract class AbstractOAICore {

	private static final Log log = LogFactory.getLog(AbstractOAICore.class); // NOPMD by marko on 11/24/08 5:02 PM

	private String currentDBName;

	@Autowired

	private SetCollection setCollection;

	@Autowired

	private OAIConfigurationExistReader oaiConfigurationExistReader;

	@Autowired

	private ISLookUpClient lookupClient;

	@Resource

	private EhCache<String, MDFInfo> mdFormatsCache;

	/**

	 * page size.

	 */

	protected int pageSize = 100;

	/**

	 * Returns informations about a record. It contains basic information about a record, such as "prefix", "identifier", "datestamp",

	 * "setspec", "metadata".

	 * 

	 * @param identifier

	 *            record identifier

	 * @param prefix

	 *            metadata prefix

	 * @return a recordInfo instance

	 * @throws OaiPublisherException

	 *             could happen

	 */

	public RecordInfo getInfoRecord(final String identifier, final String prefix) throws OaiPublisherException {

		MDFInfo mdf = obtainMDFInfo(prefix);

		return getRecordById(mdf, identifier);

	}

	/**

	 * List records.

	 * 

	 * @param onlyIdentifiers

	 *            only return record identifiers

	 * @param metadataPrefix

	 *            metadata prefix

	 * @param set

	 *            set name

	 * @param from

	 *            from date

	 * @param until

	 *            to date

	 * @return ListRecordsInfo

	 * @throws OaiPublisherException

	 *             could happen

	 */

	public ListRecordsInfo listRecords(final boolean onlyIdentifiers, final String metadataPrefix, final String set, final String from, final String until)

			throws OaiPublisherException {

		final ListRecordsInfo res = new ListRecordsInfo();