It's good practice to put interfaces (such as remote/local interfaces, data objects and home interfaces) in a separate "interfaces" package rather than in the EJB bean implementation package. Previous versions of XDoclet dictated this behavior, so if package name of a bean ended with .beans or .ejb interfaces were put into .interfaces package. It's no more the case. You have full control over it. If you don't use a packageSubstitution element, then all interfaces are generated to the same package as the bean implementation class. But if you want to follow the pattern and put interfaces into a separate package you can, by providing the list of package name tails that interfaces of beans inside that packages should be placed into the package you define. For example interfaces of test.ejb.CustomerBean will be placed in test.interfaces by the following packageSubstitution:

 <packageSubstitution packages="ejb,beans" substituteWith="interfaces" /> 

By using the useFirst attribute, you can tell XDoclet to substitute the first occurrence and not the last.

Now if you have a structure like


you want to gather all interfaces under one root/subtree like e.g.*


now you can say:

<packagesubstitution packages="foo,baz" substituteWith="interfaces" useFirst="true"/>

Implementing Class



packagesSet the comma-separated list of packages to be substituted. No.
substituteWithSet the substitute package name. No.
useFirstSpecify whether the first occurrence of a package from the list should be substituted, or the last. No.