com.lightbend.lagom.javadsl.api

Interface Service

All Known Subinterfaces:

MetricsService

public interface Service

A Lagom service descriptor.

This interface implements a DSL for describing a service. It is inherently constrained in its use.

A service can describe itself by defining an interface that extends this interface, and provides a default implementation for the descriptor() method.

Method Summary

Modifier and Type	Method and Description
static <Request,Response> Descriptor.Call<Request,Response>	call(akka.japi.function.Creator<ServiceCall<Request,Response>> methodRef) Create a service call descriptor.
static <Request,Response> Descriptor.Call<Request,Response>	call(Descriptor.CallId callId, Object methodRef) Create a service call descriptor.
static <Request,Response> Descriptor.Call<Request,Response>	call(Method methodRef) Create a service call descriptor.
Descriptor	descriptor() Describe this service.
static Descriptor	named(String name) Create a descriptor for a service with the given name.
static <Request,Response> Descriptor.Call<Request,Response>	namedCall(String name, akka.japi.function.Creator<ServiceCall<Request,Response>> methodRef) Create a service call descriptor, identified by the given name.
static <Request,Response> Descriptor.Call<Request,Response>	namedCall(String name, Method methodRef) Create a service call descriptor, identified by the given name.
static <Request,Response> Descriptor.Call<Request,Response>	pathCall(String pathPattern, akka.japi.function.Creator<ServiceCall<Request,Response>> methodRef) Create a service call descriptor, identified by the given path pattern.
static <Request,Response,A> Descriptor.Call<Request,Response>	pathCall(String pathPattern, akka.japi.function.Function<A,ServiceCall<Request,Response>> methodRef) Create a service call descriptor, identified by the given path pattern.
static <Request,Response,A,B,C,D,E,F,G,H,I,J> Descriptor.Call<Request,Response>	pathCall(String pathPattern, akka.japi.function.Function10<A,B,C,D,E,F,G,H,I,J,ServiceCall<Request,Response>> methodRef) Create a service call descriptor, identified by the given path pattern.
static <Request,Response,A,B,C,D,E,F,G,H,I,J,K> Descriptor.Call<Request,Response>	pathCall(String pathPattern, akka.japi.function.Function11<A,B,C,D,E,F,G,H,I,J,K,ServiceCall<Request,Response>> methodRef) Create a service call descriptor, identified by the given path pattern.
static <Request,Response,A,B> Descriptor.Call<Request,Response>	pathCall(String pathPattern, akka.japi.function.Function2<A,B,ServiceCall<Request,Response>> methodRef) Create a service call descriptor, identified by the given path pattern.
static <Request,Response,A,B,C> Descriptor.Call<Request,Response>	pathCall(String pathPattern, akka.japi.function.Function3<A,B,C,ServiceCall<Request,Response>> methodRef) Create a service call descriptor, identified by the given path pattern.
static <Request,Response,A,B,C,D> Descriptor.Call<Request,Response>	pathCall(String pathPattern, akka.japi.function.Function4<A,B,C,D,ServiceCall<Request,Response>> methodRef) Create a service call descriptor, identified by the given path pattern.
static <Request,Response,A,B,C,D,E> Descriptor.Call<Request,Response>	pathCall(String pathPattern, akka.japi.function.Function5<A,B,C,D,E,ServiceCall<Request,Response>> methodRef) Create a service call descriptor, identified by the given path pattern.
static <Request,Response,A,B,C,D,E,F> Descriptor.Call<Request,Response>	pathCall(String pathPattern, akka.japi.function.Function6<A,B,C,D,E,F,ServiceCall<Request,Response>> methodRef) Create a service call descriptor, identified by the given path pattern.
static <Request,Response,A,B,C,D,E,F,G> Descriptor.Call<Request,Response>	pathCall(String pathPattern, akka.japi.function.Function7<A,B,C,D,E,F,G,ServiceCall<Request,Response>> methodRef) Create a service call descriptor, identified by the given path pattern.
static <Request,Response,A,B,C,D,E,F,G,H> Descriptor.Call<Request,Response>	pathCall(String pathPattern, akka.japi.function.Function8<A,B,C,D,E,F,G,H,ServiceCall<Request,Response>> methodRef) Create a service call descriptor, identified by the given path pattern.
static <Request,Response,A,B,C,D,E,F,G,H,I> Descriptor.Call<Request,Response>	pathCall(String pathPattern, akka.japi.function.Function9<A,B,C,D,E,F,G,H,I,ServiceCall<Request,Response>> methodRef) Create a service call descriptor, identified by the given path pattern.
static <Request,Response> Descriptor.Call<Request,Response>	pathCall(String pathPattern, Method methodRef) Create a service call descriptor, identified by the given path pattern.
static <Request,Response> Descriptor.Call<Request,Response>	restCall(Method method, String pathPattern, akka.japi.function.Creator<ServiceCall<Request,Response>> methodRef) Create a REST service call descriptor, identified by the given HTTP method and path pattern.
static <Request,Response,A> Descriptor.Call<Request,Response>	restCall(Method method, String pathPattern, akka.japi.function.Function<A,ServiceCall<Request,Response>> methodRef) Create a REST service call descriptor, identified by the given HTTP method and path pattern.
static <Request,Response,A,B,C,D,E,F,G,H,I,J> Descriptor.Call<Request,Response>	restCall(Method method, String pathPattern, akka.japi.function.Function10<A,B,C,D,E,F,G,H,I,J,ServiceCall<Request,Response>> methodRef) Create a REST service call descriptor, identified by the given HTTP method and path pattern.
static <Request,Response,A,B,C,D,E,F,G,H,I,J,K> Descriptor.Call<Request,Response>	restCall(Method method, String pathPattern, akka.japi.function.Function11<A,B,C,D,E,F,G,H,I,J,K,ServiceCall<Request,Response>> methodRef) Create a REST service call descriptor, identified by the given HTTP method and path pattern.
static <Request,Response,A,B> Descriptor.Call<Request,Response>	restCall(Method method, String pathPattern, akka.japi.function.Function2<A,B,ServiceCall<Request,Response>> methodRef) Create a REST service call descriptor, identified by the given HTTP method and path pattern.
static <Request,Response,A,B,C> Descriptor.Call<Request,Response>	restCall(Method method, String pathPattern, akka.japi.function.Function3<A,B,C,ServiceCall<Request,Response>> methodRef) Create a REST service call descriptor, identified by the given HTTP method and path pattern.
static <Request,Response,A,B,C,D> Descriptor.Call<Request,Response>	restCall(Method method, String pathPattern, akka.japi.function.Function4<A,B,C,D,ServiceCall<Request,Response>> methodRef) Create a REST service call descriptor, identified by the given HTTP method and path pattern.
static <Request,Response,A,B,C,D,E> Descriptor.Call<Request,Response>	restCall(Method method, String pathPattern, akka.japi.function.Function5<A,B,C,D,E,ServiceCall<Request,Response>> methodRef) Create a REST service call descriptor, identified by the given HTTP method and path pattern.
static <Request,Response,A,B,C,D,E,F> Descriptor.Call<Request,Response>	restCall(Method method, String pathPattern, akka.japi.function.Function6<A,B,C,D,E,F,ServiceCall<Request,Response>> methodRef) Create a REST service call descriptor, identified by the given HTTP method and path pattern.
static <Request,Response,A,B,C,D,E,F,G> Descriptor.Call<Request,Response>	restCall(Method method, String pathPattern, akka.japi.function.Function7<A,B,C,D,E,F,G,ServiceCall<Request,Response>> methodRef) Create a REST service call descriptor, identified by the given HTTP method and path pattern.
static <Request,Response,A,B,C,D,E,F,G,H> Descriptor.Call<Request,Response>	restCall(Method method, String pathPattern, akka.japi.function.Function8<A,B,C,D,E,F,G,H,ServiceCall<Request,Response>> methodRef) Create a REST service call descriptor, identified by the given HTTP method and path pattern.
static <Request,Response,A,B,C,D,E,F,G,H,I> Descriptor.Call<Request,Response>	restCall(Method method, String pathPattern, akka.japi.function.Function9<A,B,C,D,E,F,G,H,I,ServiceCall<Request,Response>> methodRef) Create a REST service call descriptor, identified by the given HTTP method and path pattern.
static <Request,Response> Descriptor.Call<Request,Response>	restCall(Method method, String pathPattern, Method methodRef) Create a REST service call descriptor, identified by the given HTTP method and path pattern.
static <Message> Descriptor.TopicCall<Message>	topic(String topicId, akka.japi.function.Creator<Topic<Message>> methodRef) Create a topic call descriptor, identified by the given topic id.
static <Message> Descriptor.TopicCall<Message>	topic(String topicId, Method methodRef) Create a topic call descriptor, identified by the given topic id.
static <Message> Descriptor.TopicCall<Message>	topic(String topicId, Object methodRef) Create a topic call descriptor, identified by the given topic id.

