Managing resources using Jackrabbit with Spring Boot

In this post I will demonstrate how to work with Jackrabbit content repository with Spring Boot application. The Apache Jackrabbit content repository is a fully conforming implementation of the Content Repository for Java Technology API. A content repository is a hierarchical content store with support for structured and unstructured content, full text search, versioning, transactions, observation etc.

Prerequisites 

1. You should have install java 1.8 or above.
2. You should have Eclipse/IntelliJ Idea installed in your PC.
3. Your PC should setup Maven installed and configured.

Lets setup Jackrabbit 

You can download the latest jackrabbit from official Jackrabbit web page . I will download the war file and deploy it on JBoss EAP.

To deploy it in to JBoss EAP you should have access the web admin console. In there  go to Deployments and click "Add" button show in figure below. Then click next and select the war file you downloaded. Then click next and then click finish.

Once you successfully installed the application you should be able to access the default jackrabit web interface from http://localhost:8080/jackrabbit-webapp-2.18.5/ you should see similar page as show below.

Create your first repository by click on "Create Content Repository". By click on this button system will create the default Jackrabbit repository with default settings.

Success Page of JackRabbit repository creation 

Now when you access Jackrabbit default URL you will be able to see as follows.

When you create this repository JBoss EAP will create new folder call "jackrabbit" on <JBOSS_HOME_DIR>/bin folder. As show in below.

Lets create project 

Open InelliJ IDEA and create new maven project. I will using following details for the project.

groupId    : com.nirmal.JackrabbitSpringBoot

artifactId : JackrabbitSpringBoot

I will add relevant dependencies in to the POM file as show below.

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0"

         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <groupId>com.nirmal.JackrabbitSpringBoot</groupId>

    <artifactId>JackrabbitSpringBoot</artifactId>

    <version>1.0-SNAPSHOT</version>

    <parent>

        <groupId>org.springframework.boot</groupId>

        <artifactId>spring-boot-starter-parent</artifactId>

        <version>1.5.1.RELEASE</version>

        <relativePath />

    </parent>

    <properties>

        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>

        <java.version>1.8</java.version>

    </properties>

    <dependencies>

        <dependency>

            <groupId>javax.servlet</groupId>

            <artifactId>jstl</artifactId>

        </dependency>

        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-starter-web</artifactId>

        </dependency>

        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-starter-test</artifactId>

            <scope>test</scope>

        </dependency>

        <!-- Provided -->

        <dependency>

            <groupId>org.apache.tomcat.embed</groupId>

            <artifactId>tomcat-embed-jasper</artifactId>

            <scope>provided</scope>

        </dependency>

        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-starter-data-jpa</artifactId>

        </dependency>

        <dependency>

            <groupId>com.microsoft.sqlserver</groupId>

            <artifactId>mssql-jdbc</artifactId>

            <version>6.1.0.jre8</version>

        </dependency>

        <!-- The JCR API -->

        <dependency>

            <groupId>javax.jcr</groupId>

            <artifactId>jcr</artifactId>

            <version>2.0</version>

        </dependency>

        <!-- Jackrabbit content repository -->

        <dependency>

            <groupId>org.apache.jackrabbit</groupId>

            <artifactId>jackrabbit-core</artifactId>

            <version>2.18.1</version>

        </dependency>

        <dependency>

            <groupId>org.apache.jackrabbit</groupId>

            <artifactId>jackrabbit-jcr2dav</artifactId>

            <version>2.19.3</version>

        </dependency>

        <dependency>

            <groupId>org.apache.jackrabbit</groupId>

            <artifactId>jackrabbit-jcr-commons</artifactId>

            <version>2.19.3</version>

        </dependency>

    </dependencies>

    <build>

        <plugins>

            <plugin>

                <groupId>org.springframework.boot</groupId>

                <artifactId>spring-boot-maven-plugin</artifactId>

            </plugin>

        </plugins>

    </build>

</project>

Then I will add application.properties file in resources folder with following content. note that I will use default jackrabit user name and password in this demonstration. Jackrabit url can be get as following format http://<ip address>:<port>/<contextpathOfJackrabitserver>/server

#==== connect to mssql ======#

spring.jpa.hibernate.ddl-auto=update

spring.datasource.url=jdbc:sqlserver://localhost;databaseName=TestDB

spring.datasource.username=nirmal

spring.datasource.password=Test123_

spring.datasource.driverClassName=com.microsoft.sqlserver.jdbc.SQLServerDriver

spring.jpa.database-platform=org.hibernate.dialect.SQLServer2012Dialect

server.port = 9090

spring.jpa.properties.hibernate.show_sql=true

spring.jpa.properties.hibernate.use_sql_comments=false

spring.jpa.properties.hibernate.format_sql=true

#jackrabbit configs

jackrabbit.username=admin

jackrabbit.userpassword=admin

jackrabbit.url=http://localhost:8080/jackrabbit-webapp-2.18.5/server

Then I will add spring boot startup class as  AppInitializer class with following content in "com.nirmal.JackrabbitSpringBoot.app" package.

package com.nirmal.JackrabbitSpringBoot.app;

    import javax.sql.DataSource;

    import org.springframework.beans.factory.annotation.Autowired;

    import org.springframework.boot.SpringApplication;

    import org.springframework.boot.autoconfigure.SpringBootApplication;

    import org.springframework.boot.builder.SpringApplicationBuilder;

    import org.springframework.boot.web.support.SpringBootServletInitializer;

    import org.springframework.context.annotation.ComponentScan;

/**

 * Spring Boot initialization class of the JackrabbitSpringBoot project

 *

 * @author Nirmal Balasooriya

 *

 */

