Documentation 3.0 Beta
Using the Server SDK
Before you can begin to develop an app scope with the Akula Server SDK, you must first configure your development environment.
This document describes how to configure your Akula Server development environment, and contains the following sections:
Server SDK development environment requirements
To develop apps for the Akula Server, your development environment must meet the following minimum system requirements:
Note: Additional Operating Systems and versions should work as long as the appropriate Java JRE or JDK is available. For example, most recent variations of Linux including Red Hat Enterprise Linux 6.3, though not tested, should run Akula properly. Akula was successfully run in the following environments: Mac OS X 10.8.x - 10.10.x, Ubuntu 12.x, and Windows 7 SP1.
|JEE Server or Servlet Container|
Note: This is the internal database used by the Akula Server to store configuration and run time information used by the server. For more information, see Specify the Database for the Akula Server.
|RAM dedicated to the JVM||2 GB|
|PermGen size||500 MB|
|Disk space||500 MB|
Configuring the Server SDK development environment
To configure the Server SDK development environment, add the Akula API JAR file to the library path of your project.
To configure the Server SDK development environment:
- Browse to the location where you installed Akula. If you have not done so already, download the Akula server from the Downloads page (you must log in to access this page).
- Locate the /server-sdk/lib/akula-api-x.y.z.jar file, where x.y.z is the version number of the Akula release.
- Add the akula-api-x.y.z.jar file to your project.
Sample app scopes
Akula ships with sample apps, including AKZ files for sample app scopes. For more information, see Samples.