Metacat

/**

 *  '$RCSfile$'

 *  Copyright: 2000-2011 Regents of the University of California and the

 *              National Center for Ecological Analysis and Synthesis

 *

 *   '$Author:  $'

 *     '$Date:  $'

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

package edu.ucsb.nceas.metacat.dataone;

import java.io.InputStream;

import java.math.BigInteger;

import java.util.ArrayList;

import java.util.Calendar;

import java.util.Date;

import java.util.List;

import java.util.concurrent.locks.Lock;

import javax.servlet.http.HttpServletRequest;

import org.apache.log4j.Logger;

import org.dataone.client.CNode;

import org.dataone.client.D1Client;

import org.dataone.client.MNode;

import org.dataone.service.cn.v1.CNAuthorization;

import org.dataone.service.cn.v1.CNCore;

import org.dataone.service.cn.v1.CNRead;

import org.dataone.service.cn.v1.CNReplication;

import org.dataone.service.exceptions.BaseException;

import org.dataone.service.exceptions.IdentifierNotUnique;

import org.dataone.service.exceptions.InsufficientResources;

import org.dataone.service.exceptions.InvalidRequest;

import org.dataone.service.exceptions.InvalidSystemMetadata;

import org.dataone.service.exceptions.InvalidToken;

import org.dataone.service.exceptions.NotAuthorized;

import org.dataone.service.exceptions.NotFound;

import org.dataone.service.exceptions.NotImplemented;

import org.dataone.service.exceptions.ServiceFailure;

import org.dataone.service.exceptions.UnsupportedType;

import org.dataone.service.exceptions.VersionMismatch;

import org.dataone.service.types.v1.AccessPolicy;

import org.dataone.service.types.v1.Checksum;

import org.dataone.service.types.v1.ChecksumAlgorithmList;

import org.dataone.service.types.v1.Identifier;

import org.dataone.service.types.v1.Node;

import org.dataone.service.types.v1.NodeList;

import org.dataone.service.types.v1.NodeReference;

import org.dataone.service.types.v1.NodeType;

import org.dataone.service.types.v1.ObjectFormat;

import org.dataone.service.types.v1.ObjectFormatIdentifier;

import org.dataone.service.types.v1.ObjectFormatList;

import org.dataone.service.types.v1.ObjectList;

import org.dataone.service.types.v1.ObjectLocationList;

import org.dataone.service.types.v1.Permission;

import org.dataone.service.types.v1.Replica;

import org.dataone.service.types.v1.ReplicationPolicy;

import org.dataone.service.types.v1.ReplicationStatus;

import org.dataone.service.types.v1.Session;

import org.dataone.service.types.v1.Subject;

import org.dataone.service.types.v1.SystemMetadata;

import org.dataone.service.types.v1.util.ServiceMethodRestrictionUtil;

import edu.ucsb.nceas.metacat.EventLog;

import edu.ucsb.nceas.metacat.IdentifierManager;

import edu.ucsb.nceas.metacat.dataone.hazelcast.HazelcastService;

/**

 * Represents Metacat's implementation of the DataONE Coordinating Node 

 * service API. Methods implement the various CN* interfaces, and methods common

 * to both Member Node and Coordinating Node interfaces are found in the

 * D1NodeService super class.

 *

 */

