Tuesday, 2 February 2010

Blog/Project/Kenai Update

As kenai is going to close down shortly (see below) and as I've got some other projects coming up I'm taking the oportunity to make a few changes at the same time:

  1. The projects are moving to JavaForge - retepTools is over, the others over the next couple of days.
  2. There's now an online backup of the mercurial repos on BitBucket as well as JavaForge.
  3. I'm consolidating both of my blogs into one and migrating to wordpress. The new url is blog.retep.org with the main home page currently redirecting to the blog.
Here's the notification from the kenai team on when they go offline - so if you have a project on there you have four weeks to move it:

THE FUTURE OF KENAI.COM

Project Kenai has always existed as two things.
Kenai the infrastructure, and Kenai the website (Kenai.com)

While it has come time to close the domain of Kenai.com, the infrastructure, which is already used under Netbeans.org, will live on to support other domains in the future. 

With the decision to close the Kenai.com domain, it is now time for project owners to begin the process of migrating their repositories, and content over to other locations. The domain will be closed to the creation of new projects in the next week. The complete shutdown of the site, and the removal of the domain will be completed in the next 60 days (April 2nd 2010). This should provide ample time for all projects to be moved to a new home of the project owners choice. 

Any projects that remain after the 60 day limit (April 2nd 2010), will be removed when the site is turned off. 

With respect,
The Project Kenai Team

Thursday, 28 January 2010

Moving away from Kenai

As is commonly known, Oracle have finally taken over Sun and yesterday they announced what they are intending to do with the various services provided by Sun.

Unfortunately one of those announcements was that they were withdrawing the Kenai project from public use at some point in the near future. This is a pity because the Kenai project was becoming one of the more useful forges out there.

During today there's been a lot of forum activity on the kenai site from a lot of project owners about what to do in migrating away, including myself.

So, after a good year of being hosted on kenai I'm now faced with moving to yet another forge - but where to go and what's going to be involved?

Well the steps needed are (in order of importance):
  1. Move the source repositories
  2. Move the maven repository
  3. Move the jira issues
  4. Change all links to the new location(s).
As an initial measure I've mirrored the mercurial repositories on bitbucket so at least they are mirrored elsewhere. One of mercurial's features is being distributed so that was relatively painless.

The next two are tricky so I'm still researching them, but they all depend on what forge to use. I've used sourceforge in the distant past so I don't want to go back to them, and although bitbucket does have wiki and a tracker - it's not jira.

Anyhow here's the new repo information for the bitbucket mirrors:
  • https://username@bitbucket.org/petermount/reteptools/
  • https://username@bitbucket.org/petermount/retepmicrokernel/
  • https://username@bitbucket.org/petermount/retepxmpp/
  • https://username@bitbucket.org/petermount/retepjavadoc/
As soon as I'll have more information I'll make another post here, on twitter and on identi.ca

    Monday, 4 January 2010

    Binding custom objects to attributes in JAXB

    When generating Java sources from an XML Schema with JAXB, the type of field used to represent an attribute is determined by it's type in the schema.

    For example, a snippet from jabber-client.xsd:
       <xs:element name="message">
         <xs:complextype>
            <xs:attribute name="from" type="xs:string" use="optional">
            <xs:attribute name="to" type="xs:string" use="optional">
         </xs:complextype>
       </xs:sequence>
       </xs:element>
    By default, JAXB would create the object (Message in this case) with two String properties. To change this to another object (say JID) we would add a simple binding changing these to use JID and define two static methods who's job it is to convert between a String and a JID.

    So the bindings would be something like:
       <bindings schemalocation="jabber-client.xsd">
         <bindings node="/xsd:schema/xsd:element[@name='message']/xsd:complexType">
           <bindings node="xsd:attribute[@name='from']">
             <property>
               <baseType>
                 <javaType name="uk.org.retep.xmpp.JID"
                   parseMethod="uk.org.retep.xmpp.jaxb.adaptor.XMPPDatatypeConverter.parseJID" 
                   printMethod="uk.org.retep.xmpp.jaxb.adaptor.XMPPDatatypeConverter.printJID"
                 />
               </baseType>
             </property>
           </bindings>
         </bindings>
       </bindings>

    Now for mose usecases this is fine and works pretty well. The problem is when you have a large number of custom bindings.

    What JAXB does for each binding is that it generates an anonymous Adapter class. In that adaper class are two methods which call the two methods declared in the binding - in the case of binding to a Double you would get the following:
    public class Adapter1
        extends XmlAdapter<String, Double>
    {
    
        public Double unmarshal(String value) {
            return (javax.xml.bind.DatatypeConverter.parseDouble(value));
        }
    
        public String marshal(Double value) {
            if (value == null) {
                return null;
            }
            return (javax.xml.bind.DatatypeConverter.printDouble(value));
        }
    
    }
    

    The problem here is that JAXB generates one of these for every instance, so you can end up having multiple Adapter classes present, all doing the same thing. In one instance I had a single schema contain 16 duplicates of the above code. In retepXMPP I had almost 60 spread over multiple schemas just for handling JID. This is a lot of wasted, duplicated code and if you use a large number of schemas then this is going to cause both your jar sizes and permgen use to increase for no real reason.

    So it would be nice to reduce this down to a single adapter.

    Fortunately there is a way when using the JAXB RI. There is an alternate javaType binding which takes the full class name of an adapter class instead - using this causes JAXB to use that single class instead of generating these duplicate classes. The main difference is replacing the parseMethod and printMethod attributes with a single adapter attribute, and qualifying the javaType with the http://java.sun.com/xml/ns/jaxb/xjc namespace.

    So the bindings would be something like:
    <bindings
        xmlns="http://java.sun.com/xml/ns/jaxb"
        xmlns:xsd="http://www.w3.org/2001/XMLSchema"
        xmlns:xjc="http://java.sun.com/xml/ns/jaxb/xjc"
        xmlns:retep="http://retep.org/xml/ns/retepTools"
        version="2.0">
       <bindings schemalocation="jabber-client.xsd">
         <bindings node="/xsd:schema/xsd:element[@name='message']/xsd:complexType">
           <bindings node="xsd:attribute[@name='from']">
             <property>
               <baseType>
                 <xjc:javaType adapter="uk.org.retep.xmpp.jaxb.adaptor.JIDAdapter" name="uk.org.retep.xmpp.JID" />
               </baseType>
             </property>
           </bindings>
         </bindings>
       </bindings>
    </bindings>

    Then just create a single adapter implementation. in retepXMPP thats some 60 classes reduced to one, if you generate any javadocs based on the generated sources there's no more "Adapter" spam - large numbers of apparently duplicated classes in the javadocs etc.

    Tip: Just make sure you keep an eye on that namespace - miss it out and XJC will spurt out some unusual error messages.