Method Detail

descriptor

Descriptor descriptor()

Describe this service.

The intended mechanism for implementing this is to provide it as a default implementation on an interface.

named

static Descriptor named(String name)

Create a descriptor for a service with the given name.

Parameters:

name - The name of the service.

Returns:

The descriptor.

restCall

static <Request,Response> Descriptor.Call<Request,Response> restCall(Method method,
                                                                     String pathPattern,
                                                                     akka.japi.function.Creator<ServiceCall<Request,Response>> methodRef)

Create a REST service call descriptor, identified by the given HTTP method and path pattern.

Parameters:

method - The HTTP method.

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A REST service call descriptor.

restCall

static <Request,Response,A> Descriptor.Call<Request,Response> restCall(Method method,
                                                                       String pathPattern,
                                                                       akka.japi.function.Function<A,ServiceCall<Request,Response>> methodRef)

Create a REST service call descriptor, identified by the given HTTP method and path pattern.

Parameters:

method - The HTTP method.

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A REST service call descriptor.

restCall

static <Request,Response,A,B> Descriptor.Call<Request,Response> restCall(Method method,
                                                                         String pathPattern,
                                                                         akka.japi.function.Function2<A,B,ServiceCall<Request,Response>> methodRef)

Create a REST service call descriptor, identified by the given HTTP method and path pattern.

