Nucleus
=======

    nuácleáus, n. pl. nuácleái
    3. Physics. the positively charged mass within an atom, composed of
    neutrons and protons, and possessing most of the mass but occupying only
    a small fraction of the volume of the atom.

What is this?
-------------

Nucleus is a Java framework for building content stores based on the
principles of REST [1] as embodied in the Atom Publishing Protocol [2].

The implementation leverages the Apache Abdera (Incubating) [3] project to do
the heavy Atom lifting, but provides the following beyond what is provided
by Abdera:

- A framework for plugging different physical storage implementations
- A framework for plugging different caching implementations.
- A framework for plugging different AAA (Authentication, Authorization and
    Auditing) implementations.

Nucleus uses the Spring Framework [4] to implement a lightweight,
component-oriented, configurable container.

How can i contribute?
---------------------

To build the project, you need Maven 2 [5] and a recent checkout of
the Abdera source tree [6].

First you must build and install Abdera from its sources by executing:

	mvn -Dmaven.test.skip=true install

From the Nucleus source tree, you can start up the server using the
following command:

	mvn jetty:run
	
There is currently no documentation at all (apart from the code itself
and a bunch of unit tests ;-).

To discuss the project, please use the Apache Labs mailing list as
described in http://labs.apache.org/mail.html.


Thanks for your interest in Nucleus.

[1] http://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm
[2] http://www.ietf.org/html.charters/atompub-charter.html
[3] http://incubator.apache.org/abdera/
[4] http://www.springframework.org/
[5] http://maven.apache.org/
[6] http://svn.apache.org/repos/asf/incubator/abdera/java/trunk