/*
 * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
 * 
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The contents of this file are subject to the terms of either the Universal Permissive License
 * v 1.0 as shown at http://oss.oracle.com/licenses/upl
 *
 * or the following license:
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted
 * provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice, this list of conditions
 * and the following disclaimer.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
 * conditions and the following disclaimer in the documentation and/or other materials provided with
 * the distribution.
 * 
 * 3. Neither the name of the copyright holder nor the names of its contributors may be used to
 * endorse or promote products derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
 * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.openjdk.jmc.rjmx.subscription;

import org.openjdk.jmc.rjmx.IConnectionHandle;
import org.openjdk.jmc.ui.common.util.IObservable;

/**
 * Manages {@link IMRIMetadata}s and metadata associated with {@link IMRIMetadata}s. This is one of
 * the standard services usually available from an {@link IConnectionHandle}.
 */
public interface IMRIMetadataService extends IObservable {

	/**
	 * Returns the basic {@link IMRIMetadata} associated with an {@link MRI}.
	 *
	 * @param descriptor
	 *            the {@link MRI} for which to retrieve the data.
	 * @return the basic {@link IMRIMetadata} associated with an {@link MRI}.
	 */
	IMRIMetadata getMetadata(MRI descriptor);

	/**
	 * Looks up the specified piece of metadata associated with the specified {@link MRI}.
	 *
	 * @param mri
	 *            the {@link MRI} for which to retrieve the data.
	 * @param dataKey
	 *            the key for the data to retrieve.
	 * @return the metadata resulting from the lookup, or null if no such data exist.
	 */
	Object getMetadata(MRI mri, String dataKey);

	/**
	 * Updates the metadata associated with the {@link MRI}.
	 *
	 * @param mri
	 *            the {@link MRI}.
	 * @param dataKey
	 *            the data key under which to store the metadata.
	 * @param data
	 *            the actual metadata.
	 */
	void setMetadata(MRI mri, String dataKey, String data);
}