Parameters:

method - The HTTP method.

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A REST service call descriptor.

restCall

static <Request,Response,A,B,C> Descriptor.Call<Request,Response> restCall(Method method,
                                                                           String pathPattern,
                                                                           akka.japi.function.Function3<A,B,C,ServiceCall<Request,Response>> methodRef)

Create a REST service call descriptor, identified by the given HTTP method and path pattern.

Parameters:

method - The HTTP method.

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A REST service call descriptor.

restCall

static <Request,Response,A,B,C,D> Descriptor.Call<Request,Response> restCall(Method method,
                                                                             String pathPattern,
                                                                             akka.japi.function.Function4<A,B,C,D,ServiceCall<Request,Response>> methodRef)

Create a REST service call descriptor, identified by the given HTTP method and path pattern.

Parameters:

method - The HTTP method.

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A REST service call descriptor.

restCall

static <Request,Response,A,B,C,D,E> Descriptor.Call<Request,Response> restCall(Method method,
                                                                               String pathPattern,
                                                                               akka.japi.function.Function5<A,B,C,D,E,ServiceCall<Request,Response>> methodRef)

Create a REST service call descriptor, identified by the given HTTP method and path pattern.

Parameters:

method - The HTTP method.

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A REST service call descriptor.

restCall

static <Request,Response,A,B,C,D,E,F> Descriptor.Call<Request,Response> restCall(Method method,
                                                                                 String pathPattern,
                                                                                 akka.japi.function.Function6<A,B,C,D,E,F,ServiceCall<Request,Response>> methodRef)

Create a REST service call descriptor, identified by the given HTTP method and path pattern.

Parameters:

method - The HTTP method.

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A REST service call descriptor.

restCall

static <Request,Response,A,B,C,D,E,F,G> Descriptor.Call<Request,Response> restCall(Method method,
                                                                                   String pathPattern,
                                                                                   akka.japi.function.Function7<A,B,C,D,E,F,G,ServiceCall<Request,Response>> methodRef)

Create a REST service call descriptor, identified by the given HTTP method and path pattern.

Parameters:

method - The HTTP method.

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A REST service call descriptor.

restCall

static <Request,Response,A,B,C,D,E,F,G,H> Descriptor.Call<Request,Response> restCall(Method method,
                                                                                     String pathPattern,
                                                                                     akka.japi.function.Function8<A,B,C,D,E,F,G,H,ServiceCall<Request,Response>> methodRef)

Create a REST service call descriptor, identified by the given HTTP method and path pattern.

Parameters:

