java.fedora.client.utility.export.AutoExporter 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
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.client.utility.export;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.net.MalformedURLException;
import java.rmi.RemoteException;
import java.util.HashMap;
import java.util.StringTokenizer;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.rpc.ServiceException;

import org.apache.xml.serialize.OutputFormat;
import org.apache.xml.serialize.XMLSerializer;
import org.w3c.dom.Document;

import fedora.server.access.FedoraAPIA;
import fedora.server.management.FedoraAPIM;
import fedora.server.types.gen.RepositoryInfo;

/**
 *
 * Title: AutoExporter.java
 * Description: Utility class to make API-M SOAP calls to a repository. 
 *
 *
 * @author [email protected]
 * @version $Id: AutoExporter.java 5166 2006-10-25 11:05:45Z eddie $
 */
public class AutoExporter {

    private FedoraAPIM m_apim;
	private FedoraAPIA m_apia;
    private static HashMap s_repoInfo=new HashMap();

    //public AutoExporter(String protocol, String host, int port, String user, String pass)
    //        throws MalformedURLException, ServiceException {
	//	m_apia=APIAStubFactory.getStub(protocol, host, port, user, pass);
    //    m_apim=APIMStubFactory.getStub(protocol, host, port, user, pass);
    //}
    
	public AutoExporter(FedoraAPIA apia, FedoraAPIM apim)
			throws MalformedURLException, ServiceException {
		m_apia=apia;
		m_apim=apim;
	}
	
	public void export(String pid, String format, String exportContext, 
			OutputStream outStream) 
			throws RemoteException, IOException {
		export(m_apia, m_apim, pid, format, exportContext, outStream);
	}

	
    public static void export(FedoraAPIA apia, FedoraAPIM apim, String pid, String format,
            String exportContext, OutputStream outStream)
            throws RemoteException, IOException {

        // Get the repository info from the hash for the repository that APIA is using,
        // unless it isn't in the hash yet... in which case, ask the server.
		RepositoryInfo repoinfo=(RepositoryInfo) s_repoInfo.get(apia);
        if (repoinfo == null) {
            repoinfo=apia.describeRepository();
            s_repoInfo.put(apia, repoinfo);
        }
				
        byte[] bytes;
    	// For backward compatibility:
    	// For pre-2.0 repositories, use the "exportObject" APIM method. 
    	// Also pre-2.0 repositories will only export "metslikefedora1".
    	// For 2.0+ repositories use the "export" method which takes a format arg.
		StringTokenizer stoken = new StringTokenizer(repoinfo.getRepositoryVersion(), ".");
		if (new Integer(stoken.nextToken()).intValue() < 2){
			if (format==null ||
				format.equals("metslikefedora1") ||
				format.equals("default")) {
				bytes=apim.exportObject(pid);					
			} else {
				throw new IOException("You are connected to a pre-2.0 Fedora repository " +
					"which will only export the XML format \"metslikefedora1\".");
			}
		} else {
			validateFormat(format);				
			bytes=apim.export(pid, format, exportContext);
		}
        try {
            // use xerces to pretty print the xml, assuming it's well formed
            OutputFormat fmt=new OutputFormat("XML", "UTF-8", true);
            fmt.setIndent(2);
            fmt.setLineWidth(120);
            fmt.setPreserveSpace(false);
            XMLSerializer ser=new XMLSerializer(outStream, fmt);
            DocumentBuilderFactory factory=DocumentBuilderFactory.newInstance();
            factory.setNamespaceAware(true);
            DocumentBuilder builder=factory.newDocumentBuilder();
            Document doc=builder.parse(new ByteArrayInputStream(bytes));
            ser.serialize(doc);
        } catch (Exception e) {
            System.out.println("ERROR: " + e.getClass().getName() + " : " + e.getMessage());
        } finally
        {
          outStream.close();
        }
    }

	public void getObjectXML(String pid, OutputStream outStream) 
			throws RemoteException, IOException {
		getObjectXML(m_apia, m_apim, pid, outStream);
	}
	
	public static void getObjectXML(FedoraAPIA apia, FedoraAPIM apim, String pid, OutputStream outStream)
			throws RemoteException, IOException {

		// Get the repository info from the hash for the repository that APIA is using,
		// unless it isn't in the hash yet... in which case, ask the server.
		RepositoryInfo repoinfo=(RepositoryInfo) s_repoInfo.get(apia);
		if (repoinfo == null) {
			repoinfo=apia.describeRepository();
			s_repoInfo.put(apia, repoinfo);
		}
		// get the object XML as it exists in the repository's 
		// persitent storage area.		
		byte[] bytes=apim.getObjectXML(pid);
		try {
			// use xerces to pretty print the xml, assuming it's well formed
			OutputFormat fmt=new OutputFormat("XML", "UTF-8", true);
			fmt.setIndent(2);
			fmt.setLineWidth(120);
			fmt.setPreserveSpace(false);
			XMLSerializer ser=new XMLSerializer(outStream, fmt);
			DocumentBuilderFactory factory=DocumentBuilderFactory.newInstance();
			factory.setNamespaceAware(true);
			DocumentBuilder builder=factory.newDocumentBuilder();
			Document doc=builder.parse(new ByteArrayInputStream(bytes));
			ser.serialize(doc);
		} catch (Exception e) {
			System.out.println("ERROR: " + e.getClass().getName() + " : " + e.getMessage());
		} finally
		{
		  outStream.close();
		}
	}

	public static void validateFormat(String format)
		throws IOException {
	    if (format==null) return;
			if (!format.equals("foxml1.0") && 
				!format.equals("metslikefedora1") && 
				!format.equals("default")) {
				throw new IOException("Invalid export format. Valid FORMAT values are: " +
					"'foxml1.0' 'metslikefedora1' and 'default'");
			}
		}
}