MetadataBuildAction.java

/*
 *  The MIT License
 *
 *  Copyright 2011 Sony Ericsson Mobile Communications. All rights reserved.
 *  Copyright 2012 Sony Mobile Communications AB. 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.model;

import com.sonyericsson.hudson.plugins.metadata.Constants;
import com.sonyericsson.hudson.plugins.metadata.Messages;
import com.sonyericsson.hudson.plugins.metadata.model.values.MetadataValue;
import com.sonyericsson.hudson.plugins.metadata.model.values.ParentUtil;
import hudson.model.Hudson;
import hudson.model.Run;
import hudson.security.ACL;
import net.sf.json.JSON;

import java.io.IOException;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;
import jenkins.model.RunAction2;

/**
 * Holds the meta data for a run.
 *
 * @author Robert Sandell <robert.sandell@sonyericsson.com>
 */
@edu.umd.cs.findbugs.annotations.SuppressWarnings(
        value = "UG_SYNC_SET_UNSYNC_GET",
        justification = "It is synchronized")
public class MetadataBuildAction implements RunAction2, MetadataContainer<MetadataValue> {

    private transient Run run;
    private List<MetadataValue> values;

    /**
     * Constructor.
     *
     * @param run the run
     * @param values preset values
     */
    @Deprecated
    public MetadataBuildAction(Run run, List<MetadataValue> values) {
        this.run = run;
        if (values == null) {
            values = new LinkedList<MetadataValue>();
        }
        this.values = values;
    }

    /**
     * Constructor.
     *
     * @param run the run
     */
    @Deprecated
    public MetadataBuildAction(Run run) {
        this(run, null);
    }

    /**
     * Default constructor.
     */
    public MetadataBuildAction() {
        this.values = new LinkedList<MetadataValue>();
    }

    @Override
    public String getIconFileName() {
        return Constants.COMMON_ICON;
    }

    @Override
    public String getDisplayName() {
        return Messages.Actions_DisplayName();
    }

    @Override
    public String getUrlName() {
        return Constants.COMMON_URL_NAME;
    }

    @Override
    public void onAttached(Run<?, ?> r) {
        this.run = r;
    }

    @Override
    public void onLoad(Run<?, ?> r) {
        this.run = r;
    }

    /**
     * The run that this action is added to.
     *
     * @return the run.
     */
    public Run getRun() {
        return run;
    }

    /**
     * The meta data in this action.
     *
     * @return the meta data.
     *
     * @see #getChildren()
     */
    public synchronized List<MetadataValue> getValues() {
        if (values == null) {
            values = new LinkedList<MetadataValue>();
        }
        return values;
    }

    @Override
    public synchronized MetadataValue getChild(String name) {
        return ParentUtil.getChildValue(getValues(), name);
    }

    @Override
    public synchronized int indexOf(String name) {
        return ParentUtil.getChildIndex(values, name);
    }

    @Override
    public synchronized MetadataValue setChild(int index, MetadataValue value) {
        value.setParent(this);
        return values.set(index, value);
    }

    @Override
    public synchronized Collection<MetadataValue> addChild(MetadataValue value) {
        return ParentUtil.addChildValue(this, getValues(), value);
    }

    @Override
    public synchronized Collection<MetadataValue> addChildren(Collection<MetadataValue> childValues) {
        return ParentUtil.addChildValues(this, getValues(), childValues);
    }

    @Override
    public synchronized Collection<MetadataValue> getChildren() {
        return getValues();
    }

    @Override
    public Collection<String> getChildNames() {
        return ParentUtil.getChildNames(this);
    }

    @Override
    public String getFullName() {
        return "";
    }

    @Override
    public String getFullName(String separator) {
        return "";
    }

    @Override
    public String getFullNameFrom(MetadataParent base) {
        return "";
    }

    @Override
    public synchronized JSON toJson() {
        return ParentUtil.toJson(this);
    }

    @Override
    public boolean requiresReplacement() {
        return false;
    }

    @Override
    public synchronized void save() throws IOException {
        if (this.run != null) {
            this.run.save();
        } else {
            throw new IOException("This container is not attached to any build.");
        }
    }

    @Override
    public ACL getACL() {
        if (run != null) {
            return run.getACL();
        } else {
            return Hudson.getInstance().getACL();
        }
    }
}