Apache Geronimo v3.0 Documentation: cxf-tools

{scrollbar}

INLINE

The cxf-tools script is used to generate Web services

. This command has the following syntax:

cxf-tools <toolName> <toolOptions>

where <toolName> is either java2ws or wsdl2java.

The java2ws tool uses the following syntax:

java2ws -databinding <jaxb or aegis> -frontend <jaxws or simple> -wsdl -wrapperbean -client -server -ant -wrapperbean -o <output-file> -d <resource-directory> -s <source-directory> -classdir <compile-classes-directoty> -cp <class-path> -soap12 -t <target-namespace> -beans <pathname of the bean definition file> -servicename <service-name> -portname <port-name> -address <address> -createxsdimports -h -v -verbose -quiet <classname>

The arguments used to manage the code generation process are reviewed in the following table.

Option	Usage	Description
-help or -h	-help or -h	Can be used to obtain the help information.
--databinding	-databinding <jaxb or aegis>	Can be used to specify the data binding (jaxb or aegis). By default it is jaxb for jaxws frontend, and aegis for simple frontend.
-frontend	-frontend <jaxws or simple>	Can be used tp specify the frontend. Jaxws and the simple frontend are supported.
-wsdl	-wsdl	Can be used to generate the WSDL file.
-client	-client	Can be used to generate client side code.
-server	-server	Can be used to generate server side code.
-ant	-ant	Can be used to generate an Ant `build.xml` script.
-wrapperbean	-wrapperbean	Can be used to generate the wrapper and fault bean.
-o	-o <output-file>	Can be used to specify the name of the generated WSDL file.
-d	-d <resource-directory>	Can be used to specify the directory in which the resource files are located. The wsdl file will be placed into this directory by default.
-s	-s <source-directory>	Can be used to specify the directory in which the generated source files (wrapper bean ,fault bean ,client side or server side code) are located.
-classdir	-classdir <compile-classes-directoty>	Can be used to specify the directory in which the generated sources are compiled into. If not specified, the files are not compiled.
-cp	-cp <class-path>	Can be used to specify the SEI and types class search path of directories and zip/jar files.
-soap12	-soap12	Can be used to indicate that the generated WSDL is to include a SOAP 1.2 binding.
-t	-t <target-namespace>	Can be used to specify the target namespace in the generated WSDL file.
-beans	-beans <pathname of the bean definition file>	Can be used to specify the path and name of the generated bean definition file.
-servicename	-servicename <service-name>	Can be used to specify the value of the generated service element's name attribute.
-portname	-portname <port-name>	Can be used to specify the port name to use in the generated WSDL.
-address	-address <address>	Can be used to specify the port address.
-createxsdimports	-createxsdimports	Can be used to output schemas to separate files and load them by imports instead of inlining them into the WSDL.
-v	-v	Can be used to obtain the version number.
-verbose	-verbose	Can be used to display comments during the code generation process.
-quiet	-quiet	Can be used to suppress comments during the code generation process.
<classname>	<classname>	Can be used to specify the name of the SEI class.

The wsdl2java tool uses the following syntax:

wsdl2java -fe <front-end-name>* -db <data-binding-name>* -wv <wsdl-version> -p <[wsdl-namespace = ]package-name>* -sn <service-name> -b <bindling-file-name> -d <output-directory> -compile -classdir <compile-classes-directory> -impl -server -client -all -autoNameResolution -defaultValues<=class-name-for-DefaultValueProvider> -ant -nexclude <schema-namespace [=java=package- name]>* -exsh <<true,false>> -dns <Default value is true> -dex <<true,false>> -validate -keep -wsdllocation <wsdlLocation> -xjc <xjc-arguments> -noAddressBinding -h -v -verbose -quiet <wsdlurl>

The arguments used to manage the code generation process are reviewed in the following table.

Option	Usage	Description
-help or -h	-help or -h	Can be used to obtain the help information.
-fe	-fe <frontend-name>	Can be used to specify the frontend. By default it is JAXWS frontend. Currently only JAXWS frontend is supported.
-db	-db <databinding-name>	Can be used to specify the data binding. By default it is jaxb. Currently only JAXB databinding is supported.
-wv	-wv <wsdl-version>	Can be used to specify the wsdl version. By default it is WSDL 1.1. Currently only WSDL 1.1 version is supported.
-p	-p <[wsdl-namespace = ] package-name>*	Can be used to specify zero or more package names for the generated code.
-sn	-sn <service-name>	Can be used to specify the WSDL service name for the generated code.
-b	-b <bindling-file-name>	Can be used to specify zero or more JAXWS or JAXB binding files. You can use spaces to separate more than one entry.
-catalog	-catalog <catalog-file-name>	Can be used to specify catalog file that maps the imported wsdl/schema.
-d	-d <output-directory>	Can be used to specify the directory into which the generated code files are written.
-compile	-compile	Can be used to compile generated Java files.
-classdir	-classdir <compile-classes-directory>	Can be used to specify the directory into which the compiled class files are written.
-impl	-impl	Can be used to generate starting point code for an implementation object.
-client	-client	Can be used to generate starting point code for a client mainline.
-server	-server	Can be used to generate starting point code for a server mainline.
-all	-all	Can be used to generate all starting point code: types, service proxy, service interface, server mainline, client mainline, implementation object, and an Ant `build.xml` file.
-autoNameResolution	-autoNameResolution	Can be used to automatically resolve naming conflicts without binding customizations.
-defaultValues	-defaultValues=[DefaultValueProvider impl]	Can be used to generate default values for the impl and client. You can also provide a custom default value provider. The default provider is RandomValueProvider.
-ant	-ant	Can be used to generates the Ant `build.xml` file.
-nexclude	-nexclude <schema-namespace [=java=package-name]>*	Can be used to ignore the specified WSDL schema namespace when generating code. This option can be specified multiple times. Java package name used by types described in the excluded namespace(s) can also be specified. The java package name is optional.
-exsh	-exsh <<true,false>>	Can be used to enable or disable processing of implicit SOAP headers (SOAP headers defined in the wsdl:binding but not wsdl:portType section.) By default it is false.
-dns	-dns <<true,false>>	Can be used to enable or disable the loading of the default namespace package name mapping. Default is true and http://www.w3.org/2005/08/addressing=org.apache.cxf.ws.addressing namespace package mapping will be enabled.
-dex	-dex <<true,false>>	Can be used to enable or disable the loading of the default excludes namespace mapping. Default is true.
-validate	-validate	Can be used to enable validating the WSDL before generating the code.
-keep	-keep	Can be used to indicate that the code generator will not overwrite any preexisting files. You will be responsible for resolving any resulting compilation issues.
-wsdlLocation	-wsdllocation <wsdlLocation>	Can be used to specify the value of the @WebServiceClient annotation's wsdlLocation property.
-xjc	-xjc <xjc-arguments>	Can be used to specify a comma separated list of arguments that are passed directly to the XJC processor when using the JAXB databinding. A list of available XJC plugins can be obtained using `-xjc-X`.
-noAddressBinding	-noAddressBinding	Can be used to direct the code generator to generate the older CXF proprietary WS-Addressing types instead of the JAX-WS 2.1 compliant WS-Addressing types.
-v	-v	Can be used to obtain the version number.
-verbose	-verbose	Can be used to display comments during the code generation process.
-queit	-quiet	Can be used to suppress comments during the code generation process.
<wsdlurl>	<wsdlurl>	Can be used to specify the path and name of the WSDL file in generating the code.