Administrator Guide

Overview

EventsPlugIn is an extension for the jWebSocket framework to provide a server-side event-driven programming model. The extension increases the oriented object programming (OOP) usage and provides support for aspect oriented programming (AOP) in the client to server communication process.

EventsPlugIn also promotes the integration with the Spring framework to re-use the excellent mechanism existing on it oriented to the server side application development.

Download

The EventsPlugIn extension is part of the jWebSocket official release and can be downloaded by downloading the jWebSocket framework. This is from the URL: http://jwebsocket.org/download/.

Installation environment

 
  • The Java Virtual Machine and Java Development Kit (Sun JDK | OpenJDK) 1.6 version or higher installed.
  • A Web server (e.g. Apache) installed to publish the Web applications.
  • An IDE to develop Java applications (e.g NetBeans or Eclipse).

Installation process

  1. Download the jWebSocket server 1.0 version from URL.
  2. Uncompress the downloaded package in a selected directory.
  3. Create an operating system environment variable called “JWEBSOCKET_HOME” and assign it as value the path to the directory containing the jWebSocket uncommpressed files.

Hardware

Developers may use machines with powerful Dual-Core processors or higher and 2 or more GB of RAM.

Depending or the applications particular process requirements and target multi-user concurrency,  production servers may use strong Quad-Core processors and 8 GB or more of RAM dedicated to the JVM process running the jWebSocket server.

For high speed database access on high user concurrency scenarios, databases should be installed in dedicated servers to avoid overloads in the application server.

Settings

The EventsPlugIn extension does not require special configurations to be used. Instead the applications created with EventsPlugIn make usages of the jWebSocket.xml main configuration file and a complete new set of Spring configuration files  located in the directory:

$JWEBSOCKET_HOME/conf/EventsPlugIn/appname-application folder.

The way to configure an EventsPlugIn application is by using the Spring Inversion of Control Container and XML files. By default, the jWebSocket server 1.0 version package comes with a sample “test-application” configuration, that can be used as prototype to configure new applications.

In the main configuration file jWebSocket.xml, the following configuration require to be added to set an application to be loaded by the application server:

<plugins>
   ...
  <plugins>  
    <plugin>
      <name>org.jwebsocket.plugins.events.EventsPlugIn</name>
        <ns>alarm</ns>
        <id>jws.eventsplugin.alarm</id>
        <jar>jWebSocketEventsPlugIn-1.0.jar</jar>
        <server-assignments>
          <server-assignment>ts0</server-assignment>
        </server-assignments>
    </plugin>
  </plugins>
  ...
</plugins>

For more details about specific application configuration see the “Configuring the application with Spring” section in the Developer Guide.

How does it work?

  1. Execute the Web server to publish the server-side application Web client. Copy your Web client files in a public Web server directory.
  2. Execute the jWebSocket server by using the following comand line:
  3. java -jar $JWEBSOCKET_HOME/libs/jWebSocketServer-Bundle-1.0.jar
  4. Open your Web client with a WebSocket compliant browser. Older Browsers are supported by the Flash- or Comet-Fallback. Start using your Web application from your Web client.

Support

The EventsPlugIn extension is part of the official jWebSocket release, has been designed and developed by Rolando Santamaría Masó<kyberneees>, member of the jWebSocket development team.

Contact with kyberneees at:

Report issues at: http://jwebsocket.org/issue_report.htm

Publications

Learn more about WebSockets in general, get background information and gain deeper insight!

Join jWebSocket

Wether developer, designer or translator – join the jWebSocket team and grow together with our success!

Copyright © 2013 Innotrade GmbH. All rights reserved.