<\/p>\n
Install JRebel in Eclipse<\/h2>\n
The first step is to install JRebel in Eclipse. Simply follow the first 3 steps in this tutorial on the JRebel website.<\/p>\n
New Portlet Project<\/h2>\n
Before going further with JRebel, you need to create a new portlet project:<\/p>\n
- \n
- Go to File > New > Project…<\/b><\/li>\n
- Select Maven > Maven Project<\/b><\/li>\n
- Check Create a simple project (skip archetype selection)<\/b><\/li>\n
- Click Next<\/b><\/li>\n
- Fill maven information. For example:\n
- \n
- Group ID: org.exoplatform<\/li>\n
- Artifact ID: jrebel.portlet<\/li>\n
- Version: 1.0.0-SNAPSHOT<\/li>\n
- Packaging: war<\/li>\n
- Name: Portlet with JRebel<\/li>\n
- Description: Portlet with JRebel<\/li>\n<\/ul>\n<\/li>\n
- Click Finish<\/b><\/li>\n<\/ul>\n
<\/p>\n
Once created, you can add the source file for the portlet:<\/p>\n
src\/main\/webapp\/WEB-INF\/web.xml<\/b><\/i><\/p>\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE web-app PUBLIC \"-\/\/Sun Microsystems, Inc.\/\/DTD Web Application 2.3\/\/EN\"\n \"http:\/\/java.sun.com\/dtd\/web-app_2_3.dtd\">\n<web-app>\n <display-name>JRebelPortlet<\/display-name>\n<\/web-app><\/pre>\n
src\/main\/webapp\/WEB-INF\/portlet.xml<\/b><\/i><\/p>\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\n<portlet-app\n xmlns=\"http:\/\/java.sun.com\/xml\/ns\/portlet\/portlet-app_1_0.xsd\"\n version=\"1.0\"\n xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\"\n xsi:schemaLocation=\"http:\/\/java.sun.com\/xml\/ns\/portlet\/portlet-app_1_0.xsd\n http:\/\/java.sun.com\/xml\/ns\/portlet\/portlet-app_1_0.xsd\">\n\n <portlet>\n <description>Portlet with JRebel<\/description>\n <portlet-name>portlet-jrebel<\/portlet-name>\n <display-name>Portlet with JRebel<\/display-name>\n\n <portlet-class>org.exoplatform.jrebel.portlet.MyPortlet<\/portlet-class>\n\n <supports>\n <mime-type>text\/html<\/mime-type>\n <portlet-mode>VIEW<\/portlet-mode>\n <portlet-mode>HELP<\/portlet-mode>\n <\/supports>\n\n <supported-locale>en<\/supported-locale>\n \n <portlet-info>\n \t<title>Portlet with JRebel<\/title>\n \t<short-title>Portlet with JRebel<\/short-title>\n \t<keywords>JRebel<\/keywords>\n <\/portlet-info>\n <\/portlet>\n<\/portlet-app>\n<\/pre>\n
src\/main\/java\/org\/exoplatform\/jrebel\/portlet\/MyPortlet.java<\/b><\/i><\/p>\n
package org.exoplatform.jrebel.portlet;\n\nimport java.io.IOException;\n\nimport javax.portlet.GenericPortlet;\nimport javax.portlet.PortletConfig;\nimport javax.portlet.PortletException;\nimport javax.portlet.PortletRequestDispatcher;\nimport javax.portlet.RenderRequest;\nimport javax.portlet.RenderResponse;\n\npublic class MyPortlet extends GenericPortlet {\n\n private static final String VIEW_PAGE = \"\/view.jsp\";\n private static final String HELP_PAGE = \"\/help.jsp\";\n\n private PortletRequestDispatcher viewDispatcher;\n private PortletRequestDispatcher helpDispatcher;\n\n public void doView( RenderRequest request, RenderResponse response )\n throws PortletException, IOException {\n\n \tviewDispatcher.include( request, response );\n }\n\n protected void doHelp( RenderRequest request, RenderResponse response )\n throws PortletException, IOException {\n\n \thelpDispatcher.include( request, response );\n }\n\n public void init( PortletConfig config ) throws PortletException {\n super.init( config );\n viewDispatcher = config.getPortletContext().getRequestDispatcher( VIEW_PAGE );\n helpDispatcher = config.getPortletContext().getRequestDispatcher( HELP_PAGE );\n }\n\n public void destroy() {\n \tviewDispatcher = null;\n \thelpDispatcher = null;\n super.destroy();\n }\n}<\/pre>\npom.xml<\/b><\/i><\/p>\n
Add the portlet 2.0 dependency:<\/p>\n
<dependency>\n\t<groupId>javax.portlet<\/groupId>\n\t<artifactId>portlet-api<\/artifactId>\n\t<version>2.0<\/version>\n\t<scope>provided<\/scope>\n<\/dependency><\/pre>\n
src\/main\/webapp\/view.jsp<\/b><\/i><\/p>\n
Hello World!<\/pre>\n
src\/main\/webapp\/help.jsp<\/b><\/i><\/p>\n
Help?<\/pre>\n
You should now have the following project:
\n![\"Portlet](\"https:\/\/www.exoplatform.com\/blog\/wp-content\/uploads\/2012\/10\/portlet-sources-tree.png\" "\\"Portlet")
<\/a><\/p>\nIn order to deploy your project to a server, it must have the “Dynamic Web Module” facet. This can be done in the project’s properties, in the Project Facets<\/b> item. Once this is completed, check the Dynamic Web Module<\/b> item and select version 2.5 (and 1.6 for Java). Finally, declare the src\/main\/webapp<\/b> folder as part of the web application structure in the section Deployment Assembly<\/b> of the project’s properties:<\/p>\n
![\"Web](\"https:\/\/www.exoplatform.com\/blog\/wp-content\/uploads\/2012\/10\/web-deployment-assembly.png\" "\\"Web")
<\/a><\/p>\nOn this screen, you can declare all the resources you want to push to the web application on your server.<\/p>\n
Configure the Project to Use JRebel<\/h2>\n
The next step is to make JRebel aware of your project:<\/p>\n
- \n
- Right-click on the project > JRebel > Add JRebel Nature<\/li>\n
- Right-click on the project > JRebel > Generate rebel.xml<\/li>\n
- select the src\/main\/resources<\/b> folder<\/li>\n<\/ul>\n
Open the rebel.xml. You can see that JRebel will monitor all the folders pushed to your web application on the server, including the Java source files in target\/classes<\/b> and the files in src\/main\/webapp:<\/p>\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<application xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\" xmlns=\"http:\/\/www.zeroturnaround.com\" xsi:schemaLocation=\"http:\/\/www.zeroturnaround.com http:\/\/www.zeroturnaround.com\/alderaan\/rebel-2_0.xsd\">\n\n\t<classpath>\n\t\t<dir name=\"\/home\/thomas\/exoplatform\/dev\/projects\/jrebel.portlet\/target\/classes\">\n\t\t<\/dir>\n\t\t<dir name=\"\/home\/thomas\/exoplatform\/dev\/projects\/jrebel.portlet\/target\/test-classes\">\n\t\t<\/dir>\n\t<\/classpath>\n\n\t<web>\n\t\t<link target=\"\/\">\n\t\t\t<dir name=\"\/home\/thomas\/exoplatform\/dev\/projects\/jrebel.portlet\/WebContent\">\n\t\t\t<\/dir>\n\t\t<\/link>\n\t\t<link target=\"\/\">\n\t\t\t<dir name=\"\/home\/thomas\/exoplatform\/dev\/projects\/jrebel.portlet\/src\/main\/webapp\">\n\t\t\t<\/dir>\n\t\t<\/link>\n\t<\/web>\n\n<\/application><\/pre>\n
Configure the Server to Use JRebel<\/h2>\n
The server declared in Eclipse must also be configured to take use JRebel:<\/p>\n
- \n
- Go to the Servers<\/b> view in Eclipse<\/li>\n
- Double-click on your eXo Platform server<\/li>\n
- In the JRebel integration<\/b> section, check the Enable JRebel agent<\/b> checkbox<\/li>\n
- Be sure to disable the Automatic Publishing<\/b> in the Publishing section<\/b> (the Never publish automatically<\/b> must be checked)<\/li>\n<\/ul>\n
![\"Server](\"https:\/\/www.exoplatform.com\/blog\/wp-content\/uploads\/2012\/10\/server-configuration.png\" "\\"Server")
<\/a><\/p>\nPublish the Portlet in the Server<\/h2>\n
We are now ready to deploy your portlet:<\/p>\n
- \n
- Right-click on the server > Add and Remove…<\/li>\n
- Select the project and click Add<\/b><\/li>\n
- Click on Finish<\/b><\/li>\n
- Start the server<\/li>\n<\/ul>\n
After the server is started, you can add your portlet to a page and see the “Hello World !” text:
\n![\"Portlet](\"https:\/\/www.exoplatform.com\/blog\/wp-content\/uploads\/2012\/10\/portlet-helloworld.png\" "\\"Portlet")
<\/a><\/p>\nJRebel in Action!<\/h2>\n
To see JRebel in action, change the portlet class. For example, add a new request attribute to be used in the JSP:<\/p>\n
...\n public void doView( RenderRequest request, RenderResponse response )\n throws PortletException, IOException {\n\n \trequest.setAttribute(\"message\", \"Hello Again !\");\n \tviewDispatcher.include( request, response );\n }\n...<\/pre>\nand in the view.jsp:<\/p>\n
Your message : <%=request.getAttribute(\"message\")%><\/pre>\n
![\"Portlet](\"https:\/\/www.exoplatform.com\/blog\/wp-content\/uploads\/2012\/10\/portlet-helloworld-reloaded.png\" "\\"Portlet")
<\/a><\/p>\nYour changes have been applied without redeploying the webapp. You should only see this in the logs:<\/p>\n
[2012-10-11 13:56:01] JRebel: Reloading class 'org.exoplatform.jrebel.portlet.MyPortlet'.<\/pre>\n
Cool, isn’t it? \ud83d\ude09<\/p>\n
- Click on Finish<\/b><\/li>\n
- Go to the Servers<\/b> view in Eclipse<\/li>\n
- Select Maven > Maven Project<\/b><\/li>\n