java.fedora.server.storage.lowlevel.DefaultLowlevelStorageModule 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.server.storage.lowlevel;

import java.io.InputStream;
import java.util.HashMap;
import java.util.Map;

import org.apache.log4j.Logger;

import fedora.server.Module;
import fedora.server.Server;
import fedora.server.errors.ConnectionPoolNotFoundException;
import fedora.server.errors.LowlevelStorageException;
import fedora.server.errors.ModuleInitializationException;
import fedora.server.storage.ConnectionPool;
import fedora.server.storage.ConnectionPoolManager;

/**
 * @author Edwin Shin
 * @version $Id$
 */
public class DefaultLowlevelStorageModule
        extends Module implements ILowlevelStorage {	

    /** Logger for this class. */
    private static final Logger LOG = Logger.getLogger(
            DefaultLowlevelStorageModule.class.getName());

	private ILowlevelStorage m_llstore;
	
	public DefaultLowlevelStorageModule(Map moduleParameters, Server server, String role) throws ModuleInitializationException {
		super(moduleParameters, server, role);
	}
	
	public void postInitModule() throws ModuleInitializationException {
		try {
			m_llstore = new DefaultLowlevelStorage(getModuleParameters());
		} catch (LowlevelStorageException e) {
			throw new ModuleInitializationException(e.getMessage(), getRole());
		}
	}

	protected Map getModuleParameters() throws ModuleInitializationException {
		// Parameter validation
		String objectStoreBase = getModuleParameter(DefaultLowlevelStorage.OBJECT_STORE_BASE, true);
		String datastreamStoreBase = getModuleParameter(DefaultLowlevelStorage.DATASTREAM_STORE_BASE, true);
		// FIXME object/datastream store location sanity checks (e.g. no overlapping)
		
		String filesystem = getModuleParameter(DefaultLowlevelStorage.FILESYSTEM, false);
		String pathAlgorithm = getModuleParameter(DefaultLowlevelStorage.PATH_ALGORITHM, false);
		String pathRegistry = getModuleParameter(DefaultLowlevelStorage.PATH_REGISTRY, false);
		
		// parameter required by DBPathRegistry
		String backslashIsEscape;
		String param = getModuleParameter("backslash_is_escape", false).toLowerCase();
		if (param.equals("true") || param.equals("false")) {
			backslashIsEscape = param;
		} else {
			throw new ModuleInitializationException("backslash_is_escape parameter must be either true or false", getRole());
		}
		
        // get connectionPool from ConnectionPoolManager
        ConnectionPoolManager cpm = (ConnectionPoolManager)getServer().
                getModule("fedora.server.storage.ConnectionPoolManager");
        if (cpm == null) {
            throw new ModuleInitializationException(
                "ConnectionPoolManager module was required, but apparently has "
                + "not been loaded.", getRole());
        }
        
        ConnectionPool cPool;
        try {
			cPool = cpm.getPool();
		} catch (ConnectionPoolNotFoundException e1) {
			throw new ModuleInitializationException("Could not find requested "
                    + "connectionPool.", getRole());
		}
		
		Map configuration = new HashMap();
		configuration.put(DefaultLowlevelStorage.FILESYSTEM, filesystem);
		configuration.put(DefaultLowlevelStorage.PATH_ALGORITHM, pathAlgorithm);
		configuration.put(DefaultLowlevelStorage.PATH_REGISTRY, pathRegistry);
		configuration.put(DefaultLowlevelStorage.OBJECT_STORE_BASE, objectStoreBase);
		configuration.put(DefaultLowlevelStorage.DATASTREAM_STORE_BASE, datastreamStoreBase);
		configuration.put("connectionPool", cPool);
		configuration.put("backslashIsEscape", backslashIsEscape);
		
		return configuration;
	}
	
	
	protected String getModuleParameter(String parameterName, boolean parameterAsAbsolutePath) throws ModuleInitializationException {
		String parameterValue = getParameter(parameterName, parameterAsAbsolutePath);
		
		if (parameterValue == null) {
			throw new ModuleInitializationException(parameterName + " parameter must be specified", getRole());
		}
		return parameterValue;
	}

	public void addObject(String pid, InputStream content) throws LowlevelStorageException {
		m_llstore.addObject(pid, content);
	}

	public void replaceObject(String pid, InputStream content) throws LowlevelStorageException {
		m_llstore.replaceObject(pid, content);
	}

	public InputStream retrieveObject(String pid) throws LowlevelStorageException {
		return m_llstore.retrieveObject(pid);
	}

	public void removeObject(String pid) throws LowlevelStorageException {
		m_llstore.removeObject(pid);
	}

	public void rebuildObject() throws LowlevelStorageException {
		m_llstore.rebuildObject();
	}

	public void auditObject() throws LowlevelStorageException {
		m_llstore.auditObject();
	}

	public void addDatastream(String pid, InputStream content) throws LowlevelStorageException {
		m_llstore.addDatastream(pid, content);
	}

	public void replaceDatastream(String pid, InputStream content) throws LowlevelStorageException {
		m_llstore.replaceDatastream(pid, content);
	}

	public InputStream retrieveDatastream(String pid) throws LowlevelStorageException {
		return m_llstore.retrieveDatastream(pid);
	}

	public void removeDatastream(String pid) throws LowlevelStorageException {
		m_llstore.removeDatastream(pid);
	}

	public void rebuildDatastream() throws LowlevelStorageException {
		m_llstore.rebuildDatastream();
	}

	public void auditDatastream() throws LowlevelStorageException {
		m_llstore.auditDatastream();
	}
}