Download the Imixs Sample Application

After you have successful installed the JBoss Server you can download the Imixs Sample Application for JBoss from the Imixs Download page

Adding MySQL support

JBoss supports a build in database. To use the MySQL Database you can add an additional configuration with the environment settings for MySQL. The following guide shows how to add a new MySQL datasource for the Imixs Sample Application:

First make the JDBC driver classes available to the JBoss Application Server. Copy the archive mysql-mysql-connector-java-5.1.5-bin.jar from the Connector/J distribution to the lib directory in the default server configuration (assuming that is the server configuration you are running).

JBOSS_INSTALL/server/imixs/lib

if you are running jboss with a custom configuration. (Otherwise copy the jar into the JBOSS_INSTALL/server/default/lib)

Then create a text file in the deploy directory called mysql-ds.xml with the following datasource descriptor:

<?xml version="1.0" encoding="UTF-8"?>
<datasources>
  <local-tx-datasource>
    <jndi-name>jdbc/workflow-db</jndi-name>
    <connection-url>jdbc:mysql://localhost:3306/jboss_test</connection-url>
    <driver-class>com.mysql.jdbc.Driver</driver-class>
    <user-name>root</user-name>
    <password>adminadmin</password>
    <exception-sorter-class-name>org.jboss.resource.adapter.jdbc.vendor.MySQLExceptionSorter</exception-sorter-class-name>
    <use-java-context>false</use-java-context>
    <exception-sorter-class-name>org.jboss.resource.adapter.jdbc.vendor.MySQLExceptionSorter</exception-sorter-class-name>
    <valid-connection-checker-class-name>org.jboss.resource.adapter.jdbc.vendor.MySQLValidConnectionChecker</valid-connection-checker-class-name>
    <metadata>
       <type-mapping>mySQL</type-mapping>
    </metadata>
  </local-tx-datasource>
</datasources>

This mysql setting file assumes that you have created a MySQL Database schema called 'imixs_test' The datasource is pointing at the database called imixs_test provided by default with MySQL 5.x. Remember to update the connection url attributes as well as the combo username/password to match your environment setup.

Install EclipseLink

Most of the EJB/JPA examples for Imixs JEE components expect the EclipseLink JPA Provider. To add this provider to your JBoss server download EclipseLink from the eclipse download site

Unzip the libraries and copy form the jlib folder the eclipselink.jar into your JBoss lib

JBOSS_INSTALL/server/imixs/lib

if you are running jboss with a custom configuration. (Otherwise copy the jar into the JBOSS_INSTALL/server/default/lib)

Read more about using MySQL with JBoss on the EclipseLink Migration guide.

Adding Jersey Support

The Imixs REST Service API which is used by the Imixs Sample Application is build on Jersey which is not part of JBoss 5.1.0.GA. But you can add the jersey-server to your jboss server configuration when you copy the following jersey jars into the lib folder

JBOSS_INSTALL/server/imixs/lib

if you are running jboss with a custom configuration. (Otherwise copy the jar into the JBOSS_INSTALL/server/default/lib)

• asm-3.1.jar
• jersey-core-1.3.jar
• jersey-server-1.3.jar
• jsr311-api-1.1.1.jar

You will find download links on the Jersey project site. See also the Imixs Rest Service deployment guide for additional informations about Jersey.

Adding a Security Policy for the realm 'imixsrealm'

The Imixs Sample Application expects a relam named 'imixsrealm'. You can add the Security Policy for this realm to your JBOSS_INSTALL/server/imixs/conf/login-config.xml

.....
    <application-policy name = "imixsrealm">  
           <authentication>  
              <login-module code="org.jboss.security.auth.spi.UsersRolesLoginModule"  
                 flag = "required">  
               <module-option name="usersProperties">users.properties</module-option>  
               <module-option name="rolesProperties">roles.properties</module-option>  
              </login-module>  
           </authentication>  
    </application-policy>   
...

Place this additional application-policy just before the application-policy named "other"

Next create two new files named 'users.properties' and 'roless.properties' into the /conf/ folder. In these files you can define the usersnames and roles.

For testing use the following Usernames and Roles

users.properties

Manfred=123
Eddy=123
Anna=123
Ronny=123
Norbert=123

roless.properties

Manfred=IMIXS-WORKFLOW-Manager
Eddy=IMIXS-WORKFLOW-Editor
Anna=IMIXS-WORKFLOW-Author
Ronny=IMIXS-WORKFLOW-Reader

It is also possible to configure other security bindings as the file based described here. Only the realm name and user roles should match to "imixsrealm" and the role names defined here.

Deploy the Imixs Sample Application

Now install the EAR file of the Imixs Sample Application by the following steps:

1. Be sure, that your database server is up and running.

2. Be sure, that the server, which you will deploy the application on, is alive.

3. Now you can start the Admin Console in the browser. >http://[ name of the server ]:8080/admin-console/

4. Choose Applications -> Enterprise Application (EAR)s and click the button "add new resource" in the main frame

5. browse to where the ear file of the Imixs Sample Application is stored

7. press the button "continue"

Next...