Page History

The Java SCA project Subversion repository is located at

https://svn.apache.org/repos/asf/tuscany/sca-java-1.x/trunk/

.

The

repository

can

also

be

viewed

online

at

http://svn.apache.org/viewvc/tuscany/sca-java-1.x/trunk/

Anyone

can

check

code

out

of

Subversion.

You

only

need

to

specify

a

username

and

password

in

order

to

update

the

Subversion

repository,

and

only

Tuscany

committers

have

the

permissions

to

do

so.

Checking

out

code

from

Subversion

Use

the

command

as

follows

(note

that

it

uses

http

scheme

so

if

you're

a

committer

change

it

to

https):

}
svn checkout http://svn.apache.org/repos/asf/tuscany/sca-java-1.x/trunk/ sca-java-1.x
{code}

h4. Committing Changes to Subversion

Any Tuscany committer should have a shell account on 

Committing Changes to Subversion

Any Tuscany committer should have a shell account on svn.apache.org.

Before

you

can

commit,

you'll

need

to

set

a

Subversion

password

for

yourself.

To

do

that,

log

in

to

svn.apache.org

and

run

the

command

svnpasswd.

Tuscany

committers

should

configure

these

properties

in

the

svn

per-user

config.

On

Unix-like

systems,

this

area

appears

as

a

directory

named

.subversion

in

the

user's

home

directory.

On

Win32

systems,

Subversion

creates

a

folder

named

Subversion,

typically

inside

the

Application

Data

area

of

the

user's

profile

directory

(C:\Documents

and

Settings\<user

name>\Application

Data\Subversion,

which,

by

the

way,

is

usually

a

hidden

directory).

Please

make

sure

the

following

properties

are

set

in

the

"config"

file:

}
[miscellany]
...
enable-auto-props = yes

[auto-props]
### The format of the entries is:
###   file-name-pattern = propname[=value][;propname[=value]...]
### The file-name-pattern can contain wildcards (such as '*' and
### '?').  All entries which match will be applied to the file.
### Note that auto-props functionality must be enabled, which
### is typically done by setting the 'enable-auto-props' option.

*.c = svn:eol-style=native
*.cpp = svn:eol-style=native
*.h = svn:eol-style=native
*.dsp = svn:eol-style=CRLF
*.dsw = svn:eol-style=CRLF
*.sh = svn:eol-style=native;svn:executable
*.txt = svn:eol-style=native
*.png = svn:mime-type=image/png
*.jpg = svn:mime-type=image/jpeg
Makefile = svn:eol-style=native

*.java = svn:eol-style=native;svn:keywords=Rev Date
*.xml = svn:eol-style=native;svn:keywords=Rev Date
*.xsd = svn:eol-style=native;svn:keywords=Rev Date
*.html = svn:eol-style=native;svn:keywords=Rev Date
*.properties = svn:eol-style=native;svn:keywords=Rev Date
*.jelly = svn:eol-style=native;svn:keywords=Rev Date
*.ipr = svn:eol-style=native
*.iml = svn:eol-style=native
{code}

Once

your

password

is

set,

you

can

use

a

command

like

this

to

commit:

}
svn commit
{code}

If

Subversion

can't

figure

out

your

username,

you

can

tell

it

explicitly:

}
svn --username <name> commit
{code}

Subversion

will

prompt

you

for

a

password,

and

once

you've

entered

it,

it

will

remember

it

for

you.

Note

this

is

the

password

you

configured

with

svnpasswd

not

your

shell

or

other

password.

Anchor
Setup Setup

Setting up your Development Environment

Build tree structure

The build tree is designed to facilitate modular development and releases. Maven modules are grouped by how they are released under an hierarchy. Java SCA currently have the below module hierarchy :

h3. {anchor:Setup} Setting up your Development Environment


h4. Build tree structure

The build tree is designed to facilitate modular development and releases. Maven modules are grouped by how they are released under an hierarchy. Java SCA currently have the below module hierarchy :
{noformat}
-java
 |-- sca
     |-- demos                SCA demo applications
     |-- distribution         SCA distributions
     |-- itest                SCA Integration Tests
     |-- modules              SCA Implementation Modules (core, runtimes, contribution, extensions, etc)
     |-- samples              SCA Sample Applications
     |-- tools                SCA Tools (Eclipse plugins, wsdl2java, java2wsdl, etc)
     |-- tutorial             SCA Tutorial
{noformat}

The

individual

modules

can

be

built

separately

or

build

with

top-down

build.

top-down

build

(recommended

approach)

Check

out

all

of

the

java

source

code.

{

Code Block
} svn checkout http://svn.apache.org/repos/asf/tuscany/sca-java-1.x/trunk/ sca-java-1.x {code}

Building

the

SCA