public class CNodeService extends D1NodeService implements CNAuthorization,

    CNCore, CNRead, CNReplication {

  /* the logger instance */

  private Logger logMetacat = null;

  /**

   * singleton accessor

   */

  public static CNodeService getInstance(HttpServletRequest request) { 

    return new CNodeService(request);

  }

  /**

   * Constructor, private for singleton access

   */

  private CNodeService(HttpServletRequest request) {

    super(request);

    logMetacat = Logger.getLogger(CNodeService.class);

  }

  /**

   * Set the replication policy for an object given the object identifier

   * 

   * @param session - the Session object containing the credentials for the Subject

   * @param pid - the object identifier for the given object

   * @param policy - the replication policy to be applied

   * 

   * @return true or false

   * 

   * @throws NotImplemented

   * @throws NotAuthorized

   * @throws ServiceFailure

   * @throws InvalidRequest

   * @throws VersionMismatch

   * 

   */

  @Override

  public boolean setReplicationPolicy(Session session, Identifier pid,

      ReplicationPolicy policy, long serialVersion) 

      throws NotImplemented, NotFound, NotAuthorized, ServiceFailure, 

      InvalidRequest, InvalidToken, VersionMismatch {

      // The lock to be used for this identifier

      Lock lock = null;

      // get the subject

      Subject subject = session.getSubject();

      // are we allowed to do this?

      if (!isAuthorized(session, pid, Permission.CHANGE_PERMISSION)) {

          throw new NotAuthorized("4881", Permission.CHANGE_PERMISSION

                  + " not allowed by " + subject.getValue() + " on "

                  + pid.getValue());

      }

      SystemMetadata systemMetadata = null;

      try {

          lock = HazelcastService.getInstance().getLock(pid.getValue());

          lock.lock();

          logMetacat.debug("Locked identifier " + pid.getValue());

          try {

              if ( HazelcastService.getInstance().getSystemMetadataMap().containsKey(pid) ) {

                  systemMetadata = HazelcastService.getInstance().getSystemMetadataMap().get(pid);

              }

              // did we get it correctly?

              if ( systemMetadata == null ) {

                  throw new NotFound("4884", "Couldn't find an object identified by " + pid.getValue());

              }

              // does the request have the most current system metadata?

              if ( systemMetadata.getSerialVersion().longValue() != serialVersion ) {

                 String msg = "The requested system metadata version number " + 

                     serialVersion + " differs from the current version at " +

                     systemMetadata.getSerialVersion().longValue() +

                     ". Please get the latest copy in order to modify it.";

                 throw new VersionMismatch("4886", msg);

              }

          } catch (RuntimeException e) { // Catch is generic since HZ throws RuntimeException

              throw new NotFound("4884", "No record found for: " + pid.getValue());

          }

          // set the new policy

          systemMetadata.setReplicationPolicy(policy);

          // update the metadata

          try {

              systemMetadata.setSerialVersion(systemMetadata.getSerialVersion().add(BigInteger.ONE));

              systemMetadata.setDateSysMetadataModified(Calendar.getInstance().getTime());

              HazelcastService.getInstance().getSystemMetadataMap().put(systemMetadata.getIdentifier(), systemMetadata);

              notifyReplicaNodes(systemMetadata);

          } catch (RuntimeException e) {

              throw new ServiceFailure("4882", e.getMessage());

          }

      } catch (RuntimeException e) {

          throw new ServiceFailure("4882", e.getMessage());

      } finally {

          lock.unlock();

          logMetacat.debug("Unlocked identifier " + pid.getValue());

      }

      return true;

  }

  /**

   * Deletes the replica from the given Member Node

   * NOTE: MN.delete() may be an "archive" operation. TBD.

   * @param session

   * @param pid

   * @param nodeId

   * @param serialVersion

   * @return

   * @throws InvalidToken

   * @throws ServiceFailure

   * @throws NotAuthorized

   * @throws NotFound

   * @throws NotImplemented

   * @throws VersionMismatch

   */

  @Override

  public boolean deleteReplicationMetadata(Session session, Identifier pid, NodeReference nodeId, long serialVersion) 

  	throws InvalidToken, ServiceFailure, NotAuthorized, NotFound, NotImplemented, VersionMismatch {

	  	// The lock to be used for this identifier

		Lock lock = null;

		// get the subject

		Subject subject = session.getSubject();

		// are we allowed to do this?

		boolean isAuthorized = false;

		try {

			isAuthorized = isAuthorized(session, pid, Permission.WRITE);

		} catch (InvalidRequest e) {

			throw new ServiceFailure("4882", e.getDescription());

		}

		if (!isAuthorized) {

			throw new NotAuthorized("4881", Permission.WRITE

					+ " not allowed by " + subject.getValue() + " on "

					+ pid.getValue());

		}

		SystemMetadata systemMetadata = null;

		try {

			lock = HazelcastService.getInstance().getLock(pid.getValue());

			lock.lock();

			logMetacat.debug("Locked identifier " + pid.getValue());

			try {

				if (HazelcastService.getInstance().getSystemMetadataMap().containsKey(pid)) {

					systemMetadata = HazelcastService.getInstance().getSystemMetadataMap().get(pid);

				}

				// did we get it correctly?

				if (systemMetadata == null) {

					throw new NotFound("4884", "Couldn't find an object identified by " + pid.getValue());

				}

				// does the request have the most current system metadata?

				if (systemMetadata.getSerialVersion().longValue() != serialVersion) {

					String msg = "The requested system metadata version number "

							+ serialVersion

							+ " differs from the current version at "

							+ systemMetadata.getSerialVersion().longValue()

							+ ". Please get the latest copy in order to modify it.";

					throw new VersionMismatch("4886", msg);

				}

			} catch (RuntimeException e) { // Catch is generic since HZ throws RuntimeException

				throw new NotFound("4884", "No record found for: " + pid.getValue());

			}

			// check permissions

			// TODO: is this necessary?

			List<Node> nodeList = D1Client.getCN().listNodes().getNodeList();

			boolean isAllowed = ServiceMethodRestrictionUtil.isMethodAllowed(session.getSubject(), nodeList, "CNReplication", "deleteReplicationMetadata");

			if (isAllowed) {

				throw new NotAuthorized("4881", "Caller is not authorized to deleteReplicationMetadata");

			}

			// delete the replica from the given node

			D1Client.getMN(nodeId).delete(session, pid);

			// reflect that change in the system metadata

			List<Replica> updatedReplicas = new ArrayList<Replica>(systemMetadata.getReplicaList());

			for (Replica r: systemMetadata.getReplicaList()) {

				  if (r.getReplicaMemberNode().equals(nodeId)) {

					  updatedReplicas.remove(r);

					  break;

				  }

			}

			systemMetadata.setReplicaList(updatedReplicas);

			// update the metadata

			try {

				systemMetadata.setSerialVersion(systemMetadata.getSerialVersion().add(BigInteger.ONE));

				systemMetadata.setDateSysMetadataModified(Calendar.getInstance().getTime());

				HazelcastService.getInstance().getSystemMetadataMap().put(systemMetadata.getIdentifier(), systemMetadata);

			} catch (RuntimeException e) {

				throw new ServiceFailure("4882", e.getMessage());

			}

		} catch (RuntimeException e) {

			throw new ServiceFailure("4882", e.getMessage());

		} finally {

			lock.unlock();

			logMetacat.debug("Unlocked identifier " + pid.getValue());

		}

		return true;	  

  }

  /**

   * Set the obsoletedBy attribute in System Metadata

   * @param session

   * @param pid

   * @param obsoletedByPid

   * @param serialVersion

   * @return

   * @throws NotImplemented

   * @throws NotFound

   * @throws NotAuthorized

   * @throws ServiceFailure

   * @throws InvalidRequest

   * @throws InvalidToken

   * @throws VersionMismatch

   */

  @Override

  public boolean setObsoletedBy(Session session, Identifier pid,

			Identifier obsoletedByPid, long serialVersion)

			throws NotImplemented, NotFound, NotAuthorized, ServiceFailure,

			InvalidRequest, InvalidToken, VersionMismatch {

		// The lock to be used for this identifier

		Lock lock = null;

		// get the subject

		Subject subject = session.getSubject();

		// are we allowed to do this?

		if (!isAuthorized(session, pid, Permission.WRITE)) {

			throw new NotAuthorized("4881", Permission.WRITE

					+ " not allowed by " + subject.getValue() + " on "

					+ pid.getValue());

		}

		SystemMetadata systemMetadata = null;

		try {

			lock = HazelcastService.getInstance().getLock(pid.getValue());

			lock.lock();

			logMetacat.debug("Locked identifier " + pid.getValue());

			try {

				if (HazelcastService.getInstance().getSystemMetadataMap().containsKey(pid)) {

					systemMetadata = HazelcastService.getInstance().getSystemMetadataMap().get(pid);

				}

				// did we get it correctly?

				if (systemMetadata == null) {

					throw new NotFound("4884", "Couldn't find an object identified by " + pid.getValue());

				}

				// does the request have the most current system metadata?

				if (systemMetadata.getSerialVersion().longValue() != serialVersion) {

					String msg = "The requested system metadata version number "

							+ serialVersion

							+ " differs from the current version at "

							+ systemMetadata.getSerialVersion().longValue()

							+ ". Please get the latest copy in order to modify it.";

					throw new VersionMismatch("4886", msg);

				}

			} catch (RuntimeException e) { // Catch is generic since HZ throws RuntimeException

				throw new NotFound("4884", "No record found for: " + pid.getValue());

			}

			// set the new policy

			systemMetadata.setObsoletedBy(obsoletedByPid);

			// update the metadata

			try {

				systemMetadata.setSerialVersion(systemMetadata.getSerialVersion().add(BigInteger.ONE));

				systemMetadata.setDateSysMetadataModified(Calendar.getInstance().getTime());

				HazelcastService.getInstance().getSystemMetadataMap().put(systemMetadata.getIdentifier(), systemMetadata);

			} catch (RuntimeException e) {

				throw new ServiceFailure("4882", e.getMessage());

			}

		} catch (RuntimeException e) {

			throw new ServiceFailure("4882", e.getMessage());

		} finally {

			lock.unlock();

			logMetacat.debug("Unlocked identifier " + pid.getValue());

		}

		return true;

	}

  /**

   * Set the replication status for an object given the object identifier

   * 

   * @param session - the Session object containing the credentials for the Subject

   * @param pid - the object identifier for the given object

   * @param status - the replication status to be applied

   * 

   * @return true or false

   * 

   * @throws NotImplemented

   * @throws NotAuthorized

   * @throws ServiceFailure

   * @throws InvalidRequest

   * @throws InvalidToken

   * @throws NotFound

   * 

   */

  @Override

  public boolean setReplicationStatus(Session session, Identifier pid,

      NodeReference targetNode, ReplicationStatus status, BaseException failure) 

      throws ServiceFailure, NotImplemented, InvalidToken, NotAuthorized, 

      InvalidRequest, NotFound {

	  // cannot be called by public

	  if (session == null) {

		  throw new NotAuthorized("4720", "Session cannot be null");

	  }

      // The lock to be used for this identifier

      Lock lock = null;

      boolean allowed = false;

      int replicaEntryIndex = -1;

      List<Replica> replicas = null;

      // get the subject

      Subject subject = session.getSubject();

      logMetacat.debug("ReplicationStatus for identifier " + pid.getValue() +

          " is " + status.toString());

      SystemMetadata systemMetadata = null;

      try {

          lock = HazelcastService.getInstance().getLock(pid.getValue());

          lock.lock();

          logMetacat.debug("Locked identifier " + pid.getValue());

          try {      

              systemMetadata = HazelcastService.getInstance().getSystemMetadataMap().get(pid);

              // did we get it correctly?

              if ( systemMetadata == null ) {

                  logMetacat.debug("systemMetadata is null for " + pid.getValue());

                  throw new NotFound("4740", "Couldn't find an object identified by " + pid.getValue());

              }

              replicas = systemMetadata.getReplicaList();

              int count = 0;

              // was there a failure? log it

              if ( failure != null && status == ReplicationStatus.FAILED ) {

                 String msg = "The replication request of the object identified by " + 

                     pid.getValue() + " failed.  The error message was " +

                     failure.getMessage() + ".";

              }

              if (replicas.size() > 0 && replicas != null) {

                  // find the target replica index in the replica list

                  for (Replica replica : replicas) {

                      String replicaNodeStr = replica.getReplicaMemberNode()

                              .getValue();

                      String targetNodeStr = targetNode.getValue();

                      logMetacat.debug("Comparing " + replicaNodeStr + " to "

                              + targetNodeStr);

                      if (replicaNodeStr.equals(targetNodeStr)) {

                          replicaEntryIndex = count;

                          logMetacat.debug("replica entry index is: "

                                  + replicaEntryIndex);

                          break;

                      }

                      count++;

                  }

              }

              // are we allowed to do this? only CNs and target MNs are allowed

              CNode cn = D1Client.getCN();

              List<Node> nodes = cn.listNodes().getNodeList();

              // find the node in the node list

              for ( Node node : nodes ) {

                  NodeReference nodeReference = node.getIdentifier();

                  logMetacat.debug("In setReplicationStatus(), Node reference is: " + nodeReference.getValue());

                  // allow target MN certs

                  if (targetNode.getValue().equals(nodeReference.getValue()) &&

                      node.getType() == NodeType.MN) {

                      List<Subject> nodeSubjects = node.getSubjectList();

                      // check if the session subject is in the node subject list

                      for (Subject nodeSubject : nodeSubjects) {

                          logMetacat.debug("In setReplicationStatus(), comparing subjects: " +

                                  nodeSubject.getValue() + " and " + subject.getValue());

                          if ( nodeSubject.equals(subject) ) { // subject of session == target node subject

                              // lastly limit to COMPLETED status updates from MNs only

                              if ( status == ReplicationStatus.COMPLETED ) {

                                  allowed = true;

                                  break;

                              }                              

                          }

                      }                 

                  }

              }

              if ( !allowed ) {

                  //check for CN admin access

                  allowed = isAuthorized(session, pid, Permission.WRITE);

              }              

              if ( !allowed ) {

                  String msg = "The subject identified by "

                          + subject.getValue()

                          + " does not have permission to set the replication status for "

                          + "the replica identified by "

                          + targetNode.getValue() + ".";

                  logMetacat.info(msg);

                  throw new NotAuthorized("4720", msg);

              }

          } catch (RuntimeException e) { // Catch is generic since HZ throws RuntimeException

            throw new NotFound("4740", "No record found for: " + pid.getValue() +

                " : " + e.getMessage());

          }

          Replica targetReplica = new Replica();

          // set the status for the replica

          if ( replicaEntryIndex != -1 ) {

              targetReplica = replicas.get(replicaEntryIndex);

              targetReplica.setReplicationStatus(status);

              logMetacat.debug("Set the replication status for " + 

                  targetReplica.getReplicaMemberNode().getValue() + " to " +

                  targetReplica.getReplicationStatus());

          } else {

              // this is a new entry, create it

              targetReplica.setReplicaMemberNode(targetNode);

              targetReplica.setReplicationStatus(status);

              targetReplica.setReplicaVerified(Calendar.getInstance().getTime());

              replicas.add(targetReplica);

          }

          systemMetadata.setReplicaList(replicas);

          // update the metadata

          try {

              systemMetadata.setSerialVersion(systemMetadata.getSerialVersion().add(BigInteger.ONE));

              systemMetadata.setDateSysMetadataModified(Calendar.getInstance().getTime());

              HazelcastService.getInstance().getSystemMetadataMap().put(systemMetadata.getIdentifier(), systemMetadata);

              if ( status == ReplicationStatus.FAILED && failure != null ) {

                  logMetacat.warn("Replication failed for identifier " + pid.getValue() +

                      " on target node " + targetNode + ". The exception was: " +

                      failure.getMessage());

              }

          } catch (RuntimeException e) {

              throw new ServiceFailure("4700", e.getMessage());

          }

    } catch (RuntimeException e) {

        String msg = "There was a RuntimeException getting the lock for " +

            pid.getValue();

        logMetacat.info(msg);

    } finally {

        lock.unlock();

        logMetacat.debug("Unlocked identifier " + pid.getValue());

    }

      return true;

  }

  /**

   * Return the checksum of the object given the identifier 

   * 

   * @param session - the Session object containing the credentials for the Subject

   * @param pid - the object identifier for the given object

   * 

   * @return checksum - the checksum of the object

   * 

   * @throws InvalidToken

   * @throws ServiceFailure

   * @throws NotAuthorized

   * @throws NotFound

   * @throws NotImplemented

   */

  @Override

  public Checksum getChecksum(Session session, Identifier pid)

    throws InvalidToken, ServiceFailure, NotAuthorized, NotFound, 

    NotImplemented {

	boolean isAuthorized = false;

	try {

		isAuthorized = isAuthorized(session, pid, Permission.READ);

	} catch (InvalidRequest e) {

		throw new ServiceFailure("1410", e.getDescription());

	}  

    if (!isAuthorized) {

        throw new NotAuthorized("1400", Permission.READ + " not allowed on " + pid.getValue());  

    }

    SystemMetadata systemMetadata = null;

    Checksum checksum = null;

    try {

        systemMetadata = HazelcastService.getInstance().getSystemMetadataMap().get(pid);        

        if (systemMetadata == null ) {

            throw new NotFound("1420", "Couldn't find an object identified by " + pid.getValue());

        }

        checksum = systemMetadata.getChecksum();

    } catch (RuntimeException e) {

        throw new ServiceFailure("1410", "An error occurred getting the checksum for " + 

            pid.getValue() + ". The error message was: " + e.getMessage());

    }

    return checksum;

  }

  /**

   * Resolve the location of a given object

   * 

   * @param session - the Session object containing the credentials for the Subject

   * @param pid - the object identifier for the given object

   * 

   * @return objectLocationList - the list of nodes known to contain the object

   * 

   * @throws InvalidToken

   * @throws ServiceFailure

   * @throws NotAuthorized

   * @throws NotFound

   * @throws NotImplemented

   */

  @Override

  public ObjectLocationList resolve(Session session, Identifier pid)

    throws InvalidToken, ServiceFailure, NotAuthorized,

    NotFound, NotImplemented {

    throw new NotImplemented("4131", "resolve not implemented");

  }

  /**

   * Search the metadata catalog for identifiers that match the criteria

   * 

   * @param session - the Session object containing the credentials for the Subject

   * @param queryType - An identifier for the type of query expression 

   *                    provided in the query

   * @param query -  The criteria for matching the characteristics of the 

   *                 metadata objects of interest

   * 

   * @return objectList - the list of objects matching the criteria

   * 

   * @throws InvalidToken

   * @throws ServiceFailure

   * @throws NotAuthorized

   * @throws InvalidRequest

   * @throws NotImplemented

   */

  @Override

  public ObjectList search(Session session, String queryType, String query)

    throws InvalidToken, ServiceFailure, NotAuthorized, InvalidRequest,

    NotImplemented {

    ObjectList objectList = null;

    try {

        objectList = 

          IdentifierManager.getInstance().querySystemMetadata(

              null, //startTime, 

              null, //endTime,

              null, //objectFormat, 

              false, //replicaStatus, 

              0, //start, 

              -1 //count

              );

    } catch (Exception e) {

      throw new ServiceFailure("4310", "Error querying system metadata: " + e.getMessage());

    }

      return objectList;

    //throw new NotImplemented("4281", "search not implemented");

    // the code block below is from an older implementation

    /*  This block commented out because of the EcoGrid circular dependency.

         *  For now, query will not be supported until the circularity can be

         *  resolved, probably by moving the ecogrid query syntax transformers

         *  directly into the Metacat codebase.  MBJ 2010-02-03

        try {

            EcogridQueryParser parser = new EcogridQueryParser(request

                    .getReader());

            parser.parseXML();

            QueryType queryType = parser.getEcogridQuery();

            EcogridJavaToMetacatJavaQueryTransformer queryTransformer = 

                new EcogridJavaToMetacatJavaQueryTransformer();

            QuerySpecification metacatQuery = queryTransformer

                    .transform(queryType);

            DBQuery metacat = new DBQuery();

            boolean useXMLIndex = (new Boolean(PropertyService

                    .getProperty("database.usexmlindex"))).booleanValue();

            String xmlquery = "query"; // we don't care the query in resultset,

            // the query can be anything

            PrintWriter out = null; // we don't want metacat result, so set out null

            // parameter: queryspecification, user, group, usingIndexOrNot

            StringBuffer result = metacat.createResultDocument(xmlquery,

                    metacatQuery, out, username, groupNames, useXMLIndex);

            // create result set transfer       

            String saxparser = PropertyService.getProperty("xml.saxparser");

            MetacatResultsetParser metacatResultsetParser = new MetacatResultsetParser(

                    new StringReader(result.toString()), saxparser, queryType

                            .getNamespace().get_value());

            ResultsetType records = metacatResultsetParser.getEcogridResult();

            System.out

                    .println(EcogridResultsetTransformer.toXMLString(records));

            response.setContentType("text/xml");

            out = response.getWriter();

            out.print(EcogridResultsetTransformer.toXMLString(records));

        } catch (Exception e) {

            e.printStackTrace();

        }*/

  }

  /**

   * Returns the object format registered in the DataONE Object Format 

   * Vocabulary for the given format identifier

   * 

   * @param fmtid - the identifier of the format requested

   * 

   * @return objectFormat - the object format requested

   * 

   * @throws ServiceFailure

   * @throws NotFound

   * @throws InsufficientResources

   * @throws NotImplemented

   */

  @Override

  public ObjectFormat getFormat(ObjectFormatIdentifier fmtid)

    throws ServiceFailure, NotFound, NotImplemented {

      return ObjectFormatService.getInstance().getFormat(fmtid);

  }

  /**

   * Returns a list of all object formats registered in the DataONE Object 

   * Format Vocabulary

    * 

   * @return objectFormatList - The list of object formats registered in 

   *                            the DataONE Object Format Vocabulary

   * 

   * @throws ServiceFailure

   * @throws NotImplemented

   * @throws InsufficientResources

   */

  @Override

  public ObjectFormatList listFormats() 

    throws ServiceFailure, NotImplemented {

    return ObjectFormatService.getInstance().listFormats();

  }

  /**

   * Returns a list of nodes that have been registered with the DataONE infrastructure

    * 

   * @return nodeList - List of nodes from the registry

   * 

   * @throws ServiceFailure

   * @throws NotImplemented

   */

  @Override

  public NodeList listNodes() 

    throws NotImplemented, ServiceFailure {

    throw new NotImplemented("4800", "listNodes not implemented");

  }

  /**

   * Provides a mechanism for adding system metadata independently of its 

   * associated object, such as when adding system metadata for data objects.

    * 

   * @param session - the Session object containing the credentials for the Subject

   * @param pid - The identifier of the object to register the system metadata against

   * @param sysmeta - The system metadata to be registered

   * 

   * @return true if the registration succeeds

   * 

   * @throws NotImplemented

   * @throws NotAuthorized

   * @throws ServiceFailure

   * @throws InvalidRequest

   * @throws InvalidSystemMetadata

   */

  @Override

  public Identifier registerSystemMetadata(Session session, Identifier pid,

      SystemMetadata sysmeta) 

      throws NotImplemented, NotAuthorized, ServiceFailure, InvalidRequest, 

      InvalidSystemMetadata {

      // The lock to be used for this identifier

      Lock lock = null;

      // TODO: control who can call this?

      if (session == null) {

          //TODO: many of the thrown exceptions do not use the correct error codes

          //check these against the docs and correct them

          throw new NotAuthorized("4861", "No Session - could not authorize for registration." +

                  "  If you are not logged in, please do so and retry the request.");

      }

      // verify that guid == SystemMetadata.getIdentifier()

      logMetacat.debug("Comparing guid|sysmeta_guid: " + pid.getValue() + 

          "|" + sysmeta.getIdentifier().getValue());

      if (!pid.getValue().equals(sysmeta.getIdentifier().getValue())) {

          throw new InvalidRequest("4863", 

              "The identifier in method call (" + pid.getValue() + 

              ") does not match identifier in system metadata (" +

              sysmeta.getIdentifier().getValue() + ").");

      }

      try {

          lock = HazelcastService.getInstance().getLock(sysmeta.getIdentifier().getValue());

          lock.lock();

          logMetacat.debug("Locked identifier " + pid.getValue());

          logMetacat.debug("Checking if identifier exists...");

          // Check that the identifier does not already exist

          if (HazelcastService.getInstance().getSystemMetadataMap().containsKey(pid)) {

              throw new InvalidRequest("4863", 

                  "The identifier is already in use by an existing object.");

          }

          // insert the system metadata into the object store

          logMetacat.debug("Starting to insert SystemMetadata...");

          try {

              sysmeta.setSerialVersion(BigInteger.ONE);

              sysmeta.setDateSysMetadataModified(Calendar.getInstance().getTime());

              HazelcastService.getInstance().getSystemMetadataMap().put(sysmeta.getIdentifier(), sysmeta);

          } catch (RuntimeException e) {

            logMetacat.error("Problem registering system metadata: " + pid.getValue(), e);

              throw new ServiceFailure("4862", "Error inserting system metadata: " + 

                  e.getClass() + ": " + e.getMessage());

          }

      } catch (RuntimeException e) {

          throw new ServiceFailure("4862", "Error inserting system metadata: " + 

                  e.getClass() + ": " + e.getMessage());

      }  finally {

          lock.unlock();

          logMetacat.debug("Unlocked identifier " + pid.getValue());

      }

      logMetacat.debug("Returning from registerSystemMetadata");

      EventLog.getInstance().log(request.getRemoteAddr(), 

          request.getHeader("User-Agent"), session.getSubject().getValue(), 

          pid.getValue(), "registerSystemMetadata");

      return pid;

  }

  /**

   * Given an optional scope and format, reserves and returns an identifier 

   * within that scope and format that is unique and will not be 

   * used by any other sessions. 

    * 

   * @param session - the Session object containing the credentials for the Subject

   * @param pid - The identifier of the object to register the system metadata against

   * @param scope - An optional string to be used to qualify the scope of 

   *                the identifier namespace, which is applied differently 

   *                depending on the format requested. If scope is not 

   *                supplied, a default scope will be used.

   * @param format - The optional name of the identifier format to be used, 

   *                  drawn from a DataONE-specific vocabulary of identifier 

   *                 format names, including several common syntaxes such 

   *                 as DOI, LSID, UUID, and LSRN, among others. If the 

   *                 format is not supplied by the caller, the CN service 

   *                 will use a default identifier format, which may change 

   *                 over time.

   * 

   * @return true if the registration succeeds

   * 

   * @throws InvalidToken

   * @throws ServiceFailure

   * @throws NotAuthorized

   * @throws IdentifierNotUnique

   * @throws NotImplemented

   */

  @Override

  public Identifier reserveIdentifier(Session session, Identifier pid)

  throws InvalidToken, ServiceFailure,

        NotAuthorized, IdentifierNotUnique, NotImplemented, InvalidRequest {

    throw new NotImplemented("4191", "reserveIdentifier not implemented on this node");

  }

  @Override

  public Identifier generateIdentifier(Session session, String scheme, String fragment)

  throws InvalidToken, ServiceFailure,

        NotAuthorized, NotImplemented, InvalidRequest {

    throw new NotImplemented("4191", "generateIdentifier not implemented on this node");

  }

  /**

    * Checks whether the pid is reserved by the subject in the session param

    * If the reservation is held on the pid by the subject, we return true.

    * 

   * @param session - the Session object containing the Subject

   * @param pid - The identifier to check

   * 

   * @return true if the reservation exists for the subject/pid

   * 

   * @throws InvalidToken

   * @throws ServiceFailure