modeshape-servlet

Example Using ModeShape from a Web Application's Servlet

What is it?

This is a self-contained and deployable Maven 3 project that shows how to get access repository bound in JNDI either via native JCR API or using JNDI API.

System requirements

All you need to build this project is Java 8.0 (Java SDK 1.8) or better, Maven 3.0 or better. The application this project produces is designed to be run on JBoss Wildfly 9 or 10.

Running the Quickstart

NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must use the settings.xml file from the root of this project. See this ModeShape community article for help on how to install and configure Maven 3.

1. Open a command line and navigate to the root directory of this quickstart.

2. Type this command to build and deploy the archive:

    mvn clean package
   

3. This will start a local Wildfly instance located at target\wildfly', unpack and copy the ModeShape WF kit and deploy target/modeshape-servlet.war` to the running instance of the server.

Accessing the application

The application will be running at the following URL: http://localhost:8080/modeshape-servlet

Installing the ModeShape kit will add two pre-configured demo repositories: sample and artifacts (see the JBOSS_HOME/conf/standalone-modeshape.xml file for more details). Both repositories are bound by default in JNDI under names: java:/jcr/sample and java:/jcr/artifacts.

The user is presented with a form where he can input data in two fields:

1. Repository Location - a mandatory string, which can have one of the following formats that will dictate the way the repository is looked up: repository_name - the simple name of a repository which can be located in JNDI at the pre-configured location: java:/jcr/<repository_name> full_repository_jndi_path - the full JNDI path to a repository repository_url - a url starting with either jndi:, http:, file: and classpath: which represents the full path to a repository JSON configuration file
2. Node Path - an optional string which represents the full path to a node in a repository. The default value is the root path: /

Once the above information is submitted, the form will display the children of the node located at the above path.

Run the Arquillian Tests

This quickstart provides some optional Arquillian tests. These are part of separate profile and can be run like so:

1. Open a command line and navigate to the root directory of this quickstart.

2. Type the following command to run the tests:

    mvn clean verify -Pdist
   

The above command will start a server with the ModeShape WF kit deployed and run the tests using the predefined repository named sample (see above).

The ModeShape project

ModeShape is an open source implementation of the JCR 2.0 (JSR-283) specification and standard API. To your applications, ModeShape looks and behaves like a regular JCR repository. Applications can search, query, navigate, change, version, listen for changes, etc. But ModeShape can store that content in a variety of back-end stores (including relational databases, Infinispan data grids, JBoss Cache, etc.), or it can access and update existing content from other kinds of systems (including file systems, SVN repositories, JDBC database metadata, and other JCR repositories). ModeShape's connector architecture means that you can write custom connectors to access any kind of system. And ModeShape can even federate multiple back-end systems into a single, unified virtual repository.

For more information on ModeShape, including getting started guides, reference guides, and downloadable binaries, visit the project's website at http://www.modeshape.org or follow us on our blog or on Twitter. Or hop into our IRC chat room and talk our community of contributors and users.

The official Git repository for the project is also on GitHub at http://github.com/ModeShape/modeshape.

Need help ?

ModeShape is open source software with a dedicated community. If you have any questions or problems, post a question in our user forum or hop into our IRC chat room and talk our community of contributors and users.