HistoryDao.java

/*
 * The MIT License
 *
 * Copyright 2013 Mirko Friedenhagen.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package hudson.plugins.jobConfigHistory;

import java.util.SortedMap;

import hudson.XmlFile;
import hudson.model.AbstractItem;
import hudson.model.Node;

/**
 * Operations for historization of config files.
 *
 * @author Mirko Friedenhagen
 */
public interface HistoryDao {

	/**
	 * Saves the current configuration of an node.
	 *
	 * @param node
	 *            node
	 */
	void saveNode(Node node);

	/**
	 * Saves a copy of an xml file.
	 *
	 * @param file
	 *            xmlFile
	 */
	void saveItem(XmlFile file);

	/**
	 * Returns a sorted map of all revisions for this xmlFile.
	 *
	 * The key is an identifier which may be used in
	 * {@link HistoryDao#getOldRevision(hudson.model.AbstractItem, java.lang.String)}
	 *
	 * @param xmlFile
	 *            file
	 * @return old revisions mapped to the identifier.
	 */
	SortedMap<String, HistoryDescr> getRevisions(XmlFile xmlFile);

	/**
	 * Returns a sorted map of all revisions for this node.
	 *
	 * The key is an identifier which may be used in
	 * {@link HistoryDao#getOldRevision(hudson.model.Node, java.lang.String)}
	 *
	 * @param node
	 *            node
	 * @return old revisions mapped to the identifier.
	 */
	SortedMap<String, HistoryDescr> getRevisions(Node node);

	/**
	 * Returns one old configuration of item.
	 *
	 * @param item
	 *            project
	 * @param identifier
	 *            timestamp or hash
	 * @return old configuration.
	 */
	XmlFile getOldRevision(AbstractItem item, String identifier);

	/**
	 * Returns one old configuration of node.
	 *
	 * @param node
	 *            node
	 * @param identifier
	 *            timestamp or hash
	 * @return old configuration.
	 */
	XmlFile getOldRevision(Node node, String identifier);

	/**
	 * Returns one old configuration of xmlFile.
	 *
	 * @param xmlFile
	 *            file
	 * @param identifier
	 *            timestamp or hash
	 * @return old configuration.
	 */
	XmlFile getOldRevision(XmlFile xmlFile, String identifier);

	/**
	 * Returns one old configuration of file.
	 *
	 * @param configFileName
	 *            file
	 * @param identifier
	 *            timestamp or hash
	 * @return old configuration.
	 */
	XmlFile getOldRevision(String configFileName, String identifier);

	/**
	 * Returns whether the revision exists.
	 *
	 * @param node
	 *            node
	 * @param identifier
	 *            timestamp or hash
	 * @return old configuration.
	 */
	boolean hasOldRevision(Node node, String identifier);

	/**
	 * Returns whether the revision exists.
	 *
	 * @param xmlFile
	 *            file
	 * @param identifier
	 *            timestamp or hash
	 * @return old configuration.
	 */
	boolean hasOldRevision(XmlFile xmlFile, String identifier);

	/**
	 * Determines whether the given node has already been recorded in the
	 * history.
	 *
	 * @param node
	 *            the node to check for duplicate history.
	 * @return true if the node is a duplicate, false otherwise.
	 */
	boolean hasDuplicateHistory(final Node node);
}