Logo of 52°North
Home Communities Security Application Developer Guide

52°North Application Developer Guide

out-of-date
The contents of this page relates to an old version of the API. Please contact mailto:security@52north.org if you need more recent instructions.

General

At the moment, development of a 52°North applications means to manage two software modules:

  1. 52n-security-api (2.0.x), the central 52n security library which -- besides others -- contains all Java classes that make up a WAS, WSS, and WSC.Web
  2. a 52n-security-webapp-*, which contains all files needed to compile a complete application and is dependent on the 52n-security-api submodule 52n-security-service.

Currently the security API and applications are developed using the Java API 1.4. So please make sure that you do not use any features of above versions (API features and language constructs) and your IDE (including Maven) builds the code with 1.4 compatibility turned on.

Typical Build Procedure in a Nutshell

  1. Check out the complete 52n-security-api including its submodules
  2. Check out an application (subdirectory of 52n-security-apps), e.g. 52n-secuirty-was-webapp; you need not to check out all apps.
  3. Change and build API code as required in submodules (-core, -service, -facade)
  4. Rebuild and test the 52°North application
  5. Repeat steps 3 and 4 until you get the desired result

Build from Scratch

Check out Sources

First check out the 52n-security-api as described here (API version 2.0.*)

Then check out the 52N application you intend to build:

Set up Development Environment

  • First, make sure you have Maven installed ;-) !
  • Some applications may require to define and modify filter files to adjust the configuration of the application to the local environment. Check out the application's documentation to get more information.
  • Define a profile that links to the 52N relase server, so you are able to download the "mother POM" of all 52N projects. Look here to find out how to do this

Modify, (Re-)Build and Test the Application

  • Change the code in the 52n-security-api submodules (-client, -core, -service, -facade) as needed. If you finished a development step, call mvn install in the 52n-security-api directory (safe method) or call mvn install in one of the submodules of the API to only create the artifact for client or core or service or facade (unsafe, you might forget to install changes of one of the other modules)
  • Build the application with mvn package against the 52n-security-api version you just installed in your repository, e.g. 2.0
  • Deploy and test the application depending on the nature of the application, e.g. for web applications, create a Tomcat context that points to [your appsdir]/target/###-webapp directory.