Tug’s Blog

My journey in Big Data, Hadoop, NoSQL and MapR

Twitter Boostrap 2 and Google Maps

| Comments

Like many developers I am using Twitter Boostrap for my Web applications. Using this framework has been very helpful for me, since I am really not a good HTML/CSS developer. For now, on my site Resultri I am using the default look and feel, will customize it later.

Lately, I wanted to integrate Google Map to my application, and when testing it, I had the bad surprise to see that the Controls and WindowInfo are not printed correctly as you can see in the screen shot below:

This is not a big issue at all, just a conflict on the img tag and its style (max-width) coming from Twitter Bootstrap. The quick fix :

  • override the style of the img tag for the div that contains your map.

For example in my case the div for my map is define as:

1
<div id="resultriMap" />

You just need to add a new style to your page with the following definition:

1
2
3
4
5
6
7
<style>

#resultriMap img {
  max-width: none;
}

</style>

After adding this to my page the map is correctly printed as you can see in the following screenshot :

SAP Cloud Inside : Build and Run Applications in the Cloud

| Comments

Last week I was invited to present eXo Cloud IDE during the SAP Cloud Inside. This SAP Community event was a great opportunity to discuss about the cloud with an interesting point of view: the impact of the cloud for SAP customers (especially administrators and developers).

During this presentation I have introduced the eXo Cloud IDE, and I did a demonstration in which O have built and deployed applications : Open Social Gadgets, Ruby on Rails and Java/Spring, and explain how it could be extended to SAP business services.

Here the slides that I have used during this presentation:

SAP Cloud Inside : Develop and Run on the Cloud

Remember that you can register yourself to the eXo Cloud IDE Service and start develop application from your browser.

eXo Platform : Integrate Twitter and eXo Activity Stream

| Comments

eXo Platform 3.5 provides many extension points and API for developers, allowing them to create very cool stuff.

I have developed a small extension that allows any user to associate his Twitter account to his eXo Platform account. This extension simply post on your Twitter account when you write a message with a special hashtag (#tw).

This is a very quick development that I have done while waiting for my kids, so I still have things to integrate to provide complete feature, but this is a good example to show how you can extend the platform.

You can view it in action in this video:

You can download the source code and the binaries from this GitHub project. I hope to find some time to complete the feature, and document this use case.

Enjoy!

How to Watch YouTube Videos Offline (on OS X)?

| Comments

Lately I have been traveling a lot, and I was not able to access the internet all the time; but I still want to look at some YouTube video, for example the greate Google I/O Sessions…

My needs are simple :

  • running on OS X (Lion)
  • download the video easily
  • no need to convert the file (to be able to read the file as soon as possible)
  • free

After some basic research, I found an easy way to achieve this using the following softwares:

Enjoy!

Installing Memcached on Mac OS X and Using It in Java

| Comments

Introduction

In this article I will explain how you can:

  1. Install and Configure Memcached on Mac OS X
  2. Use Memcached in your Java Application

I won’t go in too much detail about the benefits of using a distributed cache in your applications, but let’s at least provide some use cases for applications that are running in the context of an enterprise portal, eXo Platform in my case - surprising isn’t? And I will show this in another post.

We have many reasons to use a cache (distributed or not), in the context of enterprise portal, let’s take a look to some of these reasons:

  • A portal is used to aggregate data in a single page. These data could come from different sources : Web Services, Database, ERP, ….. and accessing the data in real time could be costly. So it will be quite interesting to cache the result of the call when possible.
  • If the portal is used to aggregate many data from many sources, it is sometime necessary to jump into another application to continue some operation. A distributed and shared cache could be used to manage some context between different applications running in different processes (JVM or even technologies) These are two example where a shared cache could be interesting for your portal based applications, we can find many other reason.

Note that the Portlet API (JSR-286) contains already a cache mechanism that cache the HTML fragment, and that eXo Platform also provide a low level cache, based on JBoss Cache.

JAX-RS: Jersey and JSON Single Element Arrays

| Comments

Last week I have been struggling with a small issue while developing a service using Jersey.

The goal of this service is to provide JSON object to my Web application, so called directly from the browser. This service returns in a JSON array a list of Employees, something like:

1
2
3
4
{"employee":[
{"email":"jdoe@example.com","firstName":"John","lastName":"Doe"},
{"email":"mmajor@example.com","firstName":"Mary","lastName":"Major"}
]}

So an “employee” array, this is perfect and expected, but when my service returns a single element the returned object looks like:

1
{"employee":{"email":"jdoe@example.com","firstName":"John","lastName":"Doe"}}

As you can see brackets […] are missing around the employee item. This is an issue since your client code is expecting an array.

How to Create a New Content List Template for eXo Platform 3

| Comments

Introduction

eXo Platform provide many powerful features to manipulate and expose any type of content on a page. This is due to the fact that eXo stores the all the content in its Java Content Repository (JCR) and render the content on a page using Groovy Templates.

In this how to you will learn how you can create and use template that are used in the “Content List” portlet. For example in the ACME sample site you can show the content in 1 or 2 columns just by selecting different templates.

One Column View

Two Columns View

Creating a new Content List Template

In this section you will learn how to create a new template using the eXo IDE. Before writing the new template it is important to learn where the templates are stored.

eXo Content Service: Template Storage

Like many things inside eXo Platform, the eXo JCR is used to stored the templates. Templates are just a special type of content. This allows developers to easily write and test code without having complex deployment process, but also it make the life easy to export a running configuration to another one. For this you just need to use the standard JCR export/import features.

All the template and eXo Content Service configurations are stored inside a specific JCR workspace named : dms-system.

Each template type (Document Type, Content List, ….) is stored in a specific location. In our case we want to work on the “Content List” portlet so the template are stored inside the following folder:

  • /exo:ecm/views/templates/content-list-viewer/list/

Just for the fun of it, let’s inspect this folder using the eXo CRaSH utility. If you are not interested you can jump to the next section. CRaSH is a shell for Java Content Repositories, the source of CRaSH is available on Google Code. So in a terminal window:

1- Connect to CRaSH using telnet client:

1
 telnet 127.0.0.1 5000

2- Connect to the JCR workspace using the following command:

1
 connect -u root -p gtn -c portal dms-system</span>

Where: -u is the user, -p the password, -c the Portal Container, and dms-system the workspace to use

3- Move the the folder that contains all the templates for the Content List portlet:

1
 cd /exo:ecm/views/templates/content-list-viewer/list/

4- List all the templates using the ls command You can see the list of all the templates available for the Content List portlet.

Create a new template using the eXo IDE

Let’s now create a new template using the IDE. For this be sure you are connected with a user that is part of the /Developer group. For simplicity reason I am using the root user.

The first important step is to go the the template location using the following steps:

1- Access the IDE: click on My Spaces &gt; IDE.

2- Switch dms-system workspace: In the IDE menu click My Spaces &gt;on Window &gt; Select Workspace. And select the dms-system location in the dialog box and click OK.

3- In the file structure on the left navigate to the template location :

1
/exo:ecm/views/templates/content-list-viewer/list/

4- Create a new template : In the IDE Menu click on File &gt; New &gt; Groovy Template

5- Save the file as “MyNewTemplate.gtmpl

6- Enter some basic code:

1
2
<h1>This is my template</h1>
The date is <= new Date()>

7- Save the template

8- Go back to the Home page of the Acme Site

9- Switch to Edit more by selecting Edit in the top right drop down list.

10- Move you mouse at the top of the list of news and click on the preference button:

11- In the list of templates, select the “MyNewTemplate”, and click save.

We have created our new template, and use it on a page. We should now add some more interesting code to the template to really loop over the content based on the portlet configuration. But before this it is important to talk about caching and code modification.

eXo Template and Cache

To improve performances and a running system, the compiled version of the template is by default cached. This is why when you are modifying a template you do not see any change. We have two ways to work around this:

  • Run eXo Platform in Debug mode, in this case nothing is cached
  • Invalidate the cache manually using JMX

Since working with no cache at all is not an option, here is the MBean you have to use to invalidate the Template Service cache:

  • exo:portal="portal",service=cache,name="TemplateService", then call the clearCache operation on it

I do use JConsole for this, but you can use any method to call your MBeans operation.

Do not forget to call this operation each time you modify your template to be sure eXo recompile the template.

Accessing Content in the template

The current code of the template is really simple, you need now to add code to print the content in the page. For this we will be using some eXo Content programming, once again in the IDE.

If you are not interested to have detailed explanation of the code you can go to the complete source code here.

The template used by the Content List portlet is based on the following Java class org.exoplatform.wcm.webui.clv.UICLVPresentation, this class is responsible to set the complete context that you can use in the template such as:

  • The folder or category that contains the content to show. The “Folder Path” field in the preference screen
  • The display settings: title, number of documents, elements to show, …

Here is the code to access these preferences:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// import all the classes need in the template
import javax.jcr.Node;
import org.exoplatform.wcm.webui.paginator.UICustomizeablePaginator;
import org.exoplatform.wcm.webui.clv.UICLVPortlet;
import org.exoplatform.wcm.webui.Utils;
import org.exoplatform.services.wcm.core.NodeLocation;

// get the portlet preferences
def header = uicomponent.getHeader();
def isShowRssLink = uicomponent.isShowRssLink();
def isShowHeader = uicomponent.isShowField(UICLVPortlet.PREFERENCE_SHOW_HEADER);
def isShowRefresh = uicomponent.isShowField(UICLVPortlet.PREFERENCE_SHOW_REFRESH_BUTTON);

def isShowTitle = uicomponent.isShowField(UICLVPortlet.PREFERENCE_SHOW_TITLE);
def isShowDate = uicomponent.isShowField(UICLVPortlet.PREFERENCE_SHOW_DATE_CREATED);
def isShowLink = uicomponent.isShowField(UICLVPortlet.PREFERENCE_SHOW_LINK);
def isShowReadmore = uicomponent.isShowField(UICLVPortlet.PREFERENCE_SHOW_READMORE);
def isShowImage = uicomponent.isShowField(UICLVPortlet.PREFERENCE_SHOW_ILLUSTRATION) ;
def isShowSummary = uicomponent.isShowField(UICLVPortlet.PREFERENCE_SHOW_SUMMARY);

The uicomponent object is defined by the container class of the portlet that calls the template. This class contains many utility methods. In the code above I retrieve all the preferences of the portlet, since the name are self-explanatory it is not necessary to detail them, especially when you look at the preferences screen below:

Now that the template has all the preferences, it is time to loop on the content on print the information.

The eXo Content Service provides API to manipulate the content, including pagination of content. The idea behind this is to let the Content Service manage the JCR query, sorting, caching and pagination of data. So in your template you will mainly manage two classes to loop through the content to show:

  • uicomponent.getUIPageIterator() a paginator object that is configured based on the portlet preferences
  • uicomponent.getCurrentPageData()contains a list of the content (JCR Nodes) that should print on the current page

So let’s print all the content of the page as a simple HTML list:

1
2
3
4
5
6
7
8
<ul style="margin: 20px">
<%
for (viewNode in uicomponent.getCurrentPageData()) {
  def title = viewNode.getProperty("exo:title").getString();
  print("<li>$title</li>");
}
%>
</ul>

Just copy this code in your template, save it, refresh the cache… and go to your page. You should see the list of the content in a simple HTML list.

On each content (Node), eXo Content API provides some helper method to easily manipulate the content and avoid using the JCR API directly. In the following code you can see the most important methods accessing content properties:

1
2
3
4
5
6
7
8
9
def itemName = viewNode.getName();
def itemLink = uicomponent.getURL(viewNode);
def webdDavLink = uicomponent.getWebdavURL(viewNode);
def itemDateCreated = uicomponent.getCreatedDate(viewNode);
def itemModifiedDate = uicomponent.getModifiedDate(viewNode);
def itemAuthor = uicomponent.getAuthor(viewNode);
def imgSrc = uicomponent.getIllustrativeImage(viewNode);
def itemTitle = uicomponent.getTitle(viewNode);
def itemSummary = uicomponent.getSummary(viewNode);

One important point is the fact that these methods are responsible of many things, for example: formatting dates, returning complete URLs depending of the context of the portlet.

Based on these methods you can now work on the presentation of the information on the page. Let’s for example print the image, the title and allow user to click on the title to go in the detail view of the article. This is done simply using the following code:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<%
for (viewNode in uicomponent.getCurrentPageData()) {
  def itemName = viewNode.getName();
  def itemLink = uicomponent.getURL(viewNode);
  def webdDavLink = uicomponent.getWebdavURL(viewNode);
  def itemDateCreated = uicomponent.getCreatedDate(viewNode);
  def itemModifiedDate = uicomponent.getModifiedDate(viewNode);
  def itemAuthor = uicomponent.getAuthor(viewNode);
  def imgSrc = uicomponent.getIllustrativeImage(viewNode);
  def itemTitle = uicomponent.getTitle(viewNode);
  def itemSummary = uicomponent.getSummary(viewNode);

  %>
  <div style="overflow: auto;">
  <img src="$imgSrc" align="left">
  <h3><a href="$itemLink">$itemTitle</a></h3>
  $itemSummary
  </div>

  <%
}
%>

For simplicity reason, this code does not manage any null value. Also the template do not deal with the portlet preferences such as the “Header”, “RSS” links and so on, do not hesitate to do it if you want.

The Web site should look like the following image:

The last important point is to add the support for the in context editing that allows the user to edit the content directly from the template. Once again this is done with a method of the uicomponent object, that create a DIV around the content. Let’s add this to the template:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<%
for (viewNode in uicomponent.getCurrentPageData()) {
  def itemName = viewNode.getName();
  def itemLink = uicomponent.getURL(viewNode);
  def webdDavLink = uicomponent.getWebdavURL(viewNode);
  def itemDateCreated = uicomponent.getCreatedDate(viewNode);
  def itemModifiedDate = uicomponent.getModifiedDate(viewNode);
  def itemAuthor = uicomponent.getAuthor(viewNode);
  def imgSrc = uicomponent.getIllustrativeImage(viewNode);
  def itemTitle = uicomponent.getTitle(viewNode);
  def itemSummary = uicomponent.getSummary(viewNode);

  %>
  <div style="overflow: auto;">
  <%=uicomponent.addQuickEditDiv("MyTemplateContentEditor", viewNode)%>
  <img src="$imgSrc" align="left">
  <h3><a href="$itemLink">$itemTitle</a></h3>
  $itemSummary
  < /div>
  </div>

  <%
}
%>

The lines 15 and 19 are new in this template and provide support for Quick Edit feature.

Done! We have created a new template for eXo Platform Content Service using embedded IDE.

Conclusion

In this article you have learned how to create a new template for eXo Content Service, with some basic steps:

  • Create a new Groovy Template using the eXo IDE
  • Edit this template using the eXo Java Content API
  • Configure your Content List portlet instance on a page to select the new template

You can now create your own templates and use your imagination to add cool features to your site (for example the carrousels you see on the eXo site are using custom CLV template.)

How to Protect Your REST Service and Gadget in eXo Platform

| Comments

During a partner workshop I was showing to the developers how the eXo IDE can help them to develop new features quickly and push them to the users in few minutes. A person asked me if it is possible to put some restriction in services and gadgets based on user profile.

As you can guess the answer is YES WE CAN!

  • How to access the security context in a REST service
  • How to check is a user is member of a group and manage permission from this information
  • How to consume this service in a gadget and leverage the security to protect resources

Not-authorized

Authorized

If you are not interested to follow steps by step the explanations you can directly jump to the complete REST Service code or download the full eXo IDE Project from GitHub

Access the User Profile from your REST Service

As you probably know eXo Platform uses JAX-RS as API to develop and deploy REST Services. eXo developers can create REST services using their favorite Java IDE, but here I am using the eXo IDE package with eXo Platform.

To access the security and user information in your service method it is possible to use the SecurityContext class of the JAX-RS API. Your method signature will look like:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
import javax.ws.rs.Path
import javax.ws.rs.GET
import javax.ws.rs.PathParam
import javax.ws.rs.core.Response
import javax.ws.rs.core.MediaType
import javax.ws.rs.Produces
import javax.ws.rs.core.SecurityContext
import javax.ws.rs.core.Context

@Path("/system")
@Produces("application/json")
public class SystemInformationService {

  @GET
  @Path("information")
  public Response getSystemInfo(@Context SecurityContext sc) {
    sc.getUserPrincipal();
    return Response.ok("foo", MediaType.APPLICATION_JSON).build();
  }

}

In lines 7 and 8, I import the classes needed to inject the security context in the method getSystemInfo() in line 16. For now let’s forget about the other part of the code.

With the Security Context object you can now access many things in your code. Two methods are quite interesting for this example: getUserPrincipal() and isUserInRole(), since our goal is to check if a user is allowed to execute or not a part of the business logic.

It is important here to remember that we cannot directly use the isUserInRole() method since this method uses the logical JavaEE roles that are defined at the Java application level. In our case we are interested to know if a user is present in a “eXo User Identity” Group, for example member of the /platform/administrators group. This information is populated during the login process and comes from the user provider that could be LDAP, the eXo Database or JCR, or any other source since developers can extend this API to plug their own provider.

Let’s create an helper method that check, using the eXo Identity Service, if the user that executes the method is present in a group.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
...
import org.exoplatform.container.ExoContainer;
import org.exoplatform.container.ExoContainerContext;
import org.exoplatform.container.component.ComponentPlugin;
import org.exoplatform.services.security.Identity;
import org.exoplatform.services.security.IdentityRegistry;
...
...

private boolean isMemberOf(String username,String group) {
  ExoContainer container = ExoContainerContext.getCurrentContainer();
  IdentityRegistry identityRegistry = (IdentityRegistry) container.getComponentInstanceOfType(IdentityRegistry.class);
  Identity identity = identityRegistry.getIdentity(username);
  return identity.isMemberOf( group );
}

So this method is quite simple, it takes as parameter:

  • the name of the user, that you can get from the UserPrincipal.getName() method
  • the eXo Group you want to check, for example /platform/administrator

You can now call this method from your resource to check the user, and code the “permission business logic”. The method could now looks like:

1
2
3
4
5
6
7
8
9
10
11
12
13
@GET
@Path("information")
public Response getSystemInfo(@Context SecurityContext sc) {
  String groupToCheck = "/platform/administrators";
  String response = "";
  if (sc.getUserPrincipal() == null || !this.isMemberOf(sc.getUserPrincipal().getName(), groupToCheck) ) {
    response = "NOT-ALLOWED";
    } else {
      response = "ALLOWED";
    }
    return Response.ok(  response   , MediaType.APPLICATION_JSON).build();
  }
...

In this example for simplicity reason I have hard coded the group to check, you can obviously use smarter code to user external configuration to inject a list of group to check for example. I manage the security logic of my method using simple if statement and return a string. You can also depending of your needs, manage the status of your response and use HTTP Code for example return an HTTP 403. For this you just need to return a different response using following code:

1
return Response.status(Response.Status.FORBIDDEN).build();

For simplicity reason I will stay with a single Response status (OK) and manage the permission in my client code.

Complete REST Service

Let’s take a look to the full service now, this service allows administrators to get the list of the System Properties, other users get an status string “NOT-ALLOWED”:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
import javax.ws.rs.Path
import javax.ws.rs.GET
import javax.ws.rs.PathParam
import javax.ws.rs.core.Response
import javax.ws.rs.core.MediaType
import javax.ws.rs.core.CacheControl
import javax.ws.rs.Produces
import javax.ws.rs.core.SecurityContext
import javax.ws.rs.core.Context

import org.exoplatform.container.ExoContainer;
import org.exoplatform.container.ExoContainerContext;
import org.exoplatform.container.component.ComponentPlugin;
import org.exoplatform.services.security.Identity;
import org.exoplatform.services.security.IdentityRegistry;

@Path("/system")
@Produces("application/json")
public class SystemInformationService {


  @GET
  @Path("information")
  public Response getSystemInfo(@Context SecurityContext sc) {
    String groupToCheck = "/platform/administrators";
    SimpleResponseWrapper response = new SimpleResponseWrapper();
    String status = "";
    if (sc.getUserPrincipal() == null || !this.isMemberOf(sc.getUserPrincipal().getName(), groupToCheck) ) {
      response.status = "NOT-ALLOWED";
    } else {
      response.status = "OK";
      response.data = System.getProperties();

    }

    CacheControl cacheControl = new CacheControl();
    cacheControl.setNoCache(true);
    cacheControl.setNoStore(true);
    return Response.ok(  response   , MediaType.APPLICATION_JSON).cacheControl(cacheControl).build();
  }

  private boolean isMemberOf(String username,String role) {
    ExoContainer container = ExoContainerContext.getCurrentContainer();
    IdentityRegistry identityRegistry = (IdentityRegistry) container.getComponentInstanceOfType(IdentityRegistry.class);
    Identity identity = identityRegistry.getIdentity(username);
    return identity.isMemberOf( role );
  }

}

public class SimpleResponseWrapper {
  String status;
  Object data;
}

To summarize:

  • Line 24 : the SecurityContext is injected to the method
  • Line 26 : Initialization of a simple ResponseWrapper defined on line 51, that contains a status and data. That will be serialized in JSON by the eXo REST engine.* Line 28 : the method check if a user is connected and member of /platform/administrator. If not it send response with the status NO-ALLOWED.
  • Line 31/32 : The response object is sent. This response contains an OK status and the data (system properties list)
  • Line 42 : Using the eXo Identity Service, the method check if the connected user is member of a specific group.

Consume the service into a Gadget

I can now take this service and consume it into an Gadget. I also develop this Gadget using the eXo IDE.

The following code shows the Javascript part of the Gadget that calls the service, check the security and push the response content in Gadget body. For productivity I use JQuery framework.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
<script>
function printInfo(result) {
  var htmlResponse= [];
  if (result.status == "OK") {
    var data = result.data;
    htmlResponse.push("<tr>");
    $.each(data, function(index, value) {
      htmlResponse.push('<tr><td>'+ index + '</td><td>' + value + '</td></tr>');
    });
    htmlResponse.push("</tr>");
    $('#systemInfo').height(200);
  }
  else {
    htmlResponse.push("Not permitted");
    $('#systemInfo').height(50);
  }
  $('#systemInfo').html(htmlResponse.join(''));
  gadgets.window.adjustHeight( $('#sysInfoContainer').outerHeight()  );

}

function loadInformationFromServer() {
  $.getJSON('/rest/private/system/information', function(result){ printInfo(result);   } );
}

function init() {
  loadInformationFromServer();
}

gadgets.util.registerOnLoadHandler(init);

</script>

Here some quick explanation about this code:

  • Line 23: To call the REST service, I use the $.getJSON() method. This method is really easy to use when you are executing the Gadget is in the same container than the portal that consumes it. When you are using the gadget.io.MakeRequest is interesting to proxy a request and you need to re-authenticate, for example using oAuth.
  • Line 3 : This is the call back method, as you can see in this method I use the ResponseWrapper to check the code in the status attribute. Depending of the status OK or not I do print the value.

Conclusion

In this how-to you have learned how to:

  • Get the security context in your REST Service
  • Check the membership of a user using the eXo Identity Service
  • Create a gadget that consume this service and expose only data to user with correct profile
  • Download the full project from GitHub

eXo Cloud IDE : Develop for the Cloud on the Cloud

| Comments

Yesterday, eXo has launched a new cloud based service: the eXo Cloud IDE. This IDE is an online service that facilitates the development of gadgets and mashups that could be deployed directly to a PaaS.

Before launching this service on the Cloud we, eXo team and customers, have used the IDE embedded in the eXo Platform to extend our intranet and customer deployments (some of the modules that we have developed live on our intranet are available as plugins on the eXo Resource Center).

This IDE is the last mile between the users and the developers. It provides a way to add new services asked by business users at a lower cost with a good time to market. And all this based on standards that corporate and Web developers like : REST Services using JAX-RS and UI based on OpenSocial gadgets in which you can leverage all the cool and powerful features of HTML5.

What eXo has launched yesterday is a big step for developers since you can now develop, test and deploy your gadgets and services online, and this in your “personal environment” using eXo Cloud IDE supports multi-tenancy. I won’t go in all the features of the IDE since you can test it yourself by joining the beta program and look at this video:

eXo Cloud IDE resources:

How to Calculate the Size of a Folder in JCR (Java Content Repository)?

| Comments

Today I was working with a partner in Paris and he wanted to know how to calculate the size of a specific folder in the eXo Java Content Repository (JCR).

For this specific need the goal is to calculate the size of all the documents stored inside a specific location in the content repository. This could be used for example to manage quotas, estimate the size of a shared or personal storage, … For this specific sample I will only take in consideration the size of the binary part of the document stored in the repository; this means I will not pay attention to the various attributes and meta-data that are also stored, neither the full text index created by Lucene that is embedded in eXo JCR.

How the files are stored in the JCR?

Files are stored in eXo JCR in the standard node type nt:file (and nt:resource). So for this example I will simply list all the nt:file of a folder and aggregate the size of the file itself. It is important to understand how JCR is storing the binary content. The best way to understand it, is to view it. For that I am using the print information given by CRaSH, a shell for content repository developed by eXo team and lead by Julien Viet.

Here the structure of a PDF document :

1
2
3
4
5
6
7
8
/Documents/jsr170-1.0.pdf
+-properties
| +-jcr:primaryType: nt:file
| +-jcr:mixinTypes: [mix:referenceable,mix:versionable]
| +-jcr:uuid: '6b89b6f0c0a8006530a8617df51bb0d7'
| +-jcr:created: 2011-02-28T10:11:50.770+01:00
+-children
| +-/Groups/spaces/intranet_v2/Documents/Technical/jsr170-1.0.pdf/jcr:content

As you can see in this node the ‘binary’ is not visible, nothing bad here. As written in the specification in the section 6.7.22.6 nt:file, the binary content is an attribute of the child node jcr:content that is exposed below:

1
2
3
4
5
6
7
8
9
10
11
/Groups/spaces/intranet_v2/Documents/Technical/jsr170-1.0.pdf/jcr:content
+-properties
| +-jcr:primaryType: nt:resource
| +-jcr:mixinTypes: [exo:owneable,exo:datetime,dc:elementSet]
| +-jcr:uuid: '6b89b6f7c0a80065735b1a8853d389d0'
| +-jcr:data: <binary>
| +-jcr:encoding: 'UTF-8'
| +-jcr:lastModified: 2011-02-28T10:11:50.767+01:00
| +-jcr:mimeType: 'application/pdf'
+-children
</binary>

You can see now that the jcr:content contains some interesting attributes:

  • jcr:mimeType
  • jcr:data this is where the binary content, the PDF itself , is. So using the JCR API you just need to get the content length using the following java code:
1
node.getProperty("jcr:content/jcr:data").getLength()

This returns the number of bits of the binary data.

So to calculate the size of a folder you just need to navigate in all the documents (nt:file or jcr:content) and cumulate the size of all the files. In this following code, I am calculating the size of the folder “/Documents” by navigating into all the files contains in this folder and subfolders. (I could have chose to query all the jcr:content type instead of nt:file)

1
2
3
4
5
6
7
8
9
10
11
12
Session session = getSession(); // use RepositoryService or context to get a session
QueryManager manager = session.getWorkspace().getQueryManager();
String queryStatement = "select * from nt:file where (jcr:path LIKE '/Documents/%')";
Query query = manager.createQuery(queryStatement, Query.SQL);
NodeIterator nodeIterator = query.execute().getNodes();
Node node = null;
long totalSizeInMb = 0;

while (nodeIterator.hasNext()) {
  node = nodeIterator.next();
  totalSizeInMb = totalSizeInMb + node.getProperty("jcr:content/jcr:data").getLength() / (1024*1024);
}

As you can guess since we are navigating in the hierarchy you have to be very careful when using such query. This example is just a simple code sample to show you some of the cool features provided by the JCR API.