Candidates to move:

Architecture or development section:  directory structure and packaging of our jars.

Installation Section:  Server configuration details.

This design document describes the proposed packaging for the 2.0 version. This includes significant refactoring of the API due to the scattered in inappropriate places in the 1.x design due to the addition of additional features over time.

The idea is to prepare the framework to become a server implementation which manages session and authentication. This is the reason for the com.openptk.server package structure and the new engine and session packages. Also at the end of the document, the package structure for the consumer tier is proposed to change to the org.openptk.consumer package.

SVN directory Structure

trunk/openptk/

Server Configuration

The configuration will include a new section for server properties. The following is a list of some the the new properties:

Other server configuraiton variables are expected. These new properties will be containd in the openptk.xml file in a server section. The xsd and configuration process will be extended to support reading these values.

There are 3 current server configuration properties.

          <Global>
             <Properties>
                <Property name="auth.token.httpheader"              value="openptkid" />              
                <Property name="http.session.cookie.uniqueid"            value="OPENPTKSESSIONID" />
                <Property name="http.session.cookie.httponly"            value="true" />           
                <Property name="engine.session.ttl"                        value="1800000" />
                <Property name="engine.session.cache.ttl"                  value="120000" />
                <Property name="search.results.quantity"                   value="10" />
                <Property name="search.attribute.default"           value="firstname" />
             </Properties>
          </Global>

1. Cookie Name
   Resource.java
   COOKIE_SESSIONID
   Status: Resource.java is getting this from the context
2. TTL
   CacheIF had a private TTL variable
3. Quantity:
   SubjectRepresentation - this currently includes a private DEFAULT_PAGE_QUANTITY variable.
   -only used in this class
   Status: TBD after design discussion

Design agreed to is that the Engine will be modified to subclass Component.java and the getters and setters for Properties on the Engine will store the server configuration properties

For each server property added to the openptk.xml must also be added to the EngineIF

   // The following Strings are the names of the server configuration properties in the openptk.xml
   public static final String AUTH_TOKEN_HTTPHEADER =  "auth.token.httpheader";
   public static final String HTTP_SESSION_COOKIE_UNIQUEID =  "http.session.cookie.uniqueid";
   public static final String HTTP_SESSION_COOKIE_HTTPONLY =  "http.session.cookie.httponly";
   public static final String ENGINE_SESSION_TTL =  "engine.session.ttl";
   public static final String ENGINE_SESSION_CACHE_TTL =  "engine.session.cache.ttl";   
   public static final String SEARCH_RESULTS_QUANTITY =  "search.results.quantity";    
   public static final String SEARCH_ATTRIBUTE_DEFAULT =  "search.attribute.default"; 

Server Context Root of the web app

The default server context root used will be /openptk. It is expected that this value can change during a deployment. This change of the context root will impact several things. This is a list of the expected configuration changes that will need to be documented for the deployer to change.

WAR file configuration

The table below defines what jar files are needed for a particular J2EE Web Container.

Legend: