Preparing a Java project for Soiree

In this Lesson

You will learn how to create a Java project that can be used for building Soiree Solutions.

Soiree has two environments

  • A product development environment where solutions are created.
    This lesson describes setting up the product development environment.
  • A server environment where solutions are deployed.
    The server environment is described in a later lesson.


Before we set up a Soiree project let’s view the silhouette of a Soiree project.

A Soiree project is…

  • A standard Eclipse Java project with some Soiree bits sifted into it.
  • Used to create Soiree Solutions (A Solution is a Java application with benefits).
  • A really fun way to build some great products for your customers.

Soiree adds the following bits to your Eclipse Java projects

  • Additional Files
    1. Soiree Library Files
      These are JAR files that contain the core Soiree Java classes common to all Soiree solutions.
      I wish these jars had something edible in them. These jars only have .class files and some Java source.
    2. Soiree Items
      These are files that define some aspect of a Soiree solution. They allow you to simply define what you want instead of having to actually do the work yourself. There are 16 of these little minions ready to help you. You will meet each of them as you progress though the lessons.
    3. Notice
      All item files reside in the same source folder and package structure as your .java files.
  • Soiree Item Editors
    Soiree provides a suite of wizards and editors that are used to create and modify the Soiree Item files. Using these beauties is certainly easier than learning a descriptor syntax. Java is the only syntax you need with Soiree.
  • Soiree Item Builder
    The builder does for Soiree Items what a Java compiler does for .java files. It creates a runtime version of any Soiree item files needed at deployment time. The Soiree Item Builder is installed as an Eclipse builder which runs each time a Soiree Item is created or modified and turns Soiree item files into resource files. It places the resource files in a folder named sxres (similar to the bin folder in which Java .class files are placed).
  • Soiree Code Generators
    Some of the item editors are able to turn a Soiree Item definition into Java code. As your design changes these generators can rebuild your Java classes while retaining any customization that you added to them. Three cheers for Java inheritance! (and for not having to code everything by hand)
  • Soiree Execution Environment
    The Soiree plugin provides the ability to run your Solutions without leaving Eclipse. You can build the solution, start the server, and run a desktop client that connects to the server – all without leaving Eclipse. This makes it super easy to test and debug the solutions that you create.
  • Soiree Server Console
    The server console provides a performance monitor and user provisioning capabilities for any running server.
  • Welcome to the Soiree Framework – where it all comes together.

    Create a Java Project

    1. Create a standard Java project by selecting File, New, Project…

    2. Select Java Project

    3. Enter a project name of Party and select Finish

    4. If asked, confirm the use of the Java perspective

    5. Configure the Package Presentation Style used by the Package Explorer.

      Changing the presentation style from Flat to Hierarchical will make it easier to navigate the packages.

    Add the Soiree bits to the project

    1. Right click on the project name in the Package Explorer and select Soiree Project Configuration

    2. Add the 3 required options to the project.

    3. Your project should now look like this. Notice the files that were installed by each of the configuration options.
      The Soiree Items installed by the Soiree Configurator are predefined items which are part of the core services of Soiree. You will use these items and create additional ones as the lessons progress.

    4. Check this out
      Soiree Wizards and Editors are used to create item files – all of which have an extension beginning with .sx. The Item Builder converts the item files into resource files – all of which have an extension that begins with .res.
      Are you using source control such as CVS, SVN or Git? The sxres folder should be excluded from any source code repository you may be using. There is no need to store them because they are created by the Item Builder. The folder is marked as derived so it should be automatically excluded by your source control plugin.