View Javadoc

1   /*
2    *  soapUI, copyright (C) 2004-2009 eviware.com 
3    *
4    *  soapUI is free software; you can redistribute it and/or modify it under the 
5    *  terms of version 2.1 of the GNU Lesser General Public License as published by 
6    *  the Free Software Foundation.
7    *
8    *  soapUI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without 
9    *  even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
10   *  See the GNU Lesser General Public License for more details at gnu.org.
11   */
12  
13  package com.eviware.soapui.impl.wsdl.actions.iface.tools.cxf;
14  
15  import java.io.File;
16  import java.io.IOException;
17  
18  import com.eviware.soapui.SoapUI;
19  import com.eviware.soapui.impl.wsdl.actions.iface.tools.support.AbstractToolsAction;
20  import com.eviware.soapui.impl.wsdl.actions.iface.tools.support.ArgumentBuilder;
21  import com.eviware.soapui.impl.wsdl.actions.iface.tools.support.ProcessToolRunner;
22  import com.eviware.soapui.impl.wsdl.actions.iface.tools.support.ToolHost;
23  import com.eviware.soapui.impl.wsdl.support.HelpUrls;
24  import com.eviware.soapui.model.iface.Interface;
25  import com.eviware.soapui.settings.ToolsSettings;
26  import com.eviware.soapui.support.Tools;
27  import com.eviware.soapui.support.UISupport;
28  import com.eviware.soapui.support.types.StringToStringMap;
29  import com.eviware.x.form.XForm;
30  import com.eviware.x.form.XFormDialog;
31  import com.eviware.x.form.XFormDialogBuilder;
32  import com.eviware.x.form.XFormFactory;
33  
34  /***
35   * Invokes Apache CXF wsdl2java utility
36   * 
37   * @author Ole.Matzura
38   */
39  
40  public class CXFAction extends AbstractToolsAction<Interface>
41  {
42  	private static final String PACKAGE = "Package";
43  	private static final String OUTPUT = "Output Directory";
44  	private static final String NAMESPACE_MAPPING = "Output Packages";
45  	private static final String CATALOG_FILE = "Catalog";
46  	private static final String SERVER_STUBS = "Server";
47  	private static final String CLIENT_STUBS = "Client";
48  	private static final String IMPL_STUBS = "Implementation";
49  	private static final String ANT_FILE = "build.xml";
50  	private static final String GENERATE_ALL = "All Code";
51  	private static final String COMPILE = "Compile";
52  	private static final String CLASSDIR = "Class Folder";
53  	private static final String VALIDATE = "Validate WSDL";
54  	private static final String EXCLUDE_NAMESPACES = "Exclude namespaces";
55  	private static final String EXSH = "EXSH";
56  	private static final String DNS = "DNS";
57  	private static final String DEX = "DEX";
58  
59  	public static final String SOAPUI_ACTION_ID = "CXFAction";
60  	private static final String BINDING_FILES = "Bindings";
61  
62  	public CXFAction()
63  	{
64  		super( "Apache CXF", "Generates Apache CXF code using the wsdl2java utility" );
65  	}
66  
67  	protected XFormDialog buildDialog( Interface modelItem )
68  	{
69  		XFormDialogBuilder builder = XFormFactory.createDialogBuilder( "Apache CXF Stubs" );
70  
71  		XForm mainForm = builder.createForm( "Basic" );
72  		addWSDLFields( mainForm, modelItem );
73  
74  		mainForm.addTextField( OUTPUT, "Root directory for all emitted files.", XForm.FieldType.PROJECT_FOLDER );
75  		mainForm.addTextField( PACKAGE, "Default Package for generated classes", XForm.FieldType.JAVA_PACKAGE );
76  		mainForm.addNameSpaceTable( NAMESPACE_MAPPING, modelItem );
77  
78  		mainForm.addCheckBox( CLIENT_STUBS, "Generates starting point code for a client mainline" );
79  		mainForm.addCheckBox( SERVER_STUBS, "Generates starting point code for a server mainline" );
80  		mainForm.addCheckBox( IMPL_STUBS, "Generates starting point code for an implementation object" );
81  		mainForm.addCheckBox( ANT_FILE, "Generates the Ant build.xml file" );
82  		mainForm.addCheckBox( GENERATE_ALL,
83  				"<html>Generates all starting point code: types, <br>service proxy, service interface, server mainline, "
84  						+ "<br>client mainline, implementation object, and an Ant build.xml file</html>" );
85  
86  		XForm advForm = builder.createForm( "Advanced" );
87  
88  		advForm.addTextField( BINDING_FILES, "Space-separated list of JAXWS or JAXB binding files", XForm.FieldType.TEXT );
89  		advForm.addCheckBox( COMPILE, "Compiles generated Java files" );
90  		advForm.addTextField( CLASSDIR, "The directory into which the compiled class files are written",
91  				XForm.FieldType.FOLDER );
92  
93  		advForm.addTextField( CATALOG_FILE, "The catalog file to map the imported wsdl/schema", XForm.FieldType.FILE );
94  
95  		advForm.addNameSpaceTable( EXCLUDE_NAMESPACES, modelItem );
96  		advForm.addCheckBox( EXSH, "Enables processing of extended soap header message binding" );
97  		advForm.addCheckBox( DNS, "Enables loading of the default namespace package name mapping" );
98  		advForm.addCheckBox( DEX, "Enables loading of the default excludes namespace mapping" );
99  		advForm.addCheckBox( VALIDATE, "Enables validating the WSDL before generating the code" );
100 
101 		buildArgsForm( builder, true, "wsdl2java" );
102 
103 		return builder.buildDialog( buildDefaultActions( HelpUrls.CXFWSDL2JAVA_HELP_URL, modelItem ),
104 				"Specify arguments for Apache CXF wsdl2java", UISupport.TOOL_ICON );
105 	}
106 
107 	protected StringToStringMap initValues( Interface modelItem, Object param )
108 	{
109 		StringToStringMap values = super.initValues( modelItem, param );
110 		values.putIfMissing( DNS, "true" );
111 		values.putIfMissing( DEX, "true" );
112 		return values;
113 	}
114 
115 	protected void generate( StringToStringMap values, ToolHost toolHost, Interface modelItem ) throws Exception
116 	{
117 		String xfireDir = SoapUI.getSettings().getString( ToolsSettings.CXF_LOCATION, null );
118 		if( Tools.isEmpty( xfireDir ) )
119 		{
120 			UISupport.showErrorMessage( "CXF directory must be set in global preferences" );
121 			return;
122 		}
123 
124 		ProcessBuilder builder = new ProcessBuilder();
125 		ArgumentBuilder args = buildArgs( modelItem );
126 		builder.command( args.getArgs() );
127 		builder.directory( new File( xfireDir ) );
128 
129 		toolHost.run( new ProcessToolRunner( builder, "Apache CXF wsdl2java", modelItem ) );
130 	}
131 
132 	private ArgumentBuilder buildArgs( Interface modelItem ) throws IOException
133 	{
134 		StringToStringMap values = dialog.getValues();
135 		values.put( OUTPUT, Tools.ensureDir( values.get( OUTPUT ), "" ) );
136 
137 		ArgumentBuilder builder = new ArgumentBuilder( values );
138 
139 		builder.startScript( "wsdl2java" );
140 		StringToStringMap nsMappings = StringToStringMap.fromXml( values.get( NAMESPACE_MAPPING ) );
141 		String packages = values.get( PACKAGE ).trim();
142 		for( String key : nsMappings.keySet() )
143 		{
144 			packages += " " + key + "=" + nsMappings.get( key );
145 		}
146 
147 		if>( packages.length() > 0 )
148 			builder.addBoolean( NAMESPACE_MAPPING, "-p", null, packages );
149 
150 		builder.addString( BINDING_FILES, "-b" );
151 		builder.addString( CATALOG_FILE, "-catalog" );
152 		builder.addString( OUTPUT, "-d" );
153 
154 		builder.addBoolean( COMPILE, "-compile" );
155 		builder.addString( CLASSDIR, "-classdir" );
156 
157 		builder.addBoolean( CLIENT_STUBS, "-client" );
158 		builder.addBoolean( SERVER_STUBS, "-server" );
159 		builder.addBoolean( IMPL_STUBS, "-impl" );
160 		builder.addBoolean( GENERATE_ALL, "-all" );
161 		builder.addBoolean( ANT_FILE, "-ant" );
162 
163 		StringToStringMap excludes = StringToStringMap.fromXml( values.get( EXCLUDE_NAMESPACES ) );
164 		for( String key : excludes.keySet() )
165 		{
166 			String value = excludes.get( key );
167 			if( value.equals( "-" ) )
168 				builder.addArgs( "-b", key );
169 			else
170 				builder.addArgs( "-b", key + "=" + value );
171 		}
172 
173 		builder.addBoolean( EXSH, "-exsh", "true", "false" );
174 		builder.addBoolean( DNS, "-dns", "true", "false" );
175 		builder.addBoolean( DEX, "-dex", "true", "false" );
176 		builder.addBoolean( VALIDATE, "-validate" );
177 
178 		builder.addArgs( "-verbose" );
179 		addToolArgs( values, builder );
180 		builder.addArgs( getWsdlUrl( values, modelItem ) );
181 		return builder;
182 	}
183 }