java.fedora.server.storage.translation.METSLikeDOSerializer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of fcrepo-client Show documentation
Show all versions of fcrepo-client Show documentation
The Fedora Client is a Java Library that allows API access to a Fedora Repository. The client is typically one part of a full Fedora installation.
The newest version!
/*
* -----------------------------------------------------------------------------
*
* License and Copyright: The contents of this file are subject to 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.fedora-commons.org/licenses.
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
* the specific language governing rights and limitations under the License.
*
* The entire file consists of original code.
* Copyright © 2008 Fedora Commons, Inc.
*
Copyright © 2002-2007 The Rector and Visitors of the University of
* Virginia and Cornell University
* All rights reserved.
*
* -----------------------------------------------------------------------------
*/
package fedora.server.storage.translation;
import java.io.IOException;
import java.io.OutputStream;
import java.io.UnsupportedEncodingException;
import java.util.Date;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.apache.log4j.Logger;
import fedora.server.errors.ObjectIntegrityException;
import fedora.server.errors.StreamIOException;
import fedora.server.errors.StreamWriteException;
import fedora.server.storage.types.AuditRecord;
import fedora.server.storage.types.DigitalObject;
import fedora.server.storage.types.Datastream;
import fedora.server.storage.types.DatastreamXMLMetadata;
import fedora.server.storage.types.Disseminator;
import fedora.server.storage.types.DSBinding;
import fedora.server.utilities.DateUtility;
import fedora.server.utilities.StreamUtility;
import fedora.server.utilities.StringUtility;
/**
* Creates an XML serialization of a Fedora digital object
* in accordance with the Fedora extension of the METS XML Schema
* defined at: http://www.fedora.info/definitions/1/0/mets-fedora-ext.xsd.
*
* The serializer uses the currently instantiated digital object
* as input (see fedora.server.storage.types.DigitalObject).
*
* The serializer will adapt its output to a specific translation contexts.
* See the static definitions of different translation contexts in
* fedora.server.storage.translation.DOTranslationUtility.
*
* @author [email protected]
* @author [email protected]
* @version $Id: METSLikeDOSerializer.java 6618 2008-02-19 12:17:43Z cwilper $
*/
public class METSLikeDOSerializer
implements DOSerializer {
/** Logger for this class. */
private static final Logger LOG = Logger.getLogger(
METSLikeDOSerializer.class.getName());
public static final String FEDORA_AUDIT_NS="info:fedora/fedora-system:def/audit#";
public static final String METS_PREFIX="METS";
public static final String METS_NS="http://www.loc.gov/METS/";
public static final String METS_XSD_LOCATION="http://www.fedora.info/definitions/1/0/mets-fedora-ext.xsd";
public static final String METS_XLINK_NS="http://www.w3.org/TR/xlink";
public static final String REAL_XLINK_NS="http://www.w3.org/TR/xlink";
public static final String XSI_NS="http://www.w3.org/2001/XMLSchema-instance";
private String m_XLinkPrefix="xlink";
private String m_fedoraAuditPrefix="audit";
private int m_transContext;
public METSLikeDOSerializer() {
}
public DOSerializer getInstance() {
return new METSLikeDOSerializer();
}
public void serialize(DigitalObject obj, OutputStream out, String encoding, int transContext)
throws ObjectIntegrityException, StreamIOException,
UnsupportedEncodingException {
LOG.debug("Serializing METS (Fedora extension)...");
m_transContext=transContext;
StringBuffer buf=new StringBuffer();
// Append sections to METS serialization buffer
appendXMLDeclaration(obj, encoding, buf);
appendRootElementStart(obj, buf);
appendHdr(obj, buf);
appendDescriptiveMD(obj, buf, encoding);
appendAuditRecordAdminMD(obj, buf);
appendOtherAdminMD(obj, buf, encoding);
appendFileSecs(obj, buf);
appendStructMaps(obj, buf);
appendDisseminators(obj, buf);
appendRootElementEnd(buf);
writeToStream(buf, out, encoding, true);
}
private void appendXMLDeclaration(DigitalObject obj, String encoding,
StringBuffer buf) {
buf.append("\n");
}
private void appendRootElementStart(DigitalObject obj, StringBuffer buf)
throws ObjectIntegrityException {
buf.append("<" + METS_PREFIX + ":mets xmlns:" + METS_PREFIX + "=\""
+ StreamUtility.enc(METS_NS) + "\"\n");
String indent=" ";
// make sure XSI_NS is mapped...
String xsiPrefix=(String) obj.getNamespaceMapping().get(XSI_NS);
if (xsiPrefix==null) {
xsiPrefix="fedoraxsi";
obj.getNamespaceMapping().put(XSI_NS, "fedoraxsi"); // 99.999999999% chance this is unique
}
appendNamespaceDeclarations(indent,obj.getNamespaceMapping(),buf);
// hardcode xsi:schemaLocation to definitive location for such.
buf.append(indent + xsiPrefix + ":schemaLocation=\"" + StreamUtility.enc(METS_NS) + " http://www.fedora.info/definitions/1/0/mets-fedora-ext.xsd\"\n");
if (obj.getPid()==null || obj.getPid().equals("")) {
throw new ObjectIntegrityException("Object must have a pid.");
}
buf.append(indent + "OBJID=\"" + obj.getPid() + "\" TYPE=\""
+ getTypeAttribute(obj) + "\"");
if (obj.getLabel()!=null && !obj.getLabel().equals("")) {
buf.append("\n" + indent + "LABEL=\"" + StreamUtility.enc(
obj.getLabel()) + "\"");
}
if (obj.getContentModelId()!=null && !obj.getContentModelId().equals("")) {
buf.append("\n" + indent + "PROFILE=\"" + StreamUtility.enc(
obj.getContentModelId()) + "\"");
}
buf.append(">\n");
}
private void appendNamespaceDeclarations(String prepend, Map URIToPrefix,
StringBuffer buf) {
Iterator iter=URIToPrefix.keySet().iterator();
while (iter.hasNext()) {
String URI=(String) iter.next();
String prefix=(String) URIToPrefix.get(URI);
if (!prefix.equals("")) {
if ( (URI.equals(METS_XLINK_NS)) || (URI.equals(REAL_XLINK_NS)) ) {
m_XLinkPrefix=prefix;
} else if (URI.equals(FEDORA_AUDIT_NS)) {
m_fedoraAuditPrefix=prefix;
} else if (!URI.equals(METS_NS)) {
buf.append(prepend + "xmlns:" + prefix + "=\""
+ StreamUtility.enc(URI) + "\"\n");
}
}
}
buf.append(prepend + "xmlns:" + m_XLinkPrefix + "=\""
+ REAL_XLINK_NS + "\"\n");
buf.append(prepend + "xmlns:" + m_fedoraAuditPrefix + "=\""
+ FEDORA_AUDIT_NS + "\"\n");
}
private String getTypeAttribute(DigitalObject obj)
throws ObjectIntegrityException {
int t=obj.getFedoraObjectType();
if (t==DigitalObject.FEDORA_BDEF_OBJECT) {
return "FedoraBDefObject";
} else if (t==DigitalObject.FEDORA_BMECH_OBJECT) {
return "FedoraBMechObject";
} else if (t==DigitalObject.FEDORA_OBJECT) {
return "FedoraObject";
} else {
throw new ObjectIntegrityException("Object must have a FedoraObjectType.");
}
}
private void appendHdr(DigitalObject obj, StringBuffer buf) {
buf.append(" <" + METS_PREFIX + ":metsHdr");
Date cDate=obj.getCreateDate();
if (cDate!=null) {
buf.append(" CREATEDATE=\"");
buf.append(DateUtility.convertDateToString(cDate));
buf.append("\"");
}
Date mDate=obj.getLastModDate();
if (mDate!=null) {
buf.append(" LASTMODDATE=\"");
buf.append(DateUtility.convertDateToString(mDate) + "\"");
}
String state=obj.getState();
if (state!=null && !state.equals("")) {
buf.append(" RECORDSTATUS=\"");
buf.append(state + "\"");
}
buf.append(">\n");
// use agent to identify the owner of the digital object
String ownerId=obj.getOwnerId();
if (ownerId!=null && !ownerId.equals("")) {
buf.append(" <" + METS_PREFIX + ":agent");
buf.append(" ROLE=\"IPOWNER\">\n");
buf.append(" <" + METS_PREFIX + ":name>" + ownerId + "\n");
buf.append(" \n");
}
buf.append(" \n");
}
private void appendDescriptiveMD(DigitalObject obj, StringBuffer buf,
String encoding)
throws ObjectIntegrityException, UnsupportedEncodingException,
StreamIOException {
Iterator iter=obj.datastreamIdIterator();
while (iter.hasNext()) {
String id=(String) iter.next();
Datastream firstDS=(Datastream) obj.datastreams(id).get(0);
if ((firstDS.DSControlGrp.equals("X"))
&& (((DatastreamXMLMetadata) firstDS).DSMDClass==
DatastreamXMLMetadata.DESCRIPTIVE)) {
appendMDSec(obj, "dmdSecFedora", "descMD", obj.datastreams(id),
buf, encoding);
}
}
}
private void appendMDSec(DigitalObject obj, String outerName,
String innerName, List XMLMetadata, StringBuffer buf, String encoding)
throws ObjectIntegrityException, UnsupportedEncodingException,
StreamIOException {
DatastreamXMLMetadata first=
(DatastreamXMLMetadata)DOTranslationUtility.setDatastreamDefaults(
(DatastreamXMLMetadata) XMLMetadata.get(0));
buf.append(" <" + METS_PREFIX + ":" + outerName + " ID=\""
+ first.DatastreamID + "\" STATUS=\"" + first.DSState
+ "\" VERSIONABLE=\"" + first.DSVersionable
+ "\">\n");
for (int i=0; i\n");
String mdType=ds.DSInfoType;
String otherAttr="";
if ( !mdType.equals("MARC") && !mdType.equals("EAD")
&& !mdType.equals("DC") && !mdType.equals("NISOIMG")
&& !mdType.equals("LC-AV") && !mdType.equals("VRA")
&& !mdType.equals("TEIHDR") && !mdType.equals("DDI")
&& !mdType.equals("FGDC") ) {
mdType="OTHER";
otherAttr=" OTHERMDTYPE=\"" + StreamUtility.enc(ds.DSInfoType)
+ "\" ";
}
String labelAttr="";
if ( ds.DSLabel!=null && !ds.DSLabel.equals("") ) {
labelAttr=" LABEL=\"" + StreamUtility.enc(ds.DSLabel) + "\"";
}
// FORMAT_URI attribute is optional so check if non-empty
String formatURIAttr = "";
if(ds.DSFormatURI!=null && !ds.DSFormatURI.equals("")) {
formatURIAttr=" FORMAT_URI=\"" + StreamUtility.enc(ds.DSFormatURI) + "\"";
}
// ALT_IDS attribute is optional so check if non-empty
String altIdsAttr="";
String altIds=oneString(ds.DatastreamAltIDs);
if (altIds!=null && !altIds.equals("")) {
altIdsAttr=" ALT_IDS=\"" + StreamUtility.enc(altIds) + "\"";
}
// CHECKSUM attribute is optional so check in non-empty
String checksumAttr = "";
if(ds.DSChecksum!=null && !ds.DSChecksum.equals("")) {
checksumAttr=" CHECKSUM=\"" + StreamUtility.enc(ds.DSChecksum) + "\"";
}
// CHECKSUMTYPE attribute is optional so check in non-empty
String checksumTypeAttr = "";
if(ds.DSChecksumType!=null && !ds.DSChecksumType.equals("")) {
checksumTypeAttr=" CHECKSUMTYPE=\"" + StreamUtility.enc(ds.DSChecksumType) + "\"";
}
buf.append(" <" + METS_PREFIX + ":mdWrap MIMETYPE=\"" + StreamUtility.enc(ds.DSMIME) + "\""
+ " MDTYPE=\"" + mdType + "\""
+ otherAttr
+ labelAttr
+ formatURIAttr
+ altIdsAttr
+ checksumAttr
+ checksumTypeAttr
+ ">\n");
buf.append(" <" + METS_PREFIX + ":xmlData>\n");
// If WSDL or SERVICE-PROFILE datastream (in BMech)
// make sure that any embedded URLs are encoded
// appropriately for either EXPORT or STORE.
if (obj.getFedoraObjectType()==DigitalObject.FEDORA_BMECH_OBJECT
&& (ds.DatastreamID.equals("SERVICE-PROFILE"))
|| (ds.DatastreamID.equals("WSDL")) ) {
buf.append(DOTranslationUtility.normalizeInlineXML(
new String(ds.xmlContent, "UTF-8").trim(), m_transContext));
} else {
DOTranslationUtility.appendXMLStream(ds.getContentStream(),
buf,
encoding);
}
buf.append("\n ");
buf.append(" \n");
buf.append(" \n");
}
buf.append(" \n");
}
private void appendAuditRecordAdminMD(DigitalObject obj, StringBuffer buf)
throws ObjectIntegrityException {
if (obj.getAuditRecords().size()>0) {
buf.append(" <" + METS_PREFIX + ":amdSec ID=\"AUDIT\""
+ " STATUS=\"A\" VERSIONABLE=\"false\">\n");
for (int i=0; i\n");
buf.append(" <" + METS_PREFIX + ":mdWrap MIMETYPE=\"text/xml\" "
+ "MDTYPE=\"OTHER\" OTHERMDTYPE=\"FEDORA-AUDIT\""
+ " LABEL=\"Audit record for '"
+ StreamUtility.enc(audit.action) + "' action by "
+ StreamUtility.enc(audit.responsibility) + " at "
+ DateUtility.convertDateToString(audit.date) + "\">\n");
buf.append(" <" + METS_PREFIX + ":xmlData>\n");
buf.append(" <" + m_fedoraAuditPrefix + ":record>\n");
buf.append(" <" + m_fedoraAuditPrefix + ":process type=\""
+ StreamUtility.enc(audit.processType) + "\"/>\n");
buf.append(" <" + m_fedoraAuditPrefix + ":action>"
+ StreamUtility.enc(audit.action)
+ "\n");
buf.append(" <" + m_fedoraAuditPrefix + ":componentID>"
+ StreamUtility.enc(audit.componentID)
+ "\n");
buf.append(" <" + m_fedoraAuditPrefix + ":responsibility>"
+ StreamUtility.enc(audit.responsibility)
+ "\n");
buf.append(" <" + m_fedoraAuditPrefix + ":date>"
+ DateUtility.convertDateToString(audit.date)
+ "\n");
buf.append(" <" + m_fedoraAuditPrefix + ":justification>"
+ StreamUtility.enc(audit.justification)
+ "\n");
buf.append(" \n");
buf.append(" \n");
buf.append(" \n");
buf.append(" \n");
}
buf.append(" \n");
}
}
private void appendOtherAdminMD(DigitalObject obj, StringBuffer buf,
String encoding)
throws ObjectIntegrityException, UnsupportedEncodingException,
StreamIOException {
Iterator iter=obj.datastreamIdIterator();
while (iter.hasNext()) {
String id=(String) iter.next();
Datastream firstDS=(Datastream) obj.datastreams(id).get(0);
// First, work with the first version to get the mdClass set to
// a proper value required in the METS XML Schema.
if ((firstDS.DSControlGrp.equals("X"))
&& (((DatastreamXMLMetadata) firstDS).DSMDClass!=
DatastreamXMLMetadata.DESCRIPTIVE)) {
DatastreamXMLMetadata md=(DatastreamXMLMetadata) firstDS;
// Default mdClass to techMD when a valid one does not appear
// (say because the object was born as FOXML)
String mdClass="techMD";
if (md.DSMDClass==DatastreamXMLMetadata.TECHNICAL) {
mdClass="techMD";
} else if (md.DSMDClass==DatastreamXMLMetadata.SOURCE) {
mdClass="sourceMD";
} else if (md.DSMDClass==DatastreamXMLMetadata.RIGHTS) {
mdClass="rightsMD";
} else if (md.DSMDClass==DatastreamXMLMetadata.DIGIPROV) {
mdClass="digiprovMD";
}
// Then, pass everything along to do the actual serialization
appendMDSec(obj, "amdSec", mdClass, obj.datastreams(id),
buf, encoding);
}
}
}
private void appendFileSecs(DigitalObject obj, StringBuffer buf)
throws ObjectIntegrityException, StreamIOException {
Iterator iter=obj.datastreamIdIterator();
boolean didFileSec=false;
while (iter.hasNext()) {
Datastream ds=
DOTranslationUtility.setDatastreamDefaults(
(Datastream)obj.datastreams((String)iter.next()).get(0));
if (!ds.DSControlGrp.equals("X")) {
if (!didFileSec) {
didFileSec=true;
buf.append(" <" + METS_PREFIX + ":fileSec>\n");
buf.append(" <" + METS_PREFIX + ":fileGrp ID=\"DATASTREAMS\">\n");
}
buf.append(" <" + METS_PREFIX + ":fileGrp ID=\""
+ ds.DatastreamID
+ "\" STATUS=\"" + ds.DSState
+ "\" VERSIONABLE=\"" + ds.DSVersionable
+ "\">\n");
Iterator contentIter=obj.datastreams(ds.DatastreamID).iterator();
while (contentIter.hasNext()) {
Datastream dsc=DOTranslationUtility.setDatastreamDefaults(
(Datastream)contentIter.next());
String labelAttr="";
if (dsc.DSLabel!=null && !dsc.DSLabel.equals("")) {
labelAttr=" " + m_XLinkPrefix + ":title=\""
+ StreamUtility.enc(dsc.DSLabel) + "\"";
}
String dateAttr="";
if (dsc.DSCreateDT!=null) {
dateAttr=" CREATED=\"" + DateUtility.convertDateToString(dsc.DSCreateDT) + "\"";
}
String sizeAttr=" SIZE=\"" + dsc.DSSize + "\"";
// FORMAT_URI attribute is optional so check if non-empty
String formatURIAttr = "";
if(dsc.DSFormatURI!=null && !dsc.DSFormatURI.equals("")) {
formatURIAttr=" FORMAT_URI=\"" + StreamUtility.enc(dsc.DSFormatURI) + "\"";
}
// ALT_IDS attribute is optional so check if non-empty
String altIdsAttr="";
String altIds=oneString(dsc.DatastreamAltIDs);
if (altIds!=null && !altIds.equals("")) {
altIdsAttr=" ALT_IDS=\"" + StreamUtility.enc(altIds) + "\"";
}
// CHECKSUM attribute is optional so check in non-empty
String checksumAttr = "";
if(ds.DSChecksum!=null && !ds.DSChecksum.equals("")) {
checksumAttr=" CHECKSUM=\"" + StreamUtility.enc(ds.DSChecksum) + "\"";
}
// CHECKSUMTYPE attribute is optional so check in non-empty
String checksumTypeAttr = "";
if(ds.DSChecksumType!=null && !ds.DSChecksumType.equals("")) {
checksumTypeAttr=" CHECKSUMTYPE=\"" + StreamUtility.enc(ds.DSChecksumType) + "\"";
}
buf.append(" <" + METS_PREFIX + ":file ID=\"" + dsc.DSVersionID + "\""
+ dateAttr
+ " MIMETYPE=\"" + StreamUtility.enc(dsc.DSMIME) + "\""
+ sizeAttr
+ formatURIAttr
+ altIdsAttr
+ checksumAttr
+ checksumTypeAttr
+ " OWNERID=\"" + dsc.DSControlGrp
+ "\">\n");
if (m_transContext==DOTranslationUtility.SERIALIZE_EXPORT_ARCHIVE &&
dsc.DSControlGrp.equalsIgnoreCase("M")) {
buf.append(" <" + METS_PREFIX + ":FContent> \n"
+ StringUtility.splitAndIndent(
StreamUtility.encodeBase64(dsc.getContentStream()), 14, 80)
+ " \n");
} else {
buf.append(" <" + METS_PREFIX + ":FLocat" + labelAttr
+ " LOCTYPE=\"URL\" "
+ m_XLinkPrefix + ":href=\""
+ StreamUtility.enc(
DOTranslationUtility.normalizeDSLocationURLs(
obj.getPid(), dsc, m_transContext).DSLocation)
+ "\"/>\n");
}
buf.append(" \n");
}
buf.append(" \n");
}
}
if (didFileSec) {
buf.append(" \n");
buf.append(" \n");
}
}
private void appendStructMaps(DigitalObject obj, StringBuffer buf)
throws ObjectIntegrityException {
Iterator dissIdIter=obj.disseminatorIdIterator();
while (dissIdIter.hasNext()) {
String did=(String) dissIdIter.next();
Iterator dissIter=obj.disseminators(did).iterator();
while (dissIter.hasNext()) {
Disseminator diss=
DOTranslationUtility.setDisseminatorDefaults(
(Disseminator) dissIter.next());
String labelAttr="";
if ( diss.dsBindMap.dsBindMapLabel!=null
&& !diss.dsBindMap.dsBindMapLabel.equals("") ) {
labelAttr=" LABEL=\"" + StreamUtility.enc(diss.dsBindMap.dsBindMapLabel) + "\"";
}
buf.append(" <" + METS_PREFIX + ":structMap ID=\""
+ diss.dsBindMapID + "\" TYPE=\"fedora:dsBindingMap\">\n");
buf.append(" <" + METS_PREFIX + ":div TYPE=\"" + diss.bMechID
+ "\"" + labelAttr
+ ">\n");
DSBinding[] bindings=diss.dsBindMap.dsBindings;
for (int i=0; i\n <" + METS_PREFIX + ":fptr FILEID=\""
+ bindings[i].datastreamID + "\"/>\n"
+ " \n");
}
buf.append(" \n");
buf.append(" \n");
}
}
}
private void appendDisseminators(DigitalObject obj, StringBuffer buf)
throws ObjectIntegrityException {
Iterator dissIdIter=obj.disseminatorIdIterator();
while (dissIdIter.hasNext()) {
String did=(String) dissIdIter.next();
Iterator dissIter=obj.disseminators(did).iterator();
Disseminator diss=
DOTranslationUtility.setDisseminatorDefaults(
(Disseminator) obj.disseminators(did).get(0));
buf.append(" <" + METS_PREFIX + ":behaviorSec ID=\"" + did
+ "\" STATUS=\"" + diss.dissState + "\">\n");
for (int i=0; i\n");
//buf.append(" <" + METS_PREFIX + ":interfaceMD" + bDefLabelAttr
buf.append(" <" + METS_PREFIX + ":interfaceMD"
+ " LOCTYPE=\"URN\" " + m_XLinkPrefix + ":href=\""
+ diss.bDefID + "\"/>\n");
//buf.append(" <" + METS_PREFIX + ":serviceBindMD" + bMechLabelAttr
buf.append(" <" + METS_PREFIX + ":serviceBindMD"
+ " LOCTYPE=\"URN\" " + m_XLinkPrefix + ":href=\""
+ diss.bMechID + "\"/>\n");
buf.append(" \n");
}
buf.append(" \n");
}
}
private void appendRootElementEnd(StringBuffer buf) {
buf.append("");
}
private void writeToStream(StringBuffer buf, OutputStream out,
String encoding, boolean closeWhenFinished)
throws StreamIOException, UnsupportedEncodingException {
try {
out.write(buf.toString().getBytes(encoding));
out.flush();
} catch (IOException ioe) {
throw new StreamWriteException("Problem serializing to METS: "
+ ioe.getMessage());
} finally {
if (closeWhenFinished) {
try {
out.close();
} catch (IOException ioe2) {
throw new StreamWriteException("Problem closing stream after "
+ " serializing to METS: " + ioe2.getMessage());
}
}
}
}
private String oneString(String[] idList){
StringBuffer out=new StringBuffer();
for (int i=0; i0) {
out.append(' ');
}
out.append((String) idList[i]);
}
return out.toString();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy