Metacat

/**

 *  '$RCSfile$'

 *    Purpose: Implements a service for managing a Hazelcast cluster member

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

 *             National Center for Ecological Analysis and Synthesis

 *    Authors: Christopher Jones

 *

 *   '$Author$'

 *     '$Date$'

 * '$Revision$'

 *

 * 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

 */

import java.util.Date;

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

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

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

import com.hazelcast.core.EntryListener;

import com.hazelcast.core.MembershipListener;

import com.hazelcast.partition.PartitionService;

import com.hazelcast.query.Predicate;

import com.hazelcast.query.PredicateBuilder;

import edu.ucsb.nceas.metacat.McdbDocNotFoundException;

import edu.ucsb.nceas.metacat.dataone.D1NodeService;

import edu.ucsb.nceas.metacat.shared.ServiceException;

 * The Hazelcast service enables Metacat as a Hazelcast cluster member

 */

public class HazelcastService extends BaseService

/* The instance of the logging class */

  /* The singleton instance of the hazelcast service */

  private Config hzConfig;

  /* The name of the DataONE Hazelcast cluster group */

  private String groupName;

  /* The name of the DataONE Hazelcast cluster password */

  private String groupPassword;

  /* The name of the DataONE Hazelcast cluster IP addresses */

  private String addressList;

  /* The name of the node map */

  private String nodeMap;

  /* The name of the system metadata map */

  private String systemMetadataMap;

  /* The Hazelcast distributed task id generator namespace */

  private String taskIds;

  /* The Hazelcast distributed system metadata map */

  private IMap<Identifier, SystemMetadata> systemMetadata;

  private String identifiersSet;

  /* The Hazelcast distributed identifiers set */

  private ISet<Identifier> identifiers;

   * Constructor: Creates an instance of the hazelcast service. Since

   * this uses a singleton pattern, use getInstance() to gain the instance.

   */

  private HazelcastService() {

    super();

    _serviceName="HazelcastService";

    try {

    } catch (ServiceException se) {

    }

  }

  /**

   *  Get the instance of the HazelcastService that has been instantiated,

   *  or instantiate one if it has not been already.

   *

   * @return hazelcastService - The instance of the hazelcast service

   */

  public static HazelcastService getInstance(){

    }

  /**

	Config config = null;

	try {

		configFileName = PropertyService.getProperty("dataone.hazelcast.configFilePath");

		config = new FileSystemXmlConfig(configFileName);

	} catch (Exception e) {

		configFileName = PropertyService.CONFIG_FILE_DIR + FileUtil.getFS() + "hazelcast.xml";

		try {

			config = new FileSystemXmlConfig(configFileName);

		} catch (FileNotFoundException e1) {

			String msg = e.getMessage();

			logMetacat.error(msg);

			throw new ServiceException(msg);

		}

	}

	Hazelcast.init(config);

    try {

      groupName =

        PropertyService.getProperty("dataone.hazelcast.processCluster.groupName");

      groupPassword =

        PropertyService.getProperty("dataone.hazelcast.processCluster.password");

      addressList =

        PropertyService.getProperty("dataone.hazelcast.processCluster.instances");

      systemMetadataMap =

        PropertyService.getProperty("dataone.hazelcast.storageCluster.systemMetadataMap");

//    nodeMap =

//    PropertyService.getProperty("dataone.hazelcast.processCluster.nodesMap");

//      hzClient =

//        HazelcastClient.newHazelcastClient(this.groupName, this.groupPassword, addresses);

//      nodes = hzClient.getMap(nodeMap);

      // Get a reference to the shared system metadata map as a cluster member

      identifiers = Hazelcast.getSet(identifiersSet);

      systemMetadata.addEntryListener(this, true);

      hzInstance.getCluster().addMembershipListener(this);

      String msg = "Couldn't find Hazelcast properties for the DataONE clusters. " +

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

      logMetacat.error(msg);

    // make sure we have all metadata locally

    try {

	    // add index for resynch() method

	    //systemMetadata.addIndex(SINCE_PROPERTY, true);

		//resynch();

		String msg = "Problem synchronizing system metadata. " + e.getMessage();

		logMetacat.error(msg, e);

	}

   * Get the system metadata map

   *

   * @return systemMetadata - the hazelcast map of system metadata

	  return systemMetadata;

  }

  /**

   * @return identifiers - the set of unique DataONE identifiers in the cluster

   */

  public ISet<Identifier> getIdentifiers() {

      return identifiers;

  }

  /**

   * in-memory representation of it.

   * @param guid

   */

  public void refreshSystemMetadataEntry(String guid) {

	Identifier identifier = new Identifier();

	identifier.setValue(guid);

	// force hazelcast to update system metadata in memory from the store

	HazelcastService.getInstance().getSystemMetadataMap().evict(identifier);

  }

    try {

    } catch (RuntimeException e) {

        logMetacat.info("Couldn't get a lock for identifier " +

    return lock;

  }

   * Get the DataONE hazelcast node map

   * @return nodes - the hazelcast map of nodes

   */

//	  return nodes;

//  }

   * Indicate whether or not this service is refreshable.

   *

   * @return refreshable - the boolean refreshable status

   */

  public boolean refreshable() {

    // and start back up again

    return false;

  }

  /**

   * Stop the HazelcastService. When stopped, the service will no longer

   * respond to requests.

   */

  public void stop() throws ServiceException {

    Hazelcast.getLifecycleService().shutdown();

  }

      return this.hzInstance;

  }

  /**

   * Refresh the Hazelcast service by restarting it

   */

  /**

	 * Implement the EntryListener interface for Hazelcast, reponding to entry

	 * added events in the hzSystemMetadata map. Evaluate the entry and create

	 * CNReplicationTasks as appropriate (for DATA, METADATA, RESOURCE)

	 *

	 * @param event - The EntryEvent that occurred

	 */

	  logMetacat.info("SystemMetadata entry added event on identifier " +

	      event.getKey().getValue());

		entryUpdated(event);

	 * Implement the EntryListener interface for Hazelcast, reponding to entry

	 * evicted events in the hzSystemMetadata map.  Evaluate the entry and create

	 * CNReplicationTasks as appropriate (for DATA, METADATA, RESOURCE)

	 *

	 * @param event - The EntryEvent that occurred

	 */

      logMetacat.info("SystemMetadata entry evicted event on identifier " +

          event.getKey().getValue());

      if ( !identifiers.contains(event.getKey()) ) {

          identifiers.add(event.getKey());

      }

	}

	/**

	 * Implement the EntryListener interface for Hazelcast, reponding to entry

	 * removed events in the hzSystemMetadata map.  Evaluate the entry and create

	 * CNReplicationTasks as appropriate (for DATA, METADATA, RESOURCE)

	 *

	 * @param event - The EntryEvent that occurred

	 */

    logMetacat.info("SystemMetadata entry removed event on identifier " +

        event.getKey().getValue());

	  // we typically don't remove objects in Metacat, but can remove System Metadata

    // keep the hzIdentifiers set in sync with the systemmetadata table

    if ( identifiers.contains(event.getKey()) ) {

        identifiers.remove(event.getKey());

    }

	/**

	 * Implement the EntryListener interface for Hazelcast, reponding to entry

	 * updated events in the hzSystemMetadata map.  Evaluate the entry and create

	 * CNReplicationTasks as appropriate (for DATA, METADATA, RESOURCE)

	 *

	 * @param event - The EntryEvent that occurred

	 */

			    event.getKey().getValue());

			Partition partition = partitionService.getPartition(event.getKey());

			Member ownerMember = partition.getOwner();

			if (!ownerMember.localMember()) {

				// need to pull the entry into the local store

			// TODO evaluate the type of system metadata change, decide if it

			// warrants a replication event, what type (DATA, METADATA, RESOURCE),

			// iteratively lock the PID, create and submit the tasks, and expect a

			// result back. Deal with exceptions.

			if (sysmeta != null) {

				boolean isMetadata = D1NodeService.isScienceMetadata(event.getValue());

				// TODO: do we need to do anything explicit here?

			}

	     // ensure identifiers are listed in the hzIdentifiers set

      if ( !identifiers.contains(event.getKey()) ) {

          identifiers.add(event.getKey());

      }

	/**

	 * Save SystemMetadata to local store if needed

	 * @param sm

	 */

	private void saveLocally(SystemMetadata sm) {

		logMetacat.debug("Saving entry locally: " + sm.getIdentifier().getValue());

		try {

			if (!IdentifierManager.getInstance().systemMetadataExists(sm.getIdentifier().getValue())) {

				IdentifierManager.getInstance().updateSystemMetadata(sm);

		} catch (McdbDocNotFoundException e) {

    } catch (InvalidSystemMetadata e) {

        logMetacat.error("Could not save System Metadata to local store.", e);

    }

	public void resynch() throws Exception {

		// get the CN that is online

		// TODO: do we even need to use a specific CN?

		// All the System Metadata records should be available via the shared map

//		NodeList allNodes = CNodeService.getInstance().listNodes();

//		Node onlineCN = null;

//		for (Node node: allNodes.getNodeList()) {

//			if (node.getType().equals(NodeType.CN)) {

//				if (node.getState().equals(NodeState.UP)) {

//					onlineCN = node;

//					break;

//				}

//			}

//		}

		// get the list of items that have changed since X

		Date since = IdentifierManager.getInstance().getLastModifiedDate();

		EntryObject e = new PredicateBuilder().getEntryObject();

		Predicate predicate = e.get(SINCE_PROPERTY).greaterEqual(since);

		Collection<SystemMetadata> updatedSystemMetadata = getSystemMetadataMap().values(predicate);

		for (SystemMetadata sm: updatedSystemMetadata) {

			saveLocally(sm);

		}

	}

	 * When there is missing SystemMetadata on the local member,

	 * we retrieve it from the shared map and add it to the local

	 * backing store for safe keeping.

	 */

	@Override

	public void memberAdded(MembershipEvent event) {

		Member member = event.getMember();

		logMetacat.debug("Member added to cluster: " + member.getInetSocketAddress());

		boolean isLocal = member.localMember();

		if (isLocal) {

			logMetacat.debug("Member islocal: " + member.getInetSocketAddress());

			List<String> localIds = IdentifierManager.getInstance().getLocalIdsWithNoSystemMetadata(true);

			if (localIds != null) {

				logMetacat.debug("Member missing SystemMetadata entries, count = " + localIds.size());

				for (String localId: localIds) {

					logMetacat.debug("Processing system metadata for localId: " + localId);

					try {

						String docid = DocumentUtil.getSmartDocId(localId);

						int rev = DocumentUtil.getRevisionFromAccessionNumber(localId);

						String guid = IdentifierManager.getInstance().getGUID(docid, rev);

						logMetacat.debug("Found mapped guid: " + guid);

						Identifier pid = new Identifier();

						pid.setValue(guid);

						SystemMetadata sm = systemMetadata.get(pid);

						logMetacat.debug("Found shared system metadata for guid: " + guid);

						saveLocally(sm);

						logMetacat.debug("Saved shared system metadata locally for guid: " + guid);

					} catch (Exception e) {

						logMetacat.error("Could not save shared SystemMetadata entry locally, localId: " + localId, e);

					}

				}

			}

		}

	}

	@Override

	public void memberRemoved(MembershipEvent event) {

		// TODO Auto-generated method stub

	}