File	Doc	Category	Size	Date	Package
WsCompileInvoker.java	API Doc	Glassfish v2 API	9015	Fri May 04 22:32:00 BST 2007	com.sun.enterprise.deployment.util.webservice

WsCompileInvoker

• java.lang.Object

Fields Summary
protected HashMap	wsCompileOptions This Map holds all the options to be used while invoking the wscompile tool; the options are set by the client of this interface using the setter methods available in this interface.
public static final String	CLASS_PATH This specifies the classpath to be used by the wscompile tool - ideally this should at least be set to directory where the SEI package is present.
public static final String	TARGET_DIR This specifies the target directory to be used by the wscompile tool to create the service artifacts - if this is not specified, then the current directory will be used by the wscompile tool
public static final String	MAP_FILE This specifies the file name to be used by the wscompile tool for creating the 109 mapping file.

Constructors Summary

Methods Summary
public void	addWsCompileFeature(java.lang.String feature) This is used to set a feature to be used while invoking the wscompile tool; for example to use the -f:wsi feature, the call will be addWsCompileFeature("wsi") This will prefix -f: to the feature and set it as part of the options Map with operand being null param String the feature to be set addWsCompileOption("-f:"+feature, null);
public void	addWsCompileOption(java.lang.String option, java.lang.String operand) This is used to set an option to be used while invoking the wscompile tool; for example to use the -classpath option for wscompile, the call will be setWsCompileOption(WsCompileInvoker.CLASS_PATH, "the_path"); For using wscompile options that are not defined in WsCompileInvoker, the 'option' argument of this call will be the actual argument to be used ; for example, for using the '-s' option of wscompile, the call to set the option will be setWsCompileOption("-s", "the_path_to_be_used"); For options that dont have an operand, the second argument can be null; for example, to invoke the wscompile tool with verbose option, the -verbose option will be set with this call setWsCompileOption("-verbose", null); param String option the wscompile option to be used param String operand the operand for the option; null if none; if(wsCompileOptions == null) wsCompileOptions = new HashMap(); wsCompileOptions.put(option, operand);
public void	clearWsCompileOptionsAndFeatures() This is used to clear all options that have been set if(wsCompileOptions != null) wsCompileOptions.clear();
public abstract void	generateClientStubs(WSDLConfig config) This is used to generate the non-portable client side artifacts given information on WSDL file location and the package name; The caller sends the required info on WSDL location, package name etc in WSDLConfig argument and this method creates the equivalent jaxrpc-config.xml, invokes wscompile with -gen:client option which will generate all required non-portable client-side artifacts like JAXRPC stubs etc. param WSDLConfig containing webservice name, package name, and WSDL location
public abstract void	generateSEI(WSDLConfig config) This is used to generate SEI and mapping files given information on WSDL file location, require package name. The caller sends the required info on WSDL location, package name etc in WSDLConfig argument and this method creates the equivalent jaxrpc-config,xml, invokes wscompile with -import option which will generate the SEI and a template implementation of the SEI. param WSDLConfig containing webservice name, package name, and WSDL location
public abstract void	generateWSDL(SEIConfig config) This is used to generate WSDL and mapping files given information on SEI config; the caller sends in all the required info in SEIConfig (info like name of webservice, interface name, package name etc) and this method creates the equivalent jaxrpc-config.xml, invokes wscompile with -define option which will generate the WSDL and the mapping file. param SEIConfig containing webservice name, package name, namespace, SEI and its implementation
public static com.sun.enterprise.deployment.util.webservice.WsCompileInvoker	getWsCompileInvoker(java.io.OutputStream out) This returns instance of the WsCompileInvoker interface. This is meant to be used by the tool to get an instance of the interface param OutputStream a stream where the messages, if any, from the wscompile tool will be sent returns WsCompileInvoker an instance of the WsCompileInvoker object return(new WsCompileInvokerImpl(out));
public boolean	removeWsCompileFeature(java.lang.String feature) This is used to remove a feature that was set; for example to remove "-f:strict" feature that was set before the call will be removeWsCompileFeature("strict") param String the feature to be removed returns true if the feature was found and removed false false if the feature was not found return(removeWsCompileOption("-f:"+feature));
public boolean	removeWsCompileOption(java.lang.String option) This is used to remove an option that was already set param String The option that has to be removed returns true If the option was found and removed returns false If the option was not found if( (wsCompileOptions != null) && wsCompileOptions.containsKey(option) ) { wsCompileOptions.remove(option); return true; } return false;