osgiliathenterprise/net.osgiliath.parent

Osgiliath OSGI-EE Framework

#Osgiliath Enterprise framework

(sometimes fail due to timeout)

Purpose

Osgiliath EF aims to provides a way to develop Web/backend/enterprise applications in a clean, modular way

Technologies

Osgiliath EF uses many existing first class frameworks, like AngularJS, Twitter Bootstrap, Apache Karaf, Apache Camel, CXF, ActiveMQ, JPA, JTA...

What could I find

Features

You'll find here a bunch of Karaf features allowing you to enable persistence on your project, Web-Servicing, Async messaging, Transactions, Validation, Security, Dependency Injection... Look at their itegration test counter part on how to use it

Archetypes

Osgiliath come with Maven archetypes generating your project skeleton, adding capabilities to it... There are four archetypes:

• Parent, that describes an entire application
• Routes, that enable communication between your different web services/parent modules...
• Business that embeds validation, web services, async ones, transactions, functional programming style...
• Model that permits you to save your elements in a/some relational databases easily

###Samples There are two way of programming with Osgiliath framework: using blueprint or using CDI. Blueprint configuration has an xml based syntax and is a proven OSGI technology while CDI offers configuration based on annotation (more concise but may be a little bit less featured), so choose your weapons!

Superpom

The entire Osgiliath EF uses these Maven configuration to configure dependency versions, plugin execution... So feel free to use it in your own framework ;).

Where to start?

You can first take a look at the documentation: http://osgiliathenterprise.github.io/net.osgiliath.parent/. Then, you can directly use the archectypes as they're published in Maven central (mvn archetype:generate ...). Or look at the examples or even the features integration tests to see how to code something. Readme.md will describe what's doing a module all along your way through this repo, so don't hesitate to crawl into!

Running on Karaf

Be sure to set JAVA_MAX_MEM and JAVA_MAX_PERM_MEM to higher size (i.e. 1024M) before running an Osgiliath application on Karaf

License

Osgiliath EF is fully Apache 2.0 License so feel free to use, modify, sell... Just don't forget to cite me or at least send me a mail...

Contributor

In order to contribute: Clone the repo, install Java, Maven, Npm, Grunt, Bower, PhantomJS and Compass. Then, add a property mavenSettings.location property pointing to your settings file in this settings file (in an active pofile). Finally run mvn clean install on the root... On Mac, add a java.home property in your Maven settings.xml pointing to your JDK installation (mandatory for lombok). If you use Eclipse, also install the latest Scala IDE in order to compile (http://download.scala-ide.org/sdk/lithium/e44/scala211/dev/site) We'll accept most of contributions in a very short time so don't be shy!

Releasing

In order to release Osgiliath on m2 central, you've got to execute these two command:

    export MAVEN_OPTS="-Xmx2048M -XX:MaxPermSize=1G" (in your .profile)
    mvn release:prepare -Psonatype-oss-release
    mvn release:perform -Dgoals=deploy

Enjoy Osgiliath coding!

net.osgiliath.parent's Issues

[TECH] try to mix aries-tx with weld

It should be easy:

• Make a bundle fragment on weld-osgi-bundle that listens for aries provided usertransaction and implements TransactionService: https://github.com/weld/arquillian-weld-embedded-1.1/blob/master/src/main/java/org/jboss/arquillian/container/weld/ee/embedded_1_1/mock/MockTransactionServices.java

Issue when compiling net.osgiliath.parent on Windows

HI,

I came across a couple of issues when compiling on Windows.

1. The fill-parent-path-property profile adds an extra slash to the parent.path property in build.properties. This causes erroneous new line in jacoco path e.g. parent.path = T:\\\workspace\\\Misc\\\net.osgiliath.parent will be interpreted as T:\workspace\Misc\. Even though it's a one-line change I'll create a pull request from my fork in a moment.

2. Windows version of ProcessBuilder (used in pax exam) doesn't appear to handle working directories with a path longer then 256 characters. e.g. the following is 261 chars and threw an error: "CreateProcess error=267, The directory name is invalid" T:\workspace\Misc\net.osgiliath.parent\net.osgiliath.framework\net.osgiliath.features.karaf-features\net.osgiliath.features.karaf-features.itests\net.osgiliath.features.karaf-features.itests.validation.cdi\target\exam\unpack\36076278-1678-4425-8fe0-918b0bd47a98

   Renaming my "net.osgiliath.parent" folder to "osgiliath" fixed the problem. I can't see a way to remedy this, but perhaps a note in the docs might save someone time in the future.

Best regards.

Typo in net.osgiliath.features.karaf-features-monitoring.xml

osgliath-war should be osgiliath-war

Migrate to karaf 4

Karaf 4 is out! Major framework update in perspective

Switch from blueprint to scr whenever its possible

SCR is more lightweight than blueprint.
The framework (helpers components) should be implemented with it

Rename modules to be more coherent

net.osgiliath.helpers.parent -> net.osgiliath.helpers
net.osgiliath.helpers.* -> net.osgiliath.helper.*
net.osgiliath.features.karaf-features-* -> net.osgiliath.features.karaf-feature.*
net.osgiliath.features.karaf-features.itests.* -> net.osgiliath.features.karaf-features.itest.*

Try to integrate logstash logging to further integration with ELK

See sample of integration here: https://github.com/apache/servicemix/blob/master/logging/jms-appender/src/main/resources/OSGI-INF/blueprint/config.xml

[Tests] Make Maven archetype integration tests for files/lines that can be the same as the ones in the sample

see: http://maven.40175.n5.nabble.com/unit-testing-archetypes-td75257.html#a75257 for archetype generation on a folder, then comparing it with a simple filereader could do the work

Review wrappers to use bnd instead of exec plugin

Some wrappers are using manifest transformation using maven exec plugin to upgrade package version.
Bnd can do the same using a combination of merge commands:
http://www.aqute.biz/Bnd/Format
http://felix.apache.org/documentation/subprojects/apache-felix-maven-bundle-plugin-bnd.html

See wrapper.deltaspike-data for a start of an example

[QUALITY] Add changes reporting to the Parent archetype

Changes Maven plugins looks nice :)

see: http://www.javaworld.com/article/2071733/java-app-dev/get-the-most-out-of-maven-2-site-generation.html

Changelog could be a nice thing to remember what we did: http://www.javaworld.com/article/2071733/java-app-dev/get-the-most-out-of-maven-2-site-generation.html

rename net.osgiliath.feature.spring to net.osgiliath.feature.karaf-spring

As it it a rewrite of the karaf spring feature

[FEAT] Add a Lucene/Solr // ElasticSearch Module

See that tuto for java usage
http://www.javacodegeeks.com/2013/04/getting-started-with-elasticsearch.html

Make a JPA module with deltaspike-jpa, deltaspike-data, pax-jpa

As the migration to pax-jdbc has been done, it could be nice to replace (or add a new) the blueprint/spring-data based jpa module by a deltaspike-jpa/deltaspike-data/pax-jpa one

Sometimes, persistence setup fails

Sometimes, persistence tests are failing with this message:
java.lang.Exception: java.sql.SQLException: Commande setAutoCommit(true) non valide au cours de la transaction globale.

Look at the pax-jdbc factiry settings to fix this

[TECH][HARD] Bridge blueprint and CDI

And the dream comes true...