Database

The first step is to configure the database. In order to do that, you will need to edit the devportal.properties file that is under WEB-INF/config, and set the values to point to your database

• db.driver: This must indicate the name of the driver class that your database uses

• db.url: This must contain a jdbc URL to your database.

• db.username: Username used to connect to the database

• db.password: Password used to connect to the database

• db.dialect: Hibernate dialect for your database. You can find the list of dialect in the hibernate documentation website

After you've configured all the database settings, you will need to add the appropriate jar files for your jdbc drivers to WEB-INF/lib

Security

By default DevPortal is configured to leverage the security infrastructure provided by the servlet container. Please refer to your servlet container's documentation on how to set it up.

As indicated in the WEB-INF/web.xml file, mappings for the role 'admin' and 'user' must be created.

Introduction

All source template files that end with '.ftl' are processed with the FreeMarker. This means that by inserting special annotations in the file, it is possible to insert data from the project, like the project name, or code.

When the file is processed, a number of data model attributes are introduced in the template, as described in the freemarker documentation .

Data Model Attributes

• module: This model attributes corresponds to the java class 'com.jguild.devportal.project.Module', which contains all information related to the module the template is being created for. This is very commonly used to retrieve the project's full name or code, using ${module.name} or ${module.code}, respectively. Please note that in the current version, the concept of modules is hidden, and every project has a single module with the same properties as the project.

Example freemarker template file: Ant build script - build.ftl

<project name="${module.parent.name}: ${module.name}" default="classes">
    <property name="build.dir" value="_build/"/>
    <property name="deps.dir" value="resources/lib"/>
    <property name="version" value="snapshot"/>

    <path id="classpath.all">
        <fileset dir="${r"${dest.dir}"}" includes="**/*.jar"/>
    </path>

    <target name="clean">
        <delete dir='${r"${build.dir}"}'/>
    </target>

    <target name="classes">
        <mkdir dir="${r"${build.dir}"}/classes"/>
        <javac destdir="${r"${build.dir}"}/classes" srcdir="src/java" classpathref="classpath.all"/>
    </target>

    <target name="jar">
        <jar destfile="${r"${build.dir}"}/${module.id}-${r"${version}"}.jar"/>
    </target>
</project>

In this example, the name of the project followed by the module's name is inserted as the ant project name attribute, using${module.parent.name}: ${module.name}.

The module's id is also inserted in the jar target, so that the created jar file has the same name, using${module.id}.

Finally, please note that ant's properties clash with FreeMarker, so rather that using ${build.dir} to access the build.dir ant property, we've replaced it with ${r"${build.dir}"}, which is then in turn transformed back into ${build.dir} After template processing.