hudson.util.DescribableListUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hudson-core Show documentation
Contains the core Hudson code and view files to render HTML.
The newest version!
/*******************************************************************************
 *
 * Copyright (c) 2011 Oracle Corporation.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *
 *    Nikita Levyankov
 *
 *******************************************************************************/

package hudson.util;

import com.google.common.collect.Maps;
import hudson.model.Describable;
import hudson.model.Descriptor;
import hudson.model.Job;
import hudson.model.Saveable;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.logging.Level;
import java.util.logging.Logger;
import net.sf.json.JSONObject;
import org.eclipse.hudson.api.model.IProjectProperty;
import org.eclipse.hudson.model.project.property.ExternalProjectProperty;
import org.kohsuke.stapler.StaplerRequest;

/**
 * Utility class for DescribableList logic.
 * 
 * Date: 10/6/11
 *
 * @author Nikita Levyankov
 */
public final class DescribableListUtil {

    private static final Logger LOGGER = Logger.getLogger(DescribableListUtil.class.getName());

    private DescribableListUtil() {
    }

    /**
     * Builds the list by creating a fresh instances from the submitted form.
     * 

     * This method is almost always used by the owner. This method does not
     * invoke the save method.
     *
     * @param owner represents owner of {@link DescribableList}
     * @param req {@link StaplerRequest}
     * @param json Structured form data that includes the data for nested
     * descriptor list.
     * @param descriptors list of descriptors to create instances from.
     * @return list.
     * @throws IOException if any.
     * @throws Descriptor.FormException if any.
     */
    public static , D extends Descriptor> DescribableList buildFromJson(
            Saveable owner,
            StaplerRequest req,
            JSONObject json,
            List descriptors)
            throws Descriptor.FormException, IOException {
        List newList = new ArrayList();

        for (Descriptor d : descriptors) {
            String name = d.getJsonSafeClassName();
            if (json.has(name)) {
                newList.add(d.newInstance(req, json.getJSONObject(name)));
            }
        }
        return new DescribableList(owner, newList);
    }

    /**
     * Rebuilds the list by creating a fresh instances from the submitted form.
     * 

     * This version works with the the <f:hetero-list> UI tag, where the user
     * is allowed to create multiple instances of the same descriptor. Order is
     * also significant.
     *
     * @param owner represents owner of {@link DescribableList}
     * @param req {@link StaplerRequest}
     * @param formData {@link JSONObject} populated based on form data,
     * @param key the JSON property name for 'formData' that represents the data
     * for the list of {@link Describable}
     * @param descriptors list of descriptors to create instances from.
     * @return list.
     * @throws IOException if any.
     * @throws Descriptor.FormException if any.
     * @see
     * Descriptor#newInstancesFromHeteroList(org.kohsuke.stapler.StaplerRequest,
     * net.sf.json.JSONObject, String, java.util.Collection)
     */
    public static , D extends Descriptor> DescribableList buildFromHetero(
            Saveable owner,
            StaplerRequest req, JSONObject formData,
            String key,
            Collection descriptors)
            throws Descriptor.FormException, IOException {
        return new DescribableList(owner, Descriptor.newInstancesFromHeteroList(req, formData, key, descriptors));
    }

    /**
     * Converts describableList data to project properties map.
     * {@link hudson.model.Descriptor#getJsonSafeClassName()} is used as key,
     * value -
     * {@link org.eclipse.hudson.model.project.property.BaseProjectProperty}.
     *
     * @param describableList source.
     * @param owner new owner for properties.
     * @param  T describable
     * @param  Descriptor
     * @return map of converted properties.
     */
    public static , D extends Descriptor> Map> convertToProjectProperties(DescribableList describableList, Job owner) {
        Map> result = Maps.newConcurrentMap();
        if (null != describableList) {
            for (Map.Entry entry : describableList.toMap().entrySet()) {
                ExternalProjectProperty property = new ExternalProjectProperty(owner);
                String key = entry.getKey().getJsonSafeClassName();
                property.setKey(key);
                property.setValue(entry.getValue());
                result.put(key, property);
            }
        }
        return result;
    }

    /**
     * Converts collection of {@link ExternalProjectProperty} descriptors to
     * {@link DescribableList}
     *
     * @param descriptors .
     * @param owner new owner for properties.
     * @return {@link DescribableList}
     */
    public static > DescribableList> convertToDescribableList(
            List> descriptors, Job owner) {
        return convertToDescribableList(descriptors, owner, ExternalProjectProperty.class);
    }

    /**
     * Converts collection of propertyClass descriptors to
     * {@link DescribableList}
     *
     * @param descriptors .
     * @param owner new owner for properties.
     * @param propertyClass projectProperty
     * @return {@link DescribableList}
     */
    @SuppressWarnings("unchecked")
    public static , D extends Descriptor, P extends IProjectProperty> DescribableList convertToDescribableList(List descriptors, Job owner, Class propertyClass) {
        List describableList = new CopyOnWriteArrayList();
        DescribableList result = new DescribableList(owner);
        for (Descriptor descriptor : descriptors) {
            IProjectProperty property =
                    CascadingUtil.getProjectProperty(owner, descriptor.getJsonSafeClassName(), propertyClass);
            if (null != property.getValue()) {
                describableList.add(property.getValue());
            }
        }
        try {
            owner.setAllowSave(false);
            result.addAll(describableList);
            owner.setAllowSave(true);
        } catch (IOException e) {
            LOGGER.log(Level.WARNING, "Failed to add list of describable elements", e);
        }
        return result;
    }
}