source

code

is

simple

{

Code Block
} cd sca-java-1.x mvn {code}

It

should

work

even

if

you

start

with

an

empty

Maven

local

repository,

and

it

should

always

work,

however

when

you

are

building

for

Tuscany

for

the

first

time

there

are

a

lot

of

dependencies

which

must

be

downloaded

so

the

first

build

can

take

a

long

time

and

it

may

fail

with

problems

retrieving

the

dependencies.

There can be occasional problems downloading artifacts from remote Maven repositories so if mvn fails with network related sounding messages sometimes just trying again can fix the problem.

The trunk code sometimes has SNAPSHOT dependencies which can get out of date in your local repository so if you see odd build failures try updating the SNAPSHOT jars with:

Code Block
mvn -U

Once you have done a top-down build, and your local maven repository is populated, you can start using the maven off line option to speed up the build process

Code Block
mvn -o

Info
The SCA build consumes a good amount of memory, in case you are seeing issues during the build, set a MAVEN_OPTS environment variable to allocate more memory for the build process. Windows : SET MAVEN_OPTS=-Xmx512m Unix : export MAVEN_OPTS=-Xmx512m

Info

The "trunk" is always in very active development, and sometimes you might experience issues trying to build some modules, in that case you can tell maven to continue building other modules (on) There can be occasional problems downloading artifacts from remote Maven repositories so if mvn fails with network related sounding messages sometimes just trying again can fix the problem. (on) The trunk code sometimes has SNAPSHOT dependencies which can get out of date in your local repository so if you see odd build failures try updating the SNAPSHOT jars with: {code} mvn -U {code} (on) Once you have done a top-down build, and your local maven repository is populated, you can start using the maven off line option to speed up the build process {code} mvn -o {code} {info} The SCA build consumes a good amount of memory, in case you are seeing issues during the build, set a MAVEN_OPTS environment variable to allocate more memory for the build process. Windows : SET MAVEN_OPTS=-Xmx512m Unix : export MAVEN_OPTS=-Xmx512m {info} {info} The "trunk" is always in very active development, and sometimes you might experience issues trying to build some modules, in that case you can tell maven to continue building other modules {code} Code Block mvn -fae clean install {code} or either skip all unit tests { Code Block } mvn -fae -Dmaven.test.skip=true clean install {code} or run tests, but do not stop building if one of the tests fails { Code Block } mvn -fn clean install

Anchor
Distributions Distributions

Building the binary and source distributions

The binary and source distribution release artifacts are created by running maven in the distribution folder, for example:

{code}
{info}

h4. {anchor:Distributions} Building the binary and source distributions

The binary and source distribution release artifacts are created by running maven in the distribution folder, for example:
{code}
cd sca-java-1.x/distribution
mvn clean install -o
{code}

The

distribution

artifacts

can

then

be

found

in

the

folder

named

"target"

within

the

distribution

folder.

Anchor
IDE IDE

Importing SCA modules into your Development IDE

Using Eclipse

If this is the first time you are using your workspace with maven m2 local repository, you will need to tell your Eclipse workspace the location of the directory, and you can do this with the following command :

 

h3. {anchor:IDE}Importing SCA modules into your Development IDE


h4. Using Eclipse

If this is the first time you are using your workspace with maven m2 local repository, you will need to tell your Eclipse workspace the location of the directory, and you can do this with the following command :
{code}
mvn -Declipse.workspace=[path-to-eclipse-workspace] eclipse:add-maven-repo
{code}

In

order

to

generate

the

necessary

project

files

to

import

the

SCA

modules

to

Eclipse,

you

can

use

the

maven

eclipse

plugin

}
cd sca-java-1.x
mvn eclipse:eclipse
{code}
Now, launch your Eclipse IDE, select 

Now, launch your Eclipse IDE, select File->Import->Existing

projects

into

Workplace,

and

then

select

the

base

SCA

directory

(e.g

java/sca)

and

then

press

Finish,

this

should

import

all

SCA modules into your Eclipse Workspace.

There are some Tuscany Eclipse code templates available:
Eclipse Style Formatter
Eclipse Templates

Anchor
Code Path Code Path

Understanding SCA code path

Here is a walk through of key methods/functions which help you get started with SCA Java development.

Anchor
Coding Guidelines Coding Guidelines

Coding Guidelines

There are a few simple guidelines when developing for JAVA SCA:

• The basic coding style used is the described at Sun Java coding standards but the main thing is to be consistent with the existing code you're updating, so for example, if you're updating a method that uses the braces on the same line style don't add code with the hanging braces style.

• Always include the Apache License Headers on all files (both source code files and resource files such as xml documents)

• Include a descriptive log message for checkins, for example "fixed such and such problem".

Some other useful suggestions:

