Using Vaadin In IBM Domino

Select *Help > Eclipse Marketplace….*

Search for "Vaadin" amd install theVaadin Plugin for Eclipse

The options to install will include the Vaadin Designer, so leave all selected, confirm and accept the license. You will be prompted to restart Eclipse to complete the install.

In Eclipse, select File > New > Plug-in Project and give it a name. As an OSGi plugin, tell it to run with the OSGi framework “Equinox”.

Until the next release of Domino is out, the execution environment needs to be changed to Java 1.6. Then finish – the Eclipse perspective used for development is not significant at this stage.

The MANIFEST.MF will be opened and some additional configuration is required. The plugin should be set as a singleton on the Overview tab.

On the Dependencies tab some plugins and packages need loading for OSGi and Domino, as below.

Back on the Overview tab, click the Extension Points link and confirm you want to display the Extension and Extension Point pages.

On the Extensions tab, click Add… and choose com.ibm.pvc.webcontainer.application.

Set the contextRoot to “/helloVaadin”.

Right-click on com.ibm.pvc.webcontainer.application and select New > contentLocation. Set it to “WebContent”. These two steps can be done by manually typing the relevant XML onto the plugin.xml tab and I would recommend you loop at what the resulting XML is.

Next download the Vaadin jar files that will be needed from the Vaadin website. The README.txt file outlines the steps required to add it to the project, but are repeated below.

Right-click the project and select New > Folder and call it WebContent/WEB-INF/lib.

Copy all jars to WebContent/WEB-INF/lib. Copy all jars in the lib folder to WebContent/WEB-INF/lib.

In the MANIFEST.MF, on the Runtime tab in the Classpath section, click Add… and add all the jar files added to WebContent/WEB-INF/lib. You must select the jars, not the folder. Then remember to move the “.” entry to the top of the list.

Right-click the WebContent/WEB-INF folder and select New > File. Call it web.xml.

Paste in the code below:

<?xml version="1.0" encoding="ISO-8859-1"?>
<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
<display-name>HelloVaadin</display-name>
   <welcome-file-list>
     <welcome-file>index.html</welcome-file>
     <welcome-file>index.htm</welcome-file>
     <welcome-file>index.jsp</welcome-file>
     <welcome-file>default.html</welcome-file>
     <welcome-file>default.htm</welcome-file>
     <welcome-file>default.jsp</welcome-file>
   </welcome-file-list>
   <context-param>
       <description>Vaadin production mode</description>
       <param-name>productionMode</param-name>
       <param-value>false</param-value>
   </context-param>

   <servlet>
       <servlet-name>HelloVaadinServlet</servlet-name>
       <servlet-class>com.vaadin.server.VaadinServlet</servlet-class>
       <init-param>
           <param-name>UI</param-name>
           <param-value>com.paulwithers.hellovaadin.HelloVaadinUI</param-value>
       </init-param>
   </servlet>

   <servlet-mapping>
       <servlet-name>HelloVaadinServlet</servlet-name>
       <url-pattern>/*</url-pattern>
   </servlet-mapping>
</web-app>

Right-click com.paulwithers.hellovaadin and select New > Vaadin Design. You will need an evaluation or full license for Vaadin Designer. To get the trial license, log into the vaadin.com website and go to https://vaadin.com/designer#license-modal.

Call the design page “WelcomeDesign” and use the Vertical Layout template. Finish and confirm to switch to the Vaadin perspective.

Drag and drop a new Label onto the page (components are displayed alphabetically). In the Properties view set the name to “label1”. Click the ellipsis button next to StyleName. Select “LABEL_H2” and click Add →, then OK. Change ComponentAlignment to “TOP_CENTER”. Save and close.

Switch back to the Plug-in Development perspective. This is better suited to plugin development. Note the “WelcomeDesign.html” and “WelcomeDesign.java” files. Review WelcomeDesign.java.

Right-click on com.paulwithers.hellovaadin and select New > Class. Call it WelcomeView and set the superclass as WelcomeDesign.

Add the following code to the class to extend the auto-generated class and to compute the value of label1.

import com.ibm.domino.osgi.core.context.ContextInfo;

public class WelcomeView extends WelcomeDesign {
    private static final long serialVersionUID = 1L;

    public WelcomeView() {
        super();
        try {
            label1.setValue("Welcome " +
ContextInfo.getUserSession().getEffectiveUserName());
        } catch (final Exception e) {
            // TODO: handle exception
        }
    }
}

You may get an error that the method Session.getEffectiveUserName() is not API. That can be fixed by amending the Java compiler settings, by changing the setting for forbidden reference to “Warning”.

Right-click on src/com.paulwithers.hellovaadin and select New > Class. Class it “HelloVaadinUI” and set the superclass as “com.vaadin.ui.UI”.

Add the following code to the class:

import com.vaadin.server.VaadinRequest;
import com.vaadin.ui.UI;

public class HelloVaadinUI extends UI {
    @Override
    protected void init(VaadinRequest request) {
        final WelcomeView welcome = new WelcomeView();
        setContent(welcome);
    }
}

On the Build tab ensure META-INF, WebContent, plugin.xml, src are all ticked for Binary Build.

On the Overview tab, launch the Organize Manifests Wizard and complete.

Select File > New > Feature Project. Call it com.paulwithers.helloVaadinFeature.

Click Next and initialize from the com.paulwithers.helloVaadin plugin.

Select File > New > Update Site Project. Call it com.paulwithers.helloVaadinUpdate and click Finish. Click Add Feature… and select com.paulwithers.helloVaadinFeature. Click Build All.

Right-click com.paulwithers.helloVaadinUpdate and click Export…. Choose General > File System. You only need to select the site.xml. Export to an appropriate location.

In an Update Site database on the relevant server, import the update site by pointing to the site.xml.

If you browse to the “helloVaadin” URL on the server (corresponding to the contextRoot in the plugin.xml), you should now see “Hello Anonymous” message.