com.lightbend.lagom.javadsl.server

Interface ServiceGuiceSupport

All Superinterfaces:

ServiceClientGuiceSupport

public interface ServiceGuiceSupport
extends ServiceClientGuiceSupport

Lagom service implementations must create one implementation of this interface and use it to bind Service implementations.

Implementors of this interface must invoke bindService(java.lang.Class<T>, java.lang.Class<? extends T>), bindServices(ServiceBinding[]) or bindServiceInfo(ServiceInfo) exactly-once depending on the type of Lagom service being implemented (1 service, many services, consume-only). These methods setup the service and may transparently add cross-cutting services like MetricsService (allows monitoring circuit-breakers from the outside).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ServiceGuiceSupport.ClassServiceBinding<T>
static class	ServiceGuiceSupport.InstanceServiceBinding<T>
static class	ServiceGuiceSupport.LagomServiceBuilder
static class	ServiceGuiceSupport.ServiceBinding<T>

Method Summary

Modifier and Type	Method and Description
default <R extends play.api.routing.Router> AdditionalRouter	additionalRouter(Class<R> router) Helper method to create an AdditionalRouter instance that can be used to declare additional Play Routers on a Lagom Service.
default AdditionalRouter	additionalRouter(play.api.routing.Router router) Helper method to create an AdditionalRouter instance that can be used to declare additional Play Routers on a Lagom Service.
default <T extends Service> void	bindService(Class<T> serviceInterface, Class<? extends T> serviceImplementation) Binds a Service interface with its implementation.
default <T extends Service> void	bindService(Class<T> serviceInterface, Class<? extends T> serviceImplementation, AdditionalRouter additionalRouter, AdditionalRouter... additionalRouters) Binds a Service interface with its implementation.
default <T extends Service> void	bindService(Class<T> serviceInterface, T service) Binds a Service interface with an instance that implements it.
default <T extends Service> void	bindService(Class<T> serviceInterface, T service, AdditionalRouter additionalRouter, AdditionalRouter... additionalRouters) Binds a Service interface with an instance that implements it.
default void	bindServiceInfo(ServiceInfo serviceInfo) Creates a custom ServiceInfo for this Lagom service.
default void	bindServices(ServiceGuiceSupport.ServiceBinding<?>... serviceBindings) Deprecated. support for multiple locatable ServiceDescriptors per Lagom service will be removed. Use bindService(java.lang.Class<T>, java.lang.Class<? extends T>) instead
default <T> ServiceGuiceSupport.ServiceBinding<T>	serviceBinding(Class<T> serviceInterface, Class<? extends T> serviceImplementation) Convenience method to create ServiceGuiceSupport.ServiceBinding when using bindServices(ServiceBinding[]).
default <T> ServiceGuiceSupport.ServiceBinding<T>	serviceBinding(Class<T> serviceInterface, T service) Convenience method to create ServiceGuiceSupport.ServiceBinding when using bindServices(ServiceBinding[]).

Methods inherited from interface com.lightbend.lagom.javadsl.client.ServiceClientGuiceSupport

bindClient

Method Detail

additionalRouter

@ApiMayChange
default <R extends play.api.routing.Router> AdditionalRouter additionalRouter(Class<R> router)

Helper method to create an AdditionalRouter instance that can be used to declare additional Play Routers on a Lagom Service.

This method should be used when the Router has some dependencies and needs to get them injected by Lagom's runtime DI infrastructure (Guice).

Typically, this will be a Router generated from a Play routes or a akka-grpc generated Play Router.

Once you declare a Router, you may need to define its prefix to indicate on which path it should be available.

 bindService(
     MyService.class, MyServiceImpl.class,
     additionalRouter(HelloWorldRouter.class).withPrefix("/hello"),
 );
 

You don't need to configure a prefix if the Router has it pre-configured. A akka-grpc generated Play Router, for instance, has its prefix already defined by the gRPC descriptor and doesn't need to have its prefix reconfigured.

Note that this method won't create a binding and is intended to be used in conjunction with bindService(Class, Service, AdditionalRouter, AdditionalRouter...) or bindService(Class, Class, AdditionalRouter, AdditionalRouter...). Calling this method outside this context will have no effect.

Parameters:

router - an additional Play Router class

Returns:

an AdditionalRouter instance

additionalRouter

@ApiMayChange
default AdditionalRouter additionalRouter(play.api.routing.Router router)

Helper method to create an AdditionalRouter instance that can be used to declare additional Play Routers on a Lagom Service.

This method should be used when the Router does not have any other dependencies and therefore can be immediately passed as an instance.

Once you declare a Router, you may need to define its prefix to indicate on which path it should be available.

 bindService(
     MyService.class, MyServiceImpl.class,
     additionalRouter(new HelloWorldRouter()).withPrefix("/hello"),
 );
 

You don't need to configure a prefix if the Router has it pre-configured.

