{"id":8075,"date":"2014-12-11T05:55:04","date_gmt":"2014-12-11T13:55:04","guid":{"rendered":"http:\/\/localhost\/exoblog\/?p=8075"},"modified":"2023-06-05T16:49:46","modified_gmt":"2023-06-05T14:49:46","slug":"developing-juzu-portlets-step-5-saving-secrets-in-the-jcr","status":"publish","type":"post","link":"https:\/\/www.exoplatform.com\/blog\/developing-juzu-portlets-step-5-saving-secrets-in-the-jcr\/","title":{"rendered":"Developing Juzu portlets \u2013 Step 5: Saving Secrets in the JCR"},"content":{"rendered":"

\"05-Juzu-tutorial-series\"<\/a><\/p>\n

Previous steps:
\n– Learn how to develop great Juzu portlets for eXo Platform!<\/a>
\n– Step 2: viewing and posting secrets<\/a>
\n– Step 3: Building a sexy secret wall<\/a>
\n– Step 4: adding Likes and Comments for Secret<\/a><\/em><\/p>\n

Thanks to the previous steps<\/a>, we have a JuZcret application<\/strong> with some nice features<\/strong>. However, we\u2019re saving our secret in memory, which is good for testing but not for production. It\u2019s time to learn how to save our secret<\/strong> in eXo JCR<\/strong>. During this step, we will implement a new secret service to save all secrets in JCR instead of memory.
\n<\/p>\n

eXo services and eXo JCR storage<\/h2>\n

JuZcret JCR NodeType declaration<\/h3>\n

First, we will create a JCR node type definition<\/strong>.<\/p>\n

Note: We will not focus on the eXo JCR API in this tutorial but on how to leverage JCR support from eXo Platform<\/strong> to develop Juzu Portlet. We will not explain in detail the JCR node type definition below. If you need more information to understand the code below, please take a look at the eXo JCR website<\/a>.<\/em><\/p>\n

We will define the exo:secret and exo:secretComment node types. Their properties reflect our JuZcret domain classes<\/strong>: Secret and Comment.<\/p>\n

Create a new file secret-nodetypes.xml<\/span> in src\/main\/webapp\/WEB-INF\/conf<\/span>:<\/p>\n

<nodeTypes xmlns:nt=\"https:\/\/www.jcp.org\/jcr\/nt\/1.0\" xmlns:mix=\"https:\/\/www.jcp.org\/jcr\/mix\/1.0\" xmlns:jcr=\"https:\/\/www.jcp.org\/jcr\/1.0\">\n\t<nodeType name=\"exo:secret\" isMixin=\"false\" hasOrderableChildNodes=\"false\" primaryItemName=\"\">\n\t\t<supertypes>\n\t\t\t<supertype>nt:base<\/supertype>\n\t\t<\/supertypes>\n\t\t<propertyDefinitions>\n\t\t\t<propertyDefinition name=\"exo:id\" requiredType=\"String\" autoCreated=\"false\" mandatory=\"true\" onParentVersion=\"COPY\" protected=\"false\" multiple=\"false\">\n\t\t\t\t<valueConstraints\/>\n\t\t\t<\/propertyDefinition>\n\t\t\t<propertyDefinition name=\"exo:message\" requiredType=\"String\" autoCreated=\"false\" mandatory=\"true\" onParentVersion=\"COPY\" protected=\"false\" multiple=\"false\">\n\t\t\t\t<valueConstraints\/>\n\t\t\t<\/propertyDefinition>\n\t\t\t<propertyDefinition name=\"exo:imageURL\" requiredType=\"String\" autoCreated=\"false\" mandatory=\"true\" onParentVersion=\"COPY\" protected=\"false\" multiple=\"false\">\n\t\t\t\t<valueConstraints\/>\n\t\t\t<\/propertyDefinition>\n\t\t\t<propertyDefinition name=\"exo:likes\" requiredType=\"String\" autoCreated=\"false\" mandatory=\"false\" onParentVersion=\"COPY\" protected=\"false\" multiple=\"true\">\n\t\t\t\t<valueConstraints\/>\n\t\t\t<\/propertyDefinition>\n\t\t\t<propertyDefinition name=\"exo:createdDate\" requiredType=\"Date\" autoCreated=\"false\" mandatory=\"true\" onParentVersion=\"COPY\" protected=\"false\" multiple=\"false\">\n\t\t\t\t<valueConstraints\/>\n\t\t\t<\/propertyDefinition>\n\t\t<\/propertyDefinitions>\n\t\t<childNodeDefinitions>\n\t\t\t<childNodeDefinition name=\"*\" defaultPrimaryType=\"\" autoCreated=\"false\" mandatory=\"false\" onParentVersion=\"COPY\" protected=\"false\" sameNameSiblings=\"false\">\n\t\t\t\t<requiredPrimaryTypes>\n\t\t\t\t\t<requiredPrimaryType>exo:secretComment<\/requiredPrimaryType>\n\t\t\t\t<\/requiredPrimaryTypes>\n\t\t\t<\/childNodeDefinition>\n\t\t<\/childNodeDefinitions>\n\t<\/nodeType>\n\n\t<nodeType  name=\"exo:secretComment\" isMixin=\"false\" hasOrderableChildNodes=\"false\" primaryItemName=\"\">\n\t\t<supertypes>\n\t\t\t<supertype>nt:base<\/supertype>\n\t\t<\/supertypes>\n\t\t<propertyDefinitions>\n\t\t\t<propertyDefinition name=\"exo:id\" requiredType=\"String\" autoCreated=\"false\" mandatory=\"true\" onParentVersion=\"COPY\" protected=\"false\" multiple=\"false\">\n\t\t\t\t<valueConstraints\/>\n\t\t\t<\/propertyDefinition>\n\t\t\t<propertyDefinition name=\"exo:userId\" requiredType=\"String\" autoCreated=\"false\" mandatory=\"true\" onParentVersion=\"COPY\" protected=\"false\" multiple=\"false\">\n\t\t\t\t<valueConstraints\/>\n\t\t\t<\/propertyDefinition>\n\t\t\t<propertyDefinition name=\"exo:content\" requiredType=\"String\" autoCreated=\"false\" mandatory=\"true\" onParentVersion=\"COPY\" protected=\"false\" multiple=\"false\">\n\t\t\t\t<valueConstraints\/>\n\t\t\t<\/propertyDefinition>\n\t\t\t<propertyDefinition name=\"exo:createdDate\" requiredType=\"Date\" autoCreated=\"false\" mandatory=\"true\" onParentVersion=\"COPY\" protected=\"false\" multiple=\"false\">\n\t\t\t\t<valueConstraints\/>\n\t\t\t<\/propertyDefinition>\n\t\t<\/propertyDefinitions>\n\t<\/nodeType>\n<\/nodeTypes><\/pre>\n
When secret-nodetypes.xml<\/span> file is ready, we need to register it to the eXo JCR service<\/strong>. Add this new eXo container configuration.xml<\/span> file in \/src\/main\/webapp\/WEB-INF\/conf\/<\/span>:<\/p>\n
<configuration\n\txmlns:xsi=\"https:\/\/www.w3.org\/2001\/XMLSchema-instance\"\n\txsi:schemaLocation=\"https:\/\/www.exoplatform.org\/xml\/ns\/kernel_1_2.xsd https:\/\/www.exoplatform.org\/xml\/ns\/kernel_1_2.xsd\"\n\txmlns=\"https:\/\/www.exoplatform.org\/xml\/ns\/kernel_1_2.xsd\">\n\n\t<external-component-plugins>\n\t\t<target-component>org.exoplatform.services.jcr.RepositoryService<\/target-component>\n\t\t<component-plugin>\n\t\t\t<name>add.nodeType<\/name>\n\t\t\t<set-method>addPlugin<\/set-method>\n\t\t\t<type>org.exoplatform.services.jcr.impl.AddNodeTypePlugin<\/type>\n\t\t\t<init-params>\n\t\t\t\t<values-param>\n\t\t\t\t\t<name>autoCreatedInNewRepository<\/name>\n\t\t\t\t\t<description>Node types configuration file<\/description>\n\t\t\t\t\t<value>war:\/conf\/secret-nodetypes.xml<\/value>\n\t\t\t\t<\/values-param>\n\t\t\t<\/init-params>\n\t\t<\/component-plugin>\n\t<\/external-component-plugins>\n<\/configuration>\n<\/pre>\n
This configuration registers a node type plugin<\/strong> with eXo RepositoryService, which will parse our node type at war: \/conf\/secret-nodetypes.xml<\/span> path.<\/p>\n
The only thing missing now is to make sure that eXo Platform will scan and process<\/strong> our configuration.xml<\/span> file in tutorial-juzcret webapp<\/strong> when it initializes the eXo container. This task is not specific to Juzu; it\u2019s about configuring a webapp as an eXo Platform extension<\/strong> (for more details about extensions, please look at the eXo documentation).<\/p>\n
First, we need to modify the web.xml<\/span> file:<\/p>\n
<?xml version=\"1.0\" encoding=\"ISO-8859-1\" ?>\n<web-app xmlns=\"https:\/\/java.sun.com\/xml\/ns\/javaee\"\n\txmlns:xsi=\"https:\/\/www.w3.org\/2001\/XMLSchema-instance\"\n\txsi:schemaLocation=\"https:\/\/java.sun.com\/xml\/ns\/javaee https:\/\/java.sun.com\/xml\/ns\/javaee\/web-app_3_0.xsd\"\n\tversion=\"3.0\">\n\n\t<display-name>tutorial-juzcret<\/display-name>\n\n\t<!-- Run mode: prod, dev or live -->\n\t<context-param>\n\t\t<param-name>juzu.run_mode<\/param-name>\n\t\t<param-value>${juzu.run_mode:dev}<\/param-value>\n\t<\/context-param>\n\n\t<!-- Injection container to use: guice, spring, cdi or weld -->\n\t<context-param>\n\t\t<param-name>juzu.inject<\/param-name>\n\t\t<param-value>guice<\/param-value>\n\t<\/context-param>\n\n\t<listener>\n\t\t<listener-class>org.exoplatform.container.web.PortalContainerConfigOwner<\/listener-class>\n\t<\/listener>\n<\/web-app><\/pre>\n
eXo container<\/strong> will need to know which webapp container contains its configuration files. By adding thePortalContainerConfigOwner, a servlet context listener<\/strong>, we\u2019ve registered the JuZcret webapp context to the eXo container to scan and process the xml configuration file. Notice that we also need to declare the <display-name><\/span> tag. The eXo container uses that information to map the registered webapp<\/strong>.<\/p>\n
Finally, we configure the JuZcret as a dependency of the eXo container<\/strong>. Even though we\u2019ve registered the webapp context, we still need to tell the eXo container that the JuZcret webapp is a portal container definition dependency<\/strong>. There are two places to add the configuration:<\/p>\n