Skip to content

Creating a Microserver plugin

johnmcclean-aol edited this page Jan 25, 2016 · 3 revisions

As of v0.60 of Microserver, Microserver supports custom plugins or modules.

Creating a custom Plugin

Plugins implement the com.aol.micro.server.Plugin interface. It allows

  • jax-rs configuration to be set (resources, packages etc)
  • Spring configuration to be set (via Spring Configuration classes)
  • Servlet related configuration (Servlets, Filters, Listeners etc)
  • Webserver and jax-rs implementations to be configured
  • Jackson properties and modules to be configured

Inside your plugin jar you should create the directory structure

META-INF/services/

Inside services add a file with the name

com.aol.micro.server.Plugin

And inside this file, add the full path to your implementation of Plugin (you may add multiple per jar or project).

Example Plugins

  1. micro-reactive
  2. micro-events
  3. micro-data
  4. micro-metrics
  5. micro-swagger
  6. micro-client
  7. micro-grizzly
  8. micro-jersey
  9. micro-guava
  10. micro-ip-tracker
  11. micro-cors