ORG.oclc.oai.server.catalog.FolderOAICatalog Maven / Gradle / Ivy
/**
* Copyright 2006 OCLC Online Computer Library Center Licensed under the Apache
* License, Version 2.0 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or
* agreed to in writing, software distributed under the License is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and
* limitations under the License.
*/
package ORG.oclc.oai.server.catalog;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.Properties;
import java.util.Set;
import java.util.StringTokenizer;
import java.util.TreeMap;
import java.util.Vector;
import javax.servlet.ServletContext;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import org.apache.xpath.XPathAPI;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.InputSource;
import ORG.oclc.oai.server.verb.BadResumptionTokenException;
import ORG.oclc.oai.server.verb.CannotDisseminateFormatException;
import ORG.oclc.oai.server.verb.IdDoesNotExistException;
import ORG.oclc.oai.server.verb.NoItemsMatchException;
import ORG.oclc.oai.server.verb.NoMetadataFormatsException;
import ORG.oclc.oai.server.verb.NoSetHierarchyException;
import ORG.oclc.oai.util.OAIUtil;
/**
* NewFileSystemOAICatalog is an implementation of AbstractCatalog interface
* with the data sitting in a directory on a filesystem.
*
* @author Jeff Young, OCLC Online Computer Library Center
*/
public class FolderOAICatalog extends AbstractCatalog {
static final boolean debug=false;
private SimpleDateFormat dateFormatter = new SimpleDateFormat();
protected String homeDir;
private HashMap datestampMap = new HashMap();
private HashMap identifierMap = new HashMap();
private HashMap setMap = new HashMap();
private HashMap resumptionResults=new HashMap();
private int maxListSize;
private ArrayList sets = null;
private ServletContext context = null;
public FolderOAICatalog(Properties properties, ServletContext context)
throws IOException {
this.context = context;
String temp;
dateFormatter.applyPattern("yyyy-MM-dd'T'HH:mm:ss'Z'");
temp=properties.getProperty("NewFileSystemOAICatalog.maxListSize");
if (temp==null)
throw new IllegalArgumentException("NewFileSystemOAICatalog."+
"maxListSize is missing from the properties file");
maxListSize = Integer.parseInt(temp);
if(debug)
System.out.println("in NewFileSystemOAICatalog(): maxListSize="+
maxListSize);
homeDir=properties.getProperty("NewFileSystemOAICatalog.homeDir");
if (homeDir!=null) {
if(debug)
System.out.println("in NewFileSystemOAICatalog(): homeDir="+
homeDir);
File homeFile = new File(homeDir);
int homeDirLen = homeFile.getPath().length()+1;
loadFileMap(homeDirLen, homeFile);
} else {
/* Try looking in a known location */
Set resourcePaths = context.getResourcePaths("/WEB-INF/DATA/");
if (resourcePaths == null || resourcePaths.size() == 0) {
throw new IllegalArgumentException("NewFileSystemOAICatalog."+
"homeDir is missing from the properties file");
}
String earliestDatestamp = loadFileMap(context, resourcePaths);
properties.setProperty("Identify.earliestDatestamp", earliestDatestamp);
}
// Iterator iterator = datestampMap.entrySet().iterator();
// while (iterator.hasNext()) {
// Map.Entry entry = (Map.Entry)iterator.next();
// System.out.println(entry.getKey() + ":" + entry.getValue());
// }
sets = getSets(properties);
}
private static ArrayList getSets(Properties properties) {
InputStream is = Thread.currentThread().getContextClassLoader()
.getResourceAsStream("sets.properties");
Properties setProps = new Properties();
try {
setProps.load(is);
} catch (Exception e) {
e.printStackTrace();
}
TreeMap treeMap = new TreeMap();
Enumeration propNames = setProps.propertyNames();
while (propNames.hasMoreElements()) {
String propertyName = (String)propNames.nextElement();
String s = new StringBuffer("")
.append(OAIUtil.xmlEncode(propertyName))
.append(" ")
.append(OAIUtil.xmlEncode((String) setProps.get(propertyName)))
.append(" = 0
&& fileDate.compareTo(until) <= 0
&& (setIdentifiers == null || setIdentifiers.contains(path))) {
Document nativeRecord = getNativeRecord((String)entryDateMap.getKey());
String[] header = getRecordFactory().createHeader(nativeRecord);
headers.add(header[0]);
identifiers.add(header[1]);
count++;
}
}
if (count == 0)
throw new NoItemsMatchException();
/* decide if you're done */
if (iterator.hasNext()) {
String resumptionId = getRSName();
resumptionResults.put(resumptionId, iterator);
/*****************************************************************
* Construct the resumptionToken String however you see fit.
*****************************************************************/
StringBuffer resumptionTokenSb = new StringBuffer();
resumptionTokenSb.append(resumptionId);
resumptionTokenSb.append(":");
resumptionTokenSb.append(Integer.toString(count));
resumptionTokenSb.append(":");
resumptionTokenSb.append(Integer.toString(numRows));
resumptionTokenSb.append(":");
resumptionTokenSb.append(metadataPrefix);
resumptionTokenSb.append(":");
resumptionTokenSb.append(set);
/*****************************************************************
* Use the following line if you wish to include the optional
* resumptionToken attributes in the response. Otherwise, use the
* line after it that I've commented out.
*****************************************************************/
listIdentifiersMap.put("resumptionMap",
getResumptionMap(resumptionTokenSb.toString(),
numRows,
0));
// listIdentifiersMap.put("resumptionMap",
// getResumptionMap(resumptionTokenSb.toString()));
}
listIdentifiersMap.put("headers", headers.iterator());
listIdentifiersMap.put("identifiers", identifiers.iterator());
return listIdentifiersMap;
}
/**
* Retrieve the next set of Identifiers associated with the resumptionToken
*
* @param resumptionToken implementation-dependent format taken from the
* previous listIdentifiers() Map result.
* @return a Map object containing an optional "resumptionToken" key/value
* pair and an "identifiers" Map object. The "identifiers" Map contains OAI
* identifier keys with corresponding values of "true" or null depending on
* whether the identifier is deleted or not.
* @exception OAIBadRequestException signals an http status code 400
* problem
*/
public Map listIdentifiers(String resumptionToken)
throws BadResumptionTokenException {
purge(); // clean out old resumptionTokens
Map listIdentifiersMap = new HashMap();
ArrayList headers = new ArrayList();
ArrayList identifiers = new ArrayList();
/**********************************************************************
* parse your resumptionToken and look it up in the resumptionResults,
* if necessary
**********************************************************************/
StringTokenizer tokenizer = new StringTokenizer(resumptionToken, ":");
String resumptionId;
int oldCount;
String metadataPrefix;
int numRows;
String set;
try {
resumptionId = tokenizer.nextToken();
oldCount = Integer.parseInt(tokenizer.nextToken());
numRows = Integer.parseInt(tokenizer.nextToken());
metadataPrefix = tokenizer.nextToken();
set = tokenizer.nextToken();
} catch (NoSuchElementException e) {
throw new BadResumptionTokenException();
}
/* Get some more records from your database */
Iterator iterator = (Iterator)resumptionResults.remove(resumptionId);
if (iterator == null) {
System.out.println("NewFileSystemOAICatalog.listIdentifiers: reuse of old resumptionToken?");
iterator = datestampMap.entrySet().iterator();
for (int i = 0; i © 2015 - 2025 Weber Informatics LLC | Privacy Policy