All Downloads are FREE. Search and download functionalities are using the official Maven repository.

net.officefloor.eclipse.socket.HttpParametersLoaderWorkSourceExtension Maven / Gradle / Ivy

There is a newer version: 3.12.0
Show newest version
/*
 * OfficeFloor - http://www.officefloor.net
 * Copyright (C) 2005-2013 Daniel Sagenschneider
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package net.officefloor.eclipse.socket;

import net.officefloor.compile.properties.PropertyList;
import net.officefloor.eclipse.extension.util.SourceExtensionUtil;
import net.officefloor.eclipse.extension.worksource.TaskDocumentationContext;
import net.officefloor.eclipse.extension.worksource.WorkSourceExtension;
import net.officefloor.eclipse.extension.worksource.WorkSourceExtensionContext;
import net.officefloor.plugin.socket.server.http.HttpRequest;
import net.officefloor.plugin.web.http.parameters.source.HttpParametersLoaderWorkSource;
import net.officefloor.plugin.web.http.parameters.source.HttpParametersLoaderWorkSource.HttpParametersLoaderTask;

import org.eclipse.swt.widgets.Composite;

/**
 * {@link WorkSourceExtension} for the {@link HttpParametersLoaderWorkSource}.
 * 
 * @author Daniel Sagenschneider
 */
public class HttpParametersLoaderWorkSourceExtension
		extends
		AbstractSocketWorkSourceExtension {

	/**
	 * Initiate.
	 */
	public HttpParametersLoaderWorkSourceExtension() {
		super(HttpParametersLoaderWorkSource.class, "Http Parameters Loader");
	}

	/*
	 * ================== WorkSourceExtension =================================
	 */

	@Override
	public Class getWorkSourceClass() {
		return HttpParametersLoaderWorkSource.class;
	}

	@Override
	public void createControl(Composite page, WorkSourceExtensionContext context) {

		// Properties
		SourceExtensionUtil.loadPropertyLayout(page);
		SourceExtensionUtil.createPropertyClass("Bean type",
				HttpParametersLoaderWorkSource.PROPERTY_TYPE_NAME, page,
				context, null);
		SourceExtensionUtil.createPropertyCheckbox("Case sensitive names",
				HttpParametersLoaderWorkSource.PROPERTY_CASE_INSENSITIVE, true,
				Boolean.TRUE.toString(), Boolean.FALSE.toString(), page,
				context, null);
	}

	@Override
	public String getSuggestedWorkName(PropertyList properties) {

		// Obtain the bean type
		String beanTypeName = properties.getProperty(
				HttpParametersLoaderWorkSource.PROPERTY_TYPE_NAME).getValue();
		int simpleNameIndex = beanTypeName.lastIndexOf('.');
		if (simpleNameIndex >= 0) {
			// Strip to simple name (+1 to ignore '.')
			beanTypeName = beanTypeName.substring(simpleNameIndex + 1);
		}

		// Return the name
		return "Http load " + beanTypeName;
	}

	@Override
	public String getTaskDocumentation(TaskDocumentationContext context)
			throws Throwable {

		// Should always have the one task

		// Obtain the object type
		String objectType = context.getPropertyList().getPropertyValue(
				HttpParametersLoaderWorkSource.PROPERTY_TYPE_NAME,
				"");

		// Return documentation
		return "Loads HTTP parameter values of the "
				+ HttpRequest.class.getSimpleName() + " onto the object ("
				+ objectType + ") via the corresponding setXxx(...) methods.";
	}

}