readme.adoc

OptaConf — the optimal conference planner

Project setup for IntelliJ IDEA

For IntelliJ IDEA Ultimate Edition:

1. Open the pom.xml as a new project in IntelliJ

2. Download and unzip WildFly 9.0.1.Final

3. In IntelliJ, add a JBoss app server run configuration for that WildFly installation and a deployment for the exploded war

4. In IntelliJ, go to Project structure, menu item Artifacts and suffix exploded war’s output directory with -exploded.war

5. Run the WildFly run configuration

If you have IntelliJ IDEA Community Edition:

1. Run wildfly-9.0.1.Final/bin/standalone.sh with Java 8+

2. Run mvn wildfly:deploy from within the optaconf-webapp directory

Project setup for Eclipse

1. Install JBoss Tools

2. In Eclipse, Import the project as a Maven project

3. In Eclipse, Use File > New Server, choose WildFly 9.x and you can use "Download and install" to get WildFly 9

4. In Eclipse, Drag the webapp project to the WildFly server

5. In Eclipse, Run WildFly

Rest URLs

Import a schedule:

• A Devoxx schedule: [POST] http://localhost:8080/optaconf-webapp/rest/conference/import/devoxx

General lists:

• All conferences: [GET] http://localhost:8080/optaconf-webapp/rest/conference/

• All days: [GET] http://localhost:8080/optaconf-webapp/rest/<conference-id>/day

• All timeslots: [GET] http://localhost:8080/optaconf-webapp/rest/<conference-id>/timeslot

• All rooms: [GET] http://localhost:8080/optaconf-webapp/rest/<conference-id>/room

• All tracks: [GET] http://localhost:8080/optaconf-webapp/rest/<conference-id>/track

• All speakers: [GET] http://localhost:8080/optaconf-webapp/rest/<conference-id>/speaker

• All talks: [GET] http://localhost:8080/optaconf-webapp/rest/<conference-id>/talk

GUI map:

• Talk map per day per timeslot per room: [GET] http://localhost:8080/optaconf-webapp/#/schedule/<conference-id>;

Filtered lists:

• All timeslots of 1 day: [GET] http://localhost:8080/optaconf-webapp/rest/<conference-id>/day/wednesday/timeslot

• All talk exclusions of 1 talk: [GET] http://localhost:8080/optaconf-webapp/rest/<conference-id>/talk/1/exclusion

• All talks on 1 day grouped by timeslot and room: [GET] http://localhost:8080/optaconf-webapp/rest/<conference-id>/day/wednesday/talk

Solve a conference schedule

• Solve the schedule: [PUT] http://localhost:8080/optaconf-webapp/rest/conference/<conference-id>/solve

• Is solving? [GET] http://localhost:8080/optaconf-webapp/rest/conference/<conference-id>/isSolving

• Terminate solving: [PUT] http://localhost:8080/optaconf-webapp/rest/conference/<conference-id>/terminateSolving

Development methodology

• Code style: KIE (Drools, OptaPlanner, jBPM) code style