Stardust/Knowledge Base/API/ExamplesofAPIUsage/Initialization

API Initialization

Purpose

Working with Stardust via the Java API always means working with Stardust's services. The commonly used ones areas

• QueryService: It is used for any kind of information retrieval about processes, activites and their instances.
• UserService: It is used for any kind of user-related operations like creating new user, granting roles and so on.
• WorkflowService: Is is used for executing the process instances (starting, stopping, resuming and so on).
• DocumentManagementService: Is is used for accessing a JCR repository.
  

But there are also others like the DocumentService for special purposes. All these services are used in the same way: They need to be initialized in order to work with them.

Solution

Working with the services is quite easy. Getting the service instances itself requires some setup. The initialization itself is done for you by Stardust.

Requirements

Your client's carnot.properties has to be set up correctly. If you use the Stardust in EJB-mode you need another carnot.properties as if stardust is deployed in Spring mode. But this is another carnot.properties as your server (Stardust itself) uses.

Client vs. Server
IPP (exactly the carnot-engine) is the server. It (among others) creates the service objects we will use later. Its carnot.properties will be deployed in the Application Server/Container below WEB-INF/classes (or simmilar).
The client (the program you will write which will use the IPP services) needs another carnot.properties. It is required to be on the classpath so it can be found during runtime.