method - The HTTP method.

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A REST service call descriptor.

restCall

static <Request,Response,A,B,C,D,E,F,G,H,I> Descriptor.Call<Request,Response> restCall(Method method,
                                                                                       String pathPattern,
                                                                                       akka.japi.function.Function9<A,B,C,D,E,F,G,H,I,ServiceCall<Request,Response>> methodRef)

Create a REST service call descriptor, identified by the given HTTP method and path pattern.

Parameters:

method - The HTTP method.

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A REST service call descriptor.

restCall

static <Request,Response,A,B,C,D,E,F,G,H,I,J> Descriptor.Call<Request,Response> restCall(Method method,
                                                                                         String pathPattern,
                                                                                         akka.japi.function.Function10<A,B,C,D,E,F,G,H,I,J,ServiceCall<Request,Response>> methodRef)

Create a REST service call descriptor, identified by the given HTTP method and path pattern.

Parameters:

method - The HTTP method.

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A REST service call descriptor.

restCall

static <Request,Response,A,B,C,D,E,F,G,H,I,J,K> Descriptor.Call<Request,Response> restCall(Method method,
                                                                                           String pathPattern,
                                                                                           akka.japi.function.Function11<A,B,C,D,E,F,G,H,I,J,K,ServiceCall<Request,Response>> methodRef)

Create a REST service call descriptor, identified by the given HTTP method and path pattern.

Parameters:

method - The HTTP method.

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A REST service call descriptor.

restCall

static <Request,Response> Descriptor.Call<Request,Response> restCall(Method method,
                                                                     String pathPattern,
                                                                     Method methodRef)

Create a REST service call descriptor, identified by the given HTTP method and path pattern.

Parameters:

method - The HTTP method.

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A REST service call descriptor.

pathCall

static <Request,Response> Descriptor.Call<Request,Response> pathCall(String pathPattern,
                                                                     akka.japi.function.Creator<ServiceCall<Request,Response>> methodRef)

Create a service call descriptor, identified by the given path pattern.

Parameters:

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A path identified service call descriptor.

pathCall

static <Request,Response,A> Descriptor.Call<Request,Response> pathCall(String pathPattern,
                                                                       akka.japi.function.Function<A,ServiceCall<Request,Response>> methodRef)

Create a service call descriptor, identified by the given path pattern.

Parameters:

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A path identified service call descriptor.

pathCall

static <Request,Response,A,B> Descriptor.Call<Request,Response> pathCall(String pathPattern,
                                                                         akka.japi.function.Function2<A,B,ServiceCall<Request,Response>> methodRef)

Create a service call descriptor, identified by the given path pattern.

Parameters:

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A path identified service call descriptor.

pathCall

static <Request,Response,A,B,C> Descriptor.Call<Request,Response> pathCall(String pathPattern,
                                                                           akka.japi.function.Function3<A,B,C,ServiceCall<Request,Response>> methodRef)

Create a service call descriptor, identified by the given path pattern.

Parameters:

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A path identified service call descriptor.

pathCall

static <Request,Response,A,B,C,D> Descriptor.Call<Request,Response> pathCall(String pathPattern,
                                                                             akka.japi.function.Function4<A,B,C,D,ServiceCall<Request,Response>> methodRef)

Create a service call descriptor, identified by the given path pattern.

Parameters:

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A path identified service call descriptor.

pathCall

static <Request,Response,A,B,C,D,E> Descriptor.Call<Request,Response> pathCall(String pathPattern,
                                                                               akka.japi.function.Function5<A,B,C,D,E,ServiceCall<Request,Response>> methodRef)

Create a service call descriptor, identified by the given path pattern.

Parameters:

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A path identified service call descriptor.

pathCall

static <Request,Response,A,B,C,D,E,F> Descriptor.Call<Request,Response> pathCall(String pathPattern,
                                                                                 akka.japi.function.Function6<A,B,C,D,E,F,ServiceCall<Request,Response>> methodRef)

Create a service call descriptor, identified by the given path pattern.

Parameters:

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A path identified service call descriptor.

pathCall

static <Request,Response,A,B,C,D,E,F,G> Descriptor.Call<Request,Response> pathCall(String pathPattern,
                                                                                   akka.japi.function.Function7<A,B,C,D,E,F,G,ServiceCall<Request,Response>> methodRef)

