CatgirlIntelligenceAgency/code/common/service
Viktor Lofgren 1dafa0c74d (mqapi/control) Repair repartition endpoint, deprecate notify endpoints.
The repartition endpoint was mis-addressing its mqapi notifications, omitting the proper nodeId.  In fixing this, it became apparent that having both @MqRequest and @MqNotification is a serious footgun, and the two should be unified into a single API where the caller isn't burdened with knowledge of the remote end's implementation specifics.
2023-11-27 16:01:12 +01:00
..
src/main (mqapi/control) Repair repartition endpoint, deprecate notify endpoints. 2023-11-27 16:01:12 +01:00
build.gradle (service) Keep disabled multi-noded services dormant when they are configured to be disabled. 2023-10-14 20:58:55 +02:00
readme.md Embryo of new control process 2023-07-03 10:40:32 +02:00

Service

Contains the base classes for the services. This is where port configuration, and common endpoints are set up.

Creating a new Service

The minimal service needs a MainClass and a Service class.

For proper initiation, the main class should look like this:

public class FoobarMain extends MainClass {

    @Inject
    public FoobarMain(FoobarService service) {}

    public static void main(String... args) {
        init(ServiceId.Foobar, args);

        Injector injector = Guice.createInjector(
                new FoobarModule(), /* optional custom bindings go here */
                new DatabaseModule(),
                new ConfigurationModule(SearchServiceDescriptors.descriptors, 
                        ServiceId.Foobar));

        injector.getInstance(FoobarMain.class);
        
        // set the service as ready so that delayed tasks can be started
        injector.getInstance(Initialization.class).setReady();
    }
}

A service class has a boilerplate set-up that looks like this:

@Singleton
public class FoobarService extends Service {

    @Inject
    public FoobarService(BaseServiceParams params) {
        super(params);
        
        // set up Spark endpoints here
    }
}

Further the new service needs to be added to the ServiceId enum in service-discovery.

Central Classes