To get started using JiBX, you just need to download the distribution zip file from the SourceForge downloads page and unzip it to a convenient location on your system. The distribution comes with all the core components of JiBX, including the binding compiler, runtime, extras, and various flavors of generation tools. There are also convenient examples to help get you going, in four flavors:
All the examples are set up to use the Ant build tool. If you don't already have Ant installed on your system, you can get it from the Ant Project page.
Once you've installed the distribution on your system, open the readme.html file located in the root of the JiBX distribution. This will provide some details of what's new in the JiBX release, and also links to both the above examples and the offline version of this documentation, also included in the distribution.
Whether you're using JiBX directly, with a binding definition you've constructed on your own, or using one of the generator tools to create a binding, you're going to need to go through certain steps every time you build your application:
This sequence doesn't mean you can't do other steps in between. You may want to assemble your class files into jar files, for instance, after you've run the binding compiler (which currently requires the class files in un-jarred form). You can even use other bytecode manipulation tools along with JiBX, as long as those tools obey the JVM rules for bytecode handling.
If you're starting from existing Java code, you can use the BindGen tool included in the JiBX distribution to automatically generate a binding definition and corresponding XML schema definition from your code. BindGen uses default behaviors which will give good XML structure for most data models - but if the default generation is not satisfactory for your needs you can easily customize the generation handling at every level, with features such as:
You can also use the Jibx2Wsdl tool to generate a WSDL web service definition based on an existing service class. Jibx2Wsdl builds on BindGen and supports all the same customization features for data model classes, along with some added customizations for the service class and WSDL usage.
The bindgen examples show how to use BindGen for binding and schema generation, both with and without customizations. The jibx2wsdl examples do the same for the Jibx2Wsdl tool. For more details of using JiBX with existing Java code, including full details of the customizations structure, see the Start from Code section of this documentation.
If you're starting from an existing XML schema definition, you can use the CodeGen tool included in the JiBX distribution to automatically generate a Java data model and corresponding JiBX binding definition to match your XML documents. Here again, the code and binding generation uses default behaviors which will give a good data model for most schemas, but can be customized at every level to improve handling with features including:
The codegen examples show how to use the code and binding generation from schema, both with and without customizations. For more details of using JiBX with existing XML schemas, including full details of the customizations structure, see the Start from Schema section of this documentation.