JobMetadataContributor.java

/*
 *  The MIT License
 *
 *  Copyright 2011 Sony Ericsson Mobile Communications. All rights reserved.
 *
 *  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 com.sonyericsson.hudson.plugins.metadata.contributors;

import com.sonyericsson.hudson.plugins.metadata.model.values.MetadataValue;
import hudson.ExtensionList;
import hudson.ExtensionPoint;
import hudson.model.AbstractProject;
import hudson.model.Hudson;

import java.util.List;

/**
 * Extension point for plugins to contribute meta data to jobs. When ever a project is saved all contributors will be
 * asked to provide their meta-data for that project.
 *
 * @author Robert Sandell <robert.sandell@sonyericsson.com>
 */
public abstract class JobMetadataContributor implements ExtensionPoint {

    /**
     * Provides the meta-data that should be inserted into the project.
     *
     * @param job the project.
     * @return a list of meta data.
     */
    public abstract List<MetadataValue> getMetaDataFor(AbstractProject job);

    /**
     * All the registered job contributors.
     *
     * @return the list.
     */
    public static ExtensionList<JobMetadataContributor> all() {
        return Hudson.getInstance().getExtensionList(JobMetadataContributor.class);
    }
}