While Tuscany does not yet have an official style or template, here are some templates that folks have been using and have been checked into the build which are stored at https://svn.apache.org/repos/asf/tuscany/java/etc/

Naming conventions to increase consistency

Folder Names: Please use all lowercases and dashes in folder names (like in the jar names)

• Maven artifact id = tuscany-<folder name>

Package names: Package names within modules should include the module name so that source code can be located in the source tree easily. So, for example, java/sca/module/implementation-java

would

be

in

package

structure

org.apache.tuscany.implementation.java.*

Anchor
Testing Testing

Testing

Tuscany uses plain junit test cases to perform unit and integration testing, below is an example that can also be used as a template for writing new test cases; it demonstrates how to bootstrap the Tuscany SCA runtime in your test case, and because they are based on junit, you can run it from your IDE of choice or from Maven.

\*

h3. {anchor:Testing} Testing

Tuscany uses plain junit test cases to perform unit and integration testing, below is an example that can also be used as a template for writing new test cases; it demonstrates how to bootstrap the Tuscany SCA runtime in your test case, and because they are based on junit, you can run it from your IDE of choice or from Maven.
{code}
/**
 * Description of your test case and necessary details you find necessary
 */
public class YourTestCase extends TestCase {
    private SCADomain domain;
    private YourService service;


    @Override
    protected void setUp() throws Exception {
    	domain = SCADomain.newInstance("YourTest.composite");
        service = domain.getService(YourService.class, "serviceName");
    }

    @Override
    protected void tearDown() throws Exception {
    	domain.close();
    }


   ...
}
{code}
(on) Note that we use surefire maven plugin to run the unit and integration tests, and in most cases, they are configured to match a \

Note that we use surefire maven plugin to run the unit and integration tests, and in most cases, they are configured to match a **/*TestCase.java

file

name

pattern.

Because

of

this,

if

your

test

case

has

a

different

file

name

pattern,

you

might

execute

it

from

your

IDE

of

choice,

but

the

maven

build

won't

execute

the

test.

Anchor
Maven Build Structure Maven Build Structure

Maven Build Structure

We use the term Module to refer to the leaf of maven tree.

• 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

• id:

• org.apache.tuscany.sca

• 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

• pom

• names

• begin

• Apache

• Tuscany

• SCA

• Eclipse

• projects

• are

• generated

• for

• all

• built

• modules

• using

• mvn

• -Peclipse

• eclipse:eclipse

Adding

a

new

module

and

not

ready

to

integrate?

'work-in-progress'

modules

can

be

worked

on

in

the

same

source

tree

and

yet

not

break

the

top-down

build.

You

can

do

this

by

not

listing

your

module(s)

in

java/sca/modules/pom.xml.

h3. {anchor:Providing patches} Reporting issues and providing patches {include: Found a Bug Section} {HTMLcomment

Anchor
Providing patches Providing patches

Reporting issues and providing patches

{htmlcomment:hidden}{children:sort=creation}{

htmlcomment}

Development Hints

Anchor
Webapp in Eclipse Webapp in Eclipse

Generating Eclipse WTP Web Projects for Webapp samples

If you're using Eclipse WTP and want to get WTP Web Projects generated
for our Webapp samples you can simply pass a -Dwtpversion=1.5

option

to

the

usual

mvn

eclipse:eclipse

command,

like

this:

mvn

-Dwtpversion=1.5

-Peclipse

eclipse:eclipse

The

magic

-Dwtpversion=1.5

option

will

add

the

WTP

Web

project

nature

to

all

the

Eclipse

projects

with

<packaging>war</packaging>

in

their

Maven

pom.xml.

You'll

then

be

able

to

add

these

projects

to

a

WTP

Tomcat

or

Geronimo

Server

configuration,

to

publish

and

run

them

straight

from

your

Eclipse

workspace.

h3:

Figuring out the package dependency to include in Ant build.xml can be a pain. Here is a quick
script which works in Linux environment for war files.

:Ant} Generating Dependencies for Ant in Samples

Figuring out the package dependency to include in Ant build.xml can be a pain. Here is a quick
script which works in Linux environment for war files.
{code}
jar tvf sample-feed-aggregator-webapp.war | grep .jar | awk '{ printf "%s\n", $8 }' | 
   sed -e "s/WEB-INF\/lib\///" | awk '{ printf "<include name=\"%s\"/>\n", $1 }' | grep -v tuscany
{code}

h2. {anchor:ReleaseChecklist} How to do a release of Tuscany?
Here is the [Checklist for doing a Tuscany SCA Java release |TUSCANY:Making releases].

Anchor
ReleaseChecklist ReleaseChecklist

How to do a release of Tuscany?

Here is the Checklist for doing a Tuscany SCA Java release .