Create a service call descriptor, identified by the given path pattern.

Parameters:

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A path identified service call descriptor.

pathCall

static <Request,Response,A,B,C,D,E,F,G,H> Descriptor.Call<Request,Response> pathCall(String pathPattern,
                                                                                     akka.japi.function.Function8<A,B,C,D,E,F,G,H,ServiceCall<Request,Response>> methodRef)

Create a service call descriptor, identified by the given path pattern.

Parameters:

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A path identified service call descriptor.

pathCall

static <Request,Response,A,B,C,D,E,F,G,H,I> Descriptor.Call<Request,Response> pathCall(String pathPattern,
                                                                                       akka.japi.function.Function9<A,B,C,D,E,F,G,H,I,ServiceCall<Request,Response>> methodRef)

Create a service call descriptor, identified by the given path pattern.

Parameters:

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A path identified service call descriptor.

pathCall

static <Request,Response,A,B,C,D,E,F,G,H,I,J> Descriptor.Call<Request,Response> pathCall(String pathPattern,
                                                                                         akka.japi.function.Function10<A,B,C,D,E,F,G,H,I,J,ServiceCall<Request,Response>> methodRef)

Create a service call descriptor, identified by the given path pattern.

Parameters:

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A path identified service call descriptor.

pathCall

static <Request,Response,A,B,C,D,E,F,G,H,I,J,K> Descriptor.Call<Request,Response> pathCall(String pathPattern,
                                                                                           akka.japi.function.Function11<A,B,C,D,E,F,G,H,I,J,K,ServiceCall<Request,Response>> methodRef)

Create a service call descriptor, identified by the given path pattern.

Parameters:

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A path identified service call descriptor.

pathCall

static <Request,Response> Descriptor.Call<Request,Response> pathCall(String pathPattern,
                                                                     Method methodRef)

Create a service call descriptor, identified by the given path pattern.

Parameters:

pathPattern - The path pattern.

methodRef - A method reference to the service call.

Returns:

A path identified service call descriptor.

namedCall

static <Request,Response> Descriptor.Call<Request,Response> namedCall(String name,
                                                                      akka.japi.function.Creator<ServiceCall<Request,Response>> methodRef)

Create a service call descriptor, identified by the given name.

Parameters:

name - The name of the service call.

methodRef - The service call.

Returns:

A name identified service call descriptor.

namedCall

static <Request,Response> Descriptor.Call<Request,Response> namedCall(String name,
                                                                      Method methodRef)

Create a service call descriptor, identified by the given name.

Parameters:

name - The name of the service call.

methodRef - The service call.

Returns:

A name identified service call descriptor.

call

static <Request,Response> Descriptor.Call<Request,Response> call(akka.japi.function.Creator<ServiceCall<Request,Response>> methodRef)

Create a service call descriptor.

The identifier for this descriptor will be automatically selected by Lagom.

Parameters:

methodRef - The service call.

Returns:

A name identified service call descriptor.

call

static <Request,Response> Descriptor.Call<Request,Response> call(Method methodRef)

Create a service call descriptor.

The identifier for this descriptor will be automatically selected by Lagom.

Parameters:

methodRef - The service call.

Returns:

A name identified service call descriptor.

call

static <Request,Response> Descriptor.Call<Request,Response> call(Descriptor.CallId callId,
                                                                 Object methodRef)

Create a service call descriptor.

Parameters:

callId - The service call identifier.

methodRef - The service call.

Returns:

A service call descriptor.

topic

static <Message> Descriptor.TopicCall<Message> topic(String topicId,
                                                     Method methodRef)

Create a topic call descriptor, identified by the given topic id.

Parameters:

topicId - The topic identifier.

methodRef - The topic call.

Returns:

A topic call descriptor.

topic

static <Message> Descriptor.TopicCall<Message> topic(String topicId,
                                                     akka.japi.function.Creator<Topic<Message>> methodRef)

Create a topic call descriptor, identified by the given topic id.

Parameters:

topicId - The topic identifier.

methodRef - The topic call.

Returns:

A topic call descriptor.

topic

static <Message> Descriptor.TopicCall<Message> topic(String topicId,
                                                     Object methodRef)

Create a topic call descriptor, identified by the given topic id.

Parameters:

topicId - The topic identifier.

methodRef - The topic call.

Returns:

A topic call descriptor.