/*******************************************************************************
*
* 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.
* <p/>
* 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.
* <p/>
* 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 <T extends Describable<T>, D extends Descriptor<T>> DescribableList<T, D> buildFromJson(
Saveable owner,
StaplerRequest req,
JSONObject json,
List<D> descriptors)
throws Descriptor.FormException, IOException {
List<T> newList = new ArrayList<T>();
for (Descriptor<T> d : descriptors) {
String name = d.getJsonSafeClassName();
if (json.has(name)) {
newList.add(d.newInstance(req, json.getJSONObject(name)));
}
}
return new DescribableList<T, D>(owner, newList);
}
/**
* Rebuilds the list by creating a fresh instances from the submitted form.
* <p/>
* 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 <T extends Describable<T>, D extends Descriptor<T>> DescribableList<T, D> buildFromHetero(
Saveable owner,
StaplerRequest req, JSONObject formData,
String key,
Collection<D> descriptors)
throws Descriptor.FormException, IOException {
return new DescribableList<T, D>(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> T describable
* @param <D> Descriptor
* @return map of converted properties.
*/
public static <T extends Describable<T>, D extends Descriptor<T>> Map<String, ExternalProjectProperty<T>> convertToProjectProperties(DescribableList<T, D> describableList, Job owner) {
Map<String, ExternalProjectProperty<T>> result = Maps.newConcurrentMap();
if (null != describableList) {
for (Map.Entry<D, T> entry : describableList.toMap().entrySet()) {
ExternalProjectProperty<T> property = new ExternalProjectProperty<T>(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 <T extends Describable<T>> DescribableList<T, Descriptor<T>> convertToDescribableList(
List<Descriptor<T>> 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 <T extends Describable<T>, D extends Descriptor<T>, P extends IProjectProperty> DescribableList<T, D> convertToDescribableList(List<D> descriptors, Job owner, Class<P> propertyClass) {
List<T> describableList = new CopyOnWriteArrayList<T>();
DescribableList<T, D> result = new DescribableList<T, D>(owner);
for (Descriptor<T> descriptor : descriptors) {
IProjectProperty<T> 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;
}
}