Base container for SimOne. SimOne is a simple simulator for REST and FEED based services.
This projects builds a jar that constitutes core simulator functionality and is meant to be included in a Java EE 8 server that is built by the final simulator.
See SimOne-Example for a starting point to build a simulator.
Atom feed API : Publish the atom feed.
Example REST API : The REST API to simulate, implemented by the SimOne-example in this case.
Admin REST API : API to control the SimOne simulator, see Admin API for more information.
Extension API : API that notifies the SimOne simulator about actions initiated from the admin API, or create feed entries.
void se.uhr.simone.api.feed.FeedPublisher#publish(AtomEntry entry);-
Java 11
-
Java Microprofile 3.3 compatible server
-
Datasource, The application is required to produce a CDI bean of type
javax.sql.DataSourcewith qualifier@FeedDSto be used by the feed server. The Datasource must be initialized with the Flyway migration located on the classpath. -
A CDI event
se.uhr.simone.api.SimoneTimerEventmust be fired periodically in a worker thread to trigger background jobs. Every other second is a good starting point.
mvn packageRelease the SimOne jar and Docker image
mvn release:prepare release:performAPI to control the simulator, for example empty the database, answer all REST requests with a specific HTTP status, delay responses etc. The administrator API is documented in Swagger. Start the simone-example Docker container and point your Browser to http://localhost:8080/openapi
Simone uses MicroProfile Config to inject the configuration in the application:
simone.base.uri
: The base URI of SimOne, used to reference the SimOne server in the Atom Feed. Default value is http://localhost:8080
simone.dropin
: is a special directory that is monitored by SimOne. When a new file is discovered extensions are notified and may handle the file in any way they want. The default value is dropin in cwd.