Note that this method won't create a binding and is intended to be used in conjunction with bindService(Class, Service, AdditionalRouter, AdditionalRouter...) or bindService(Class, Class, AdditionalRouter, AdditionalRouter...). Calling this method outside this context will have no effect.

Parameters:

router - an additional Play Router instance

Returns:

an AdditionalRouter instance

bindServiceInfo

default void bindServiceInfo(ServiceInfo serviceInfo)

Creates a custom ServiceInfo for this Lagom service. This method overrides ServiceClientGuiceSupport.bindServiceInfo(ServiceInfo) with custom behavior for consume-only Lagom services.

Specified by:

bindServiceInfo in interface ServiceClientGuiceSupport

Parameters:

serviceInfo - the metadata identifying this Lagom Service.

bindServices

default void bindServices(ServiceGuiceSupport.ServiceBinding<?>... serviceBindings)

Deprecated. support for multiple locatable ServiceDescriptors per Lagom service will be removed. Use bindService(java.lang.Class<T>, java.lang.Class<? extends T>) instead

Binds Service interfaces with their implementations and registers them for publishing.

Inspects all bindings and creates routes to serve every call described in the bound services.

Builds the ServiceInfo metadata using only the locatable services.

Parameters:

serviceBindings - an arbitrary list of ServiceGuiceSupport.ServiceBindings. Use the convenience method serviceBinding(Class, Class) to build the ServiceGuiceSupport.ServiceBindings. Despite being a varargs argument, it is required to provide at least one ServiceGuiceSupport.ServiceBinding as argument.

bindService

default <T extends Service> void bindService(Class<T> serviceInterface,
                                             Class<? extends T> serviceImplementation)

Binds a Service interface with its implementation.

Inspects the service descriptor and creates routes to serve every call described.

Builds the ServiceInfo metadata.

Type Parameters:

T - type constraint ensuring serviceImplementation implements serviceInterface

Parameters:

serviceInterface - the interface class for a Service

serviceImplementation - the implementation class for the serviceInterface

bindService

default <T extends Service> void bindService(Class<T> serviceInterface,
                                             Class<? extends T> serviceImplementation,
                                             AdditionalRouter additionalRouter,
                                             AdditionalRouter... additionalRouters)

Binds a Service interface with its implementation.

Inspects the service descriptor and creates routes to serve every call described.

Allows the configuration of additional Play routers.

Builds the ServiceInfo metadata.

Type Parameters:

T - type constraint ensuring serviceImplementation implements serviceInterface

Parameters:

serviceInterface - the interface class for a Service

serviceImplementation - the implementation class for the serviceInterface

additionalRouter - a first AdditionalRouter

additionalRouters - other AdditionalRouter if any (can be omitted)

bindService

default <T extends Service> void bindService(Class<T> serviceInterface,
                                             T service)

Binds a Service interface with an instance that implements it.

Inspects the service descriptor and creates routes to serve every call described.

Builds the ServiceInfo metadata.

Type Parameters:

T - type constraint ensuring serviceImplementation implements serviceInterface

Parameters:

serviceInterface - the interface class for a Service

service - an instance of a class implementing serviceInterface

bindService

default <T extends Service> void bindService(Class<T> serviceInterface,
                                             T service,
                                             AdditionalRouter additionalRouter,
                                             AdditionalRouter... additionalRouters)

Binds a Service interface with an instance that implements it.

Inspects the service descriptor and creates routes to serve every call described.

Allows the configuration of additional Play routers. AdditionalRouter can be configured using additionalRouter(Class) or additionalRouter(Router).

Builds the ServiceInfo metadata.

Type Parameters:

T - type constraint ensuring serviceImplementation implements serviceInterface

Parameters:

serviceInterface - the interface class for a Service

service - an instance of a class implementing serviceInterface

additionalRouter - a first AdditionalRouter

additionalRouters - other AdditionalRouter if any (can be omitted)

serviceBinding

default <T> ServiceGuiceSupport.ServiceBinding<T> serviceBinding(Class<T> serviceInterface,
                                                                 Class<? extends T> serviceImplementation)

Convenience method to create ServiceGuiceSupport.ServiceBinding when using bindServices(ServiceBinding[]).

Returns:

a ServiceGuiceSupport.ServiceBinding to be used as argument in bindServices(ServiceBinding[]).

serviceBinding

default <T> ServiceGuiceSupport.ServiceBinding<T> serviceBinding(Class<T> serviceInterface,
                                                                 T service)

Convenience method to create ServiceGuiceSupport.ServiceBinding when using bindServices(ServiceBinding[]).

Type Parameters:

T - type constraint ensuring service implements serviceInterface

Parameters:

serviceInterface - the interface class for a service

service - an instance of the service

Returns:

a ServiceGuiceSupport.ServiceBinding to be used as argument in bindServices(ServiceBinding[]).