//@EnableJpaRepositories("com.nirmal.springbootrest")

@SpringBootApplication(scanBasePackages = { "com.nirmal.JackrabbitSpringBoot.app" })

@ComponentScan({"com.nirmal.JackrabbitSpringBoot.app"})

public class AppInitializer extends SpringBootServletInitializer {

    @Autowired

    DataSource dataSource;

    @Override

    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {

        return application.sources(AppInitializer.class);

    }

    public static void main(String[] args) {

        SpringApplication.run(AppInitializer.class, args);

    }

}

Next Lets add the Controller. In my controller it will have two API methods call "getImage" and "uploadResource". Both will take both will take path variable call "resourceName". (This is image name without extension). Full controller will be as below.

package com.nirmal.JackrabbitSpringBoot.app;

import org.apache.tika.io.IOUtils;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.springframework.core.io.ClassPathResource;

import org.springframework.core.io.Resource;

import org.springframework.http.MediaType;

import org.springframework.stereotype.Component;

import org.springframework.stereotype.Controller;

import org.springframework.web.bind.annotation.GetMapping;

import org.springframework.web.bind.annotation.PathVariable;

import org.springframework.web.bind.annotation.ResponseBody;

import org.springframework.beans.factory.annotation.Value;

import javax.jcr.*;

import org.apache.jackrabbit.commons.JcrUtils;

import java.io.InputStream;

@Controller

@Component

public class MainController {

    Logger logger = LoggerFactory.getLogger(MainController.class);

    @Value("${jackrabbit.username}")

    private String username;

    @Value("${jackrabbit.userpassword}")

    private String userPassword;

    @Value("${jackrabbit.url}")

    private String jackrabbitUrl;

    @GetMapping("/uploadResource/{resourceName}")

    @ResponseBody

    public Response uploadResource(@PathVariable("resourceName")String resourceName) throws Exception {

        logger.info("Upload resource resourceName : " + resourceName);

        JackRabitResource jackRabitResource=new JackRabitResource();

        resourceName=resourceName+".jpg";

        Response<JackRabitResource> response = new Response<JackRabitResource>("0", "Resource does not exist", null);

        if (new ClassPathResource(resourceName).exists()){

            uploadFile(resourceName);

            response = new Response<JackRabitResource>("1", "Resource Added Successfully", jackRabitResource);

        }

        return response;

    }

    @GetMapping(

            value = "/getImage/{resourceName}",

            produces = MediaType.IMAGE_JPEG_VALUE

    )

    public @ResponseBody byte[] getImage(@PathVariable("resourceName")String resourceName) throws Exception {

        logger.info("Get Image resourceName : " + resourceName);

        resourceName=resourceName+".jpg";

        if (new ClassPathResource(resourceName).exists()){

            try {

                return getContent(resourceName);

            }catch (PathNotFoundException e){

                return null;

            }

        }

        return null;

    }

    public void uploadFile(String name) throws Exception{

        Repository repository = JcrUtils.getRepository(jackrabbitUrl);

        Session session = repository.login(

                new SimpleCredentials(username, userPassword.toCharArray()));

        try{

            Resource resource = new ClassPathResource(name);

            InputStream stream = resource.getInputStream();

            Node folder = session.getRootNode();

            Node file = folder.addNode(name,"nt:file");

            Node content = file.addNode("jcr:content","nt:resource");

            Binary binary = session.getValueFactory().createBinary(stream);

            content.setProperty("jcr:data",binary);

            content.setProperty("jcr:mimeType","image/gif");

            session.save();

        }finally{

            session.logout();

        }

    }

    public byte[] getContent(String name) throws Exception{

        Repository repository = JcrUtils.getRepository(jackrabbitUrl);

        Session session = repository.login(

                new SimpleCredentials(username, userPassword.toCharArray()));

        Node folder = session.getRootNode();

        Node file=folder.getNode(name);

        Node content=file.getNode("jcr:content");

        String path = content.getPath();

        Binary bin = session.getNode(path).getProperty("jcr:data").getBinary();

        InputStream stream = bin.getStream();

        return IOUtils.toByteArray(stream);

    }

}

For testing purposes I will put two jpg images in resource folder so after all there you could see similar project structure as below figure.

Final project structure 

Lets run the applciation

You can perform maven install command on the project and then you can run the application by following command in target folder. Make sure that JBoss EAP which we deployed jackrabbit server running while you are testing.

java -jar JackrabbitSpringBoot-1.0-SNAPSHOT.jar

Once application successfully started you could see similar console output as show below.

Also you should be able to access following URL from browser http://localhost:9090/getImage/srilanka and should get following output on web browser.

Then lets try to upload two images in to jackrabbit repository which I added in side the resource folder. You can brows following URL and should able to get respective outputs as well.

http://localhost:9090/uploadResource/colombo

http://localhost:9090/uploadResource/srilanka

Since both resources "srilanka.jpg" and "colombo.jpg" available in resources folder both occasions it will return following output.

{"code":"1","desc":"Resource Added Successfully","t":null}

In case if you try to access not available resource as below.

http://localhost:9090/uploadResource/corona

{"code":"0","desc":"Resource does not exist","t":null}

So now we can access our jackrabit repository from following URL and see whether resources are uploaded.

http://localhost:8080/jackrabbit-webapp-2.18.5/repository/default/

You should be able to see as following 

Then lets try to access resources in Jackrabbit repository. for respective URLs should return similar output as show below.

http://localhost:9090/getImage/srilanka

Retrieving image from repository

http://localhost:9090/getImage/colombo

Retrieving image from repository

You can find the code base related to this project from following FITHUB location.