Web Application SDK

AggreGate Web Application SDK is a part of AggreGate SDK that allows to implement web applications. Technically, in addition to a web application, a special version of AggreGate plugin is implemented, which performs registration of the web application. Therefore, using this SDK results in two files: AggreGate plugin and web application based on Java Servlet Technology.

Java Servlets are used to extend capabilities of servers that host applications accessed by means of a request-response programming model. Although servlets can respond to any type of request, they are commonly used to extend applications hosted by web servers. For such applications, Java Servlet technology defines HTTP-specific servlet classes.

Documentation provided in this section is applicable only to on-premise and edge AggreGate server instances. Cloud server users get AggreGate as a managed service, so custom web application functionality is disabled to unsure server reliability and uptime.

Implemented web applications can interact with AggreGate Server contexts and can be hosted on the same integrated web server as Web UI (so they use the same settings).

AggreGate SDK bundle includes an open-source example of AggreGate Web Application called Demo Web Application. It is located in examples.webapp package and comprises these files:

  • DemoWebAppContextPlugin.java - Plugin Class source code

  • DemoWebApplication.java - Web Application Class source code

  • DemoWebAppServlet.java - Java Servlet Class source code

  • build.gradle - Gradle build file with a single-task building JAR and WAR files

  • plugin.properties - component plugin descriptor

  • web.xml - web application deployment descriptor

To try the driver:

  • Run build.gradle using Gradle to build demo-web-app.jar and demo-web-app.war

  • Copy demo-web-app.jar to %AggreGate Server Installation Folder/plugins/context when AggreGate Server is not running

  • Copy demo-web-app.war to %AggreGate Server Installation Folder/admin when AggreGate Server is not running

  • Start AggreGate Server

  • Execute request using the following URL: http://localhost:8080/demo-web-app

Building a web application requires extra files in the build path in addition to aggregate-api.jar and aggregate-api-libs.jar:

  • extensions-libs.jar can be found in %AggreGate Server Installation Folder/jar

  • server-core.jar can be found in %AggreGate Server Installation Folder/jar

  • webserver.jar can be found in %AggreGate Server Installation Folder/plugins/contexts

Was this page helpful?