001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: /*
043: * DeploymentPluginProvider.java
044: *
045: */
046: package org.netbeans.spi.mobility.deployment;
047:
048: import java.awt.Component;
049: import java.util.Map;
050:
051: /**
052: * DeploymentPlugin is an SPI providing all the functionality and UI necessary to handle one deployment type (deployment method) to the NetBeans Mobility.<p>
053: * The plugin provides:
054: * <ul><li>deployment method name and display name</li>
055: * <li>set of global properties, their default values, and customizer (for usage in Mobility Deployment Manager)</li>
056: * <li>set of project properties, their default values, and customizer (for usage in each project customizer)</li></ul>
057: * <p>
058: * Default deployment plugins bundled with NetBeans Mobility are for example: <samp>Copy, Ftp, Scp, WebDAV, SonyEricsson</samp>, etc....
059: * @author Adam Sotona
060: */
061: public interface DeploymentPlugin {
062:
063: /**
064: * This method defines the deployment method unique name used for identification (non-localized).<p>
065: * It is highly recomended to use Java identifier as the name (no spaces nor special characters).<p>
066: * For example: <samp>Copy, Ftp, WebDAV,</samp> etc...
067: * @return deployment method identification name
068: */
069: public String getDeploymentMethodName();
070:
071: /**
072: * This method defines human-readable name of the method.<p>
073: * The name can be longer and localized.<p>
074: * For example: <samp>File Transfer Protocol (FTP)</samp>, or <samp>Secure Copy (SCP, SFTP)</samp>.
075: * @return Display name of the deployment method.
076: */
077: public String getDeploymentMethodDisplayName();
078:
079: /**
080: * Defines location of the Ant script performing the deployment.<p>
081: * The script has to define a default target which performs the deployment.<p>
082: * The script may depend on all well known project properties as it is called from the project build script.<p>
083: * In addition there is a special <samp><nb-enter-password</samp> task. This task can be used to invoke NetBeans styled dialog to enter specific connection parameters during the execution (usually missing password).<p>
084: * For inspiration please take a look at the the default set of deployment type Ant scripts provided by NetBeans Mobility (under <samp>modules/scr/</samp>).
085: * @return relative path of the Ant Script from install root, e.g. <samp>modules/scr/deploy-xxx-impl.xml</samp> (always using <samp>/</samp> as a separator, regardless of platform).
086: */
087: public String getAntScriptLocation();
088:
089: /**
090: * This method defines set of Ant properties that will be stored in each project (physically in <samp>nbproject/project.properties</samp>).<p>
091: * There can be unlimited number of project configurations and each can define its own set of values for these properties.<p>
092: * The correct property management and project configurations management is guaranted by Project Customizer and it is transparent for this plugin.<p>
093: * To avoid collisions it is highly recommended to prefix all properties following way: <samp>deployment.<deployment method name>.</samp>.<p>
094: * The default values of the properties can be of following types:
095: * <ul><li>String - for customization using text component, combo box, or radio button group</li>
096: * <li>Boolean - for customization using check box</li>
097: * <li>Integer - for customization using slider, or spinner</li>
098: * <li>File - for customization using text component and storage as a file reference</li></ul>
099: * @return Map of properties and their default values.<p>
100: * Do not return null.<p>
101: * Empty map returned means no project-based management and customization is requested by this plugin.
102: */
103: public Map<String, Object> getProjectPropertyDefaultValues();
104:
105: /**
106: * This method defines set of Ant properties that will be stored globally in the IDE (physically in <samp><userdir>/Build.properties</samp>).<p>
107: * There can be unlimited number of instances of each deployment plugin stored globally. Each instance defines its own set of values for these properties.<p>
108: * The property management and deployment instances management is guaranted by Mobility Deployment Manager and it is transparent for this plugin.<p>
109: * To avoid collisions it is highly recommended to prefix all properties following way: <samp>deployment.<deployment method name>.</samp>.<p>
110: * The default values of the properties can be of following types:
111: * <ul><li>String - for customization using text component, combo box, or radio button group</li>
112: * <li>Boolean - for customization using check box</li>
113: * <li>Integer - for customization using slider, or spinner</li></ul>
114: * @return Map of properties and their default values.<p>
115: * Do not return null.<p>
116: * Empty map returned means no global management and customization is requested by this plugin.
117: */
118: public Map<String, Object> getGlobalPropertyDefaultValues();
119:
120: /**
121: * This method returns UI panel for project-specific customization of the deployment plugin.<p>
122: * Project customizer automatically scans the panel structure recursivelly, attach the listeners, read and write the property values.<p>
123: * All the properties customized by this panel must be defined by getProjectPropertyDefaultValues method.<p>
124: * The connection between properties and UI components is defined through the name matching. It means that each component that should be assigned to a property must return the property name by method <samp>getName()</samp>. You can assign a name to any of the component by calling <code>setName("<property name>")</code><p>
125: * <ul><li>JTextComponent (JTextField, etc...) can have assigned property with String or File default value.</li>
126: * <li>JCheckBox can have assigned property with Boolean default value. The boolean value of the property is matched with the selection status.</li>
127: * <li>JComboBox can have assigned property with String default value. </li>
128: * <li>JSlider can have assigned property with Integer value.</li>
129: * <li>JSpinner can have assigned property with Integer value.</li>
130: * <li>JRadioButton can have assigned property with String default value. The radio button will be selected when its <samp>action command</samp> equals to the property value. The property value will be set to the radio button <samp>action command</samp> when selected. The <samp>action command</samp> is taken from method <samp>getActionCommand()</samp> and you can set it by calling <samp>setActionCommand("<property value>")</samp> on the component.</li></ul>
131: * <p>
132: * There are no limitation of the other functionality provided by the customizer panel.
133: * @return UI component that defines the customizer panel (usually JPanel) or null if the customizer is not provided.
134: */
135: public Component createProjectCustomizerPanel();
136:
137: /**
138: * This method returns UI panel for IDE global customization of the deployment plugin inside Mobility Deployment Manager.<p>
139: * Mobility Deployment Manager automatically scans the panel structure recursivelly, attach the listeners, read and write the property values.<p>
140: * All the properties customized by this panel must be defined by getGlobalPropertyDefaultValues method.<p>
141: * The connection between properties and UI components is defined through the name matching. It means that each component that should be assigned to a property must return the property name by method <samp>getName()</samp>. You can assign a name to any of the component by calling <code>setName("<property name>")</code><p>
142: * <ul><li>JTextComponent (JTextField, etc...) can have assigned property with String default value.</li>
143: * <li>JCheckBox can have assigned property with Boolean default value. The boolean value of the property is matched with the selection status.</li>
144: * <li>JComboBox can have assigned property with String default value.</li>
145: * <li>JSlider can have assigned property with Integer value.</li>
146: * <li>JSpinner can have assigned property with Integer value.</li>
147: * <li>JRadioButton can have assigned property with String default value. The radio button will be selected when its <samp>action command</samp> equals to the property value. The property value will be set to the radio button <samp>action command</samp> when selected. The <samp>action command</samp> is taken from method <samp>getActionCommand()</samp> and you can set it by calling <samp>setActionCommand("<property value>")</samp> on the component.</li></ul>
148: * <p>
149: * There are no limitation of the other functionality provided by the customizer panel.
150: * @return UI component that defines the customizer panel (usually JPanel) or null if the customizer is not provided.
151: */
152: public Component createGlobalCustomizerPanel();
153: }
|