You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

For those looking at or developing the Tuscany Java SCA source code this page provides some description of the code structure and associated conventions that are used during development.

(110407) This is an initial set of information derived from recent mail list traffic and will change as the latest reorg settles down

Code Structure

java/
 pom/parent/pom.xml

 sca/
   pom.xml

   contrib 
     ...

   doc
     ...

   itest
     pom.xml
     bindings
     exceptions
     spec
     ...

   modules/
     pom.xml
     assembly
     binding-axis2
     contribution
     core
     databinding
     discovery-jms
     federation
     http-jetty
     idl-java
     impl-java
     ...

   samples/
     build.xml <-- Samples build with Ant as well as Maven - TBD
     pom.xml
     calculator
     supplychain
     bigbank
     helloworld
     ...

Using Maven

  • sca/pom.xml's parent will be pom/parent/pom.xml
  • Other poms will use the pom from the parent folder as parent pom
  • Group ids: org.apache.tuscany.sca, org.apache.tuscany.sca.samples,
    org.apache.tuscan.sca.itest
  • Version of our modules will be specified once in java/sca/pom.xml,
    child poms don't need specify a version as they get it from their parent
  • Eclipse projects are generated for all built modules using mvn -Peclipse eclipse:eclipse

Naming Conventions

  • Use all lowercases and dashes in folder names (like in the jar names)
  • Maven artifact id = tuscany-<folder name>
  • ???

Module Status

If people want to work on some new modules that won't be part of the
next release and not included in the top-down build, that's fine, we can
just avoid listing these modules in java/sca/modules/pom.xml. So, they
can be there in the same source tree but they won't break the release
top-down build, and they won't have to be building at all times.

Building

Simple... cd java/sca, then mvn. It should work even if you start with
an empty Maven local repository, and it should always work (smile) Build
breaks should be avoided or get fixed quickly, it's the least we can do
to be nice to our community of developers and users to avoid breaking
them all the time.

  • No labels