I want to share how to build the custom module “Last Registered Users” in Jahia Beta 6.5. The purpose of this module is to display the last registered users. The number of users to display is configured in the module. Additionally, I am going to quickly explain how to create a custom module project using mvn and import it into Eclipse.


The first step is to create a custom module using the maven archetype. This post assumes that you already had configured hot deployments for Jahia modules as mention in the post “Jahia 6.5 Setting Up a Development Environment”.

Please do the following:

1)   Execute the archetype “mvn archetype:generate -DarchetypeCatalog=http://maven.jahia.org/maven2”, chose number 3 and fill the project information.
2)   Cd inside the recently created folder and execute “mvn eclipse:eclipse”. In my case I am using the folder C:\jahia65custommodules\OshynModules.
3)   In the project go to src\main\webapp\ and create the folder jnt_lastRegisteredUsers.
4)   Cd into /jnt_lastRegisteredUsers/ and create the folder /html/.
5)   Cd into /html/ and create the file lastRegisteredUsers.jsp.
6)   In this point you can import the newly created project into On Eclipse go to File > Import > Existing Project into Workspace and choose the project created by the archetype.
7)    Open the file \src\main\webapp\ definitions.cnd and add the module definition for now as:
[jnt:lastRegisteredUsers] > jnt:content, jmix:structuredContent, mix:title

Note: This definition means that this module is going to be deployed into Jahia into the section “Structured Content”.
8)   Open the file \src\main\webapp\jnt_lastRegisteredUsers\html\lastRegisteredUsers.jsp and for now make it look like:
<%@ taglib prefix="jcr" uri="http://www.jahia.org/tags/jcr" %>
<%@ taglib prefix="fmt" uri="http://java.sun.com/jsp/jstl/fmt" %>
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
<%@ taglib prefix="utility" uri="http://www.jahia.org/tags/utilityLib" %>
<%@ taglib prefix="template" uri="http://www.jahia.org/tags/templateLib" %>
<%@ taglib prefix="fn" uri="http://java.sun.com/jsp/jstl/functions" %>


<h2>Last Registered Users</h2>
9)   To test, that all goes ok, you can open a command line cd into: C:\jahia65custommodules\OshynModules and please execute the command “mvn package jahia:deploy”. Before proceed with the execution of this file, please verify that your Jahia Beta 6.5is up.
10)   In Jahia the module should appear in the edit mode like the following screen:


If you want to get the complete code of this module please click here

Last Registered Users Description
This module is responsible for displaying the last registers users in a Jahia Site using the property “number users” as parameter. This property is an integer that means the number of last registered users to display when the module renders its content. The value of this parameter needs to be set when the module is created inside a page. Jahia Last Registered Users module uses the same Jahia Service org.jahia.services.usermanager.JahiaUserManagerService used by the original Jahia module “Form for User Registration” for the administration of the users.

Considerations
1.To test this module I used Jahia Beta 6.5 and imported the test Jahia Site “ACME” that came with this distribution.
2.To register new users I used the original Jahia module “Form for User Registration”.
Notice that in the code there are two versions of the Last Registered Users module: jnt_lastRegisteredUsers and jnt_lastRegisteredUsersSync. This is the reason that in the file definitions.cnd there are two different modules defined.
Below is a screenshot of the module in action.


Module jnt_lastRegisteredUsers Characteristics
1.   Uses Spring Injection of the class org.jahia.services.usermanager.JahiaUserManagerService into the custom action LastRegisteredUsers.java to get access to the Jahia User Services and perform queries in the Action.
2.   The Spring Injection is defined in the file mod-lastRegisteredUsers.xml.
3.   The JSP file lastRegisteredUsers.jsp calls the action via ajax and render the module when the page loads

Module jnt_lastRegisteredUsersSync Characteristics
This module does the same task as the above one, but it does not uses AJAX.
1.   Instead of using Jahia Actions and Spring Injection, the backend of this module uses the custom bean LastRegisteredUsersSync.
2.   This class, to gain access to the Jahia User Service, uses the code:
((JahiaUserManagerService) org.jahia.services.SpringContextSingleton.getBean("JahiaUserManagerService"));

3.   The JSP file lastRegisteredUsersSync.jsp creates an instance of the bean in game, sets the number of last registered users to show, and gets the html code to render the module.