Author: chetanm
Date: Mon Nov 30 05:15:22 2015
New Revision: 1717175
URL: http://svn.apache.org/viewvc?rev=1717175&view=rev
Log:
OAK-3687 - Oak standalone application example based on Spring Boot
Add initial readme
Added:
jackrabbit/oak/trunk/oak-examples/standalone/README.md
Modified:
jackrabbit/oak/trunk/oak-examples/standalone/src/main/java/org/apache/jackrabbit/oak/standalone/RepositoryInitializer.java
Added: jackrabbit/oak/trunk/oak-examples/standalone/README.md
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-examples/standalone/README.md?rev=1717175&view=auto
==============================================================================
--- jackrabbit/oak/trunk/oak-examples/standalone/README.md (added)
+++ jackrabbit/oak/trunk/oak-examples/standalone/README.md Mon Nov 30 05:15:22
2015
@@ -0,0 +1,128 @@
+Jackrabbit Oak - Standalone Application Example
+===============================================
+
+This example demonstrates how to embed Oak in an standalone application
+
+Getting Started
+---------------
+
+To get started build the build the latest sources with Maven 3 and Java 6
+(or higher).
+
+ $ cd oak-examples/standalone
+ $ mvn clean install
+
+Once done you can run the application by executing
+
+ $ java -jar target/oak-standalone-*.jar
+
+This would start an Oak based repository which uses filesystem storage. All
+the content would be by default stored under `repository` folder. The server
+would listen at port 8080 and support remote access via DavEx (at `/server`)
+and WebDAV (at `/repository`).
+
+Now lets write something in the repository
+
+ $ curl --request MKCOL --data @- --user admin:admin \
+ http://localhost:8080/server/default/jcr:root/hello/ <<END
+ <sv:node sv:name="hello" xmlns:sv="http://www.jcp.org/jcr/sv/1.0";>
+ <sv:property sv:name="message" sv:type="String">
+ <sv:value>Hello, World!</sv:value>
+ </sv:property>
+ <sv:property sv:name="date" sv:type="Date">
+ <sv:value>2009-11-17T12:00:00.000Z</sv:value>
+ </sv:property>
+ </sv:node>
+ END
+
+This would create a node `hello` at root.
+
+ $ curl --user admin:admin
http://localhost:8080/server/default/jcr:root/hello.json
+
+This should return a json rendition of the node. Application also has some
+other web interfaces which are linked at http://localhost:8080/
+
+Using Mongo
+-----------
+
+By default the application uses SegmentMk for which stores the data on
+filesystem. Instead of that it can be configured to use Mongo
+
+ $ java -jar target/oak-standalone-*.jar --mongo
+
+It would try to connect to a Mongo server at localhost and 27017 port. One can
+specify the server detail also
+
+ $ java -jar target/oak-standalone-*.jar --mongo=mongodb://server:27017
+
+
+Application Structure
+---------------------
+
+Oak uses a repository home (defaults to `repository`) folder in current
+directory.
+
+ repository/
+ âââ bundles
+ âââ dav
+ â âââ tmp
+ âââ repository
+ â âââ datastore
+ â âââ index
+ â âââ segmentstore
+ â âââ data00000a.tar
+ â âââ journal.log
+ â âââ repo.lock
+ âââ repository-config.json
+ âââ segmentmk-config.json
+
+In above structure
+
+1. `bundles` - Storage used by OSGi bundles
+2. `repository` - All content is stored here. Binary content is stored in
+ `datastore` directory and node content is stored in `segmentstore` directory
+3. json file - These are config files which are used to configure the
+ repository components like JAAS setup, SegmentStore config etc. These are
OSGi
+ config. To see what all config options are supported go to
+ http://localhost:8080/osgi/system/console/configMgr
+
+The default setup is configured to use a FileDataStore to store binary
+content for both SegmentMk and MongoMk
+
+Setup
+-----
+
+Repository is configured and setup in `RepositoryInitializer`. On startup
+it would check if repository home exist or not. If not it would copy a set of
+default config files depending on options provided (like --mongo ) and then
+construct the Oak Repository instance via `OakOSGiRepositoryFactory`
+
+ private Repository createRepository(List<String> repoConfigs, File
repoHomeDir) throws RepositoryException {
+ Map<String,Object> config = Maps.newHashMap();
+ config.put(OakOSGiRepositoryFactory.REPOSITORY_HOME,
repoHomeDir.getAbsolutePath());
+ config.put(OakOSGiRepositoryFactory.REPOSITORY_CONFIG_FILE,
commaSepFilePaths(repoConfigs));
+ config.put(OakOSGiRepositoryFactory.REPOSITORY_SHUTDOWN_ON_TIMEOUT,
false);
+ config.put(OakOSGiRepositoryFactory.REPOSITORY_ENV_SPRING_BOOT, true);
+ config.put(OakOSGiRepositoryFactory.REPOSITORY_TIMEOUT_IN_SECS, 10);
+
+ //Set of properties used to perform property substitution in
+ //OSGi configs
+ config.put("repo.home", repoHomeDir.getAbsolutePath());
+ config.put("oak.mongo.db", mongoDbName);
+ config.put("oak.mongo.uri", getMongoURI());
+
+ //Configures BundleActivator to get notified of
+ //OSGi startup and shutdown
+ configureActivator(config);
+
+ return new OakOSGiRepositoryFactory().getRepository(config);
+ }
+
+In above setup
+
+1. `REPOSITORY_HOME` - Path to the directory which would be used to store
+ repository content
+2. `REPOSITORY_CONFIG_FILE` - Comma separated json config file paths
+
+Standalone Application is based on [Spring
Boot](http://projects.spring.io/spring-boot/)
+and thus supports all features provided by it.
\ No newline at end of file
Modified:
jackrabbit/oak/trunk/oak-examples/standalone/src/main/java/org/apache/jackrabbit/oak/standalone/RepositoryInitializer.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-examples/standalone/src/main/java/org/apache/jackrabbit/oak/standalone/RepositoryInitializer.java?rev=1717175&r1=1717174&r2=1717175&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-examples/standalone/src/main/java/org/apache/jackrabbit/oak/standalone/RepositoryInitializer.java
(original)
+++
jackrabbit/oak/trunk/oak-examples/standalone/src/main/java/org/apache/jackrabbit/oak/standalone/RepositoryInitializer.java
Mon Nov 30 05:15:22 2015
@@ -119,11 +119,16 @@ public class RepositoryInitializer {
config.put(OakOSGiRepositoryFactory.REPOSITORY_ENV_SPRING_BOOT, true);
config.put(OakOSGiRepositoryFactory.REPOSITORY_TIMEOUT_IN_SECS, 10);
+ //Set of properties used to perform property substitution in
+ //OSGi configs
config.put("repo.home", repoHomeDir.getAbsolutePath());
config.put("oak.mongo.db", mongoDbName);
config.put("oak.mongo.uri", getMongoURI());
+ //Configures BundleActivator to get notified of
+ //OSGi startup and shutdown
configureActivator(config);
+
return new OakOSGiRepositoryFactory().getRepository(config);
}
