Vitrall Collaborative Server

General Information

Vitrall Collaborative Server is a set of Java Web Applications (mainly Java Servlets based) responsible for:

  • generation of QRCode images,
  • authorization,
  • authentication,
  • collaboration.

Although this component is in an early design stage, some parts are being implemented at the moment (e.g. QRCode generator).

At the moment Vitrall Collaborative Server is foreseen to consist of 2 web applications:

  • QRCode Generator Application (qrcode) responsible for generation of QRCode images,
  • Vitrall Collaborative Server Core (vcsc) responsible for authentication, authorization and collaboration.

Component Roadmap

  1. Vitrall Collaborative Server 0.1 Release

Installation

QRCode Generator Application

QRCode Generator Application is a standard Java Web Application which can be installed from a WAR file (Web Application Archive). For more information on installing a web application from WAR archive please consult your servlet container documentation.

The WAR file needs to be build from sources available in Repository.

Build process is automated with  Apache Ant. The following Ant targets are available:

  • help (default) - displays list of available targets,
  • compile - compiles java classes (outputs to the build directory),
  • war - generates Web Application Archive (includes compile, generates qrcode.war file),
  • clean - removes compiled/generated files.

Configuration

QRCode Generator Application

By default, the QRCode Generator Application is accessible to anyone. You can change this by modifying web/WEB-INF/web.xml file before generation of the WAR archive or in the target installation.

There is also a set of servlet parameters (modify them in web/WEB-INF/web.xml before WAR generation or in the target installation) which allow to customize generator. These parameters have the following meanings:

  • defaultWidth - default value for width of the image (type: integer; min: 29; default: 256),
  • defaultHeight - default value for height of the image (type: integer; min: 29; default: 256),
  • maxWidth - maximum value for width of the image (type: integer; min: defaultWidth; default: 256),
  • maxHeight - maximum value for height of the image (type: integer; min: defaultWidth; default: 256),
  • maxContentSize - maximum length of the content (type: integer; min: 1; max: 2953;default: 2953),
  • debugMode - debug mode (type: boolean; default: false),
  • logToSTDOUT - should sevlet write to STDOUT rather then default log() method (type: boolean; default: false).

Detailed Description

QRCode Generator Application

QRCode Generator Application allows to generate QRCodes (format: PNG) online.

Servlet which serves images accepts HTTP GET requests containing the following query string parameters:

  • content - parameter contains information that needs to be exposed as a QRCode (format: URL encoded 8-bit characters),
  • height - parameter contains information on requested image height (format: integer; this value may be altered on the server side if there is such need - e.g. the value is to small to present the full content),
  • width - parameter contains information on requested image width (format: integer; this value may be altered on the server side if there is such need - e.g. the value is to small to present the full content).

By default servlet is mapped to generate path within context qrcode, so it can be accessed e.g. with the following URL:

http://PORTAL_DOMAIN/qrcode/generate/?content=test+content&height=256&width=256

Resources

Repository

Vitrall Collaborative Server is accessible at  https://apps.man.poznan.pl/svn/vitrall/trunk/collaborative ( Intellij IDEA project).

QRCode Generator Application is accessible under  https://apps.man.poznan.pl/svn/vitrall/trunk/collaborative/qrcode ( Intellij IDEA project).