Package io.openems.edge.common.jsonapi

Class JsonApiBuilder

java.lang.Object

io.openems.edge.common.jsonapi.JsonApiBuilder

public class JsonApiBuilder
extends Object

TODO route interceptor/observer/notifications.

Constructor Summary

Constructors

Constructor	Description
JsonApiBuilder()

Method Summary

Modifier and Type	Method	Description
void	addBuilder(JsonApiBuilder builder)	Adds a JsonApiBuilder to the current builder.
void	addEndpointAddedListener(Consumer<JsonApiEndpoint> listener)	Adds a listener to call when a endpoint got added to the current builder.
void	addEndpointRemovedListener(Consumer<JsonApiEndpoint> listener)	Adds a listener to call when a endpoint got removed to the current builder.
void	close()	Closes this builder.
JsonApiBuilder	delegate(String method, ThrowingFunction<Call<JsonrpcRequest,JsonrpcResponse>,JsonrpcRequest,Exception> handler)	Delegates the handled request to another endpoint.
JsonApiBuilder	delegate(String method, ThrowingFunction<Call<JsonrpcRequest,JsonrpcResponse>,JsonrpcRequest,Exception> handler, Function<JsonApiBuilder,JsonApiBuilder> builder)	Delegates the handled request to another endpoint.
JsonApiBuilder	delegate(String method, ThrowingFunction<Call<JsonrpcRequest,JsonrpcResponse>,JsonrpcRequest,Exception> handler, Function<JsonApiBuilder,JsonApiBuilder> builder, Supplier<List<Subrequest>> subroutes)	Delegates the handled request to another endpoint.
JsonApiBuilder	delegate(String method, Consumer<EndpointDefinitionBuilder<JsonrpcRequest,JsonrpcResponse>> defBuilder, ThrowingFunction<Call<JsonrpcRequest,JsonrpcResponse>,JsonrpcRequest,Exception> handler)	Delegates the handled request to another endpoint.
JsonApiBuilder	delegate(String method, Consumer<EndpointDefinitionBuilder<JsonrpcRequest,JsonrpcResponse>> defBuilder, ThrowingFunction<Call<JsonrpcRequest,JsonrpcResponse>,JsonrpcRequest,Exception> handler, Function<JsonApiBuilder,JsonApiBuilder> builder)	Delegates the handled request to another endpoint.
JsonApiBuilder	delegate(String method, Consumer<EndpointDefinitionBuilder<JsonrpcRequest,JsonrpcResponse>> defBuilder, ThrowingFunction<Call<JsonrpcRequest,JsonrpcResponse>,JsonrpcRequest,Exception> handler, Function<JsonApiBuilder,JsonApiBuilder> builder, Function<JsonrpcResponse,JsonrpcResponse> responseMapper, Supplier<List<Subrequest>> subroutes)	Delegates the handled request to another endpoint.
Map<String,JsonApiEndpoint>	getEndpoints()
void	handle(Call<JsonrpcRequest,JsonrpcResponse> call)	Handles a Call.
<REQUEST, RESPONSE> JsonApiBuilder	handleRequest(EndpointRequestType<REQUEST,RESPONSE> endpointType, Consumer<EndpointDefinitionBuilder<REQUEST,RESPONSE>> defBuilder, ThrowingFunction<Call<REQUEST,RESPONSE>,RESPONSE,Exception> handler)	Adds a rpc request handler to the current builder.
JsonApiBuilder	handleRequest(String method, ThrowingFunction<Call<JsonrpcRequest,JsonrpcResponse>,JsonrpcResponse,Exception> handler)	Adds a rpc request handler to the current builder.
JsonApiBuilder	handleRequest(String method, Consumer<EndpointDefinitionBuilder<JsonrpcRequest,JsonrpcResponse>> defBuilder, ThrowingFunction<Call<JsonrpcRequest,JsonrpcResponse>,JsonrpcResponse,Exception> handler)	Adds a rpc request handler to the current builder.
boolean	isDebug()
void	removeBuilder(JsonApiBuilder builder)	Removes a JsonApiBuilder and all its methods from this builder.
JsonApiEndpoint	removeEndpoint(String method)	Removes an endpoint by its method.
void	removeEndpointAddedListener(Consumer<JsonApiEndpoint> listener)	Removes a listener which was subscribed to the endpoint added event.
void	removeEndpointRemovedListener(Consumer<JsonApiEndpoint> listener)	Removes a listener which was subscribed to the endpoint removed event.
JsonApiBuilder	rpc(String method, ThrowingConsumer<Call<JsonrpcRequest,JsonrpcResponse>,Exception> handler)	Adds a rpc handler to the current builder.
JsonApiBuilder	rpc(String method, Consumer<EndpointDefinitionBuilder<JsonrpcRequest,JsonrpcResponse>> defBuilder, ThrowingConsumer<Call<JsonrpcRequest,JsonrpcResponse>,Exception> handler)	Adds a rpc handler to the current builder.
JsonApiBuilder	rpc(String method, Consumer<EndpointDefinitionBuilder<JsonrpcRequest,JsonrpcResponse>> defBuilder, Supplier<List<Subrequest>> subroutes, ThrowingConsumer<Call<JsonrpcRequest,JsonrpcResponse>,Exception> handler)	Adds a rpc handler to the current builder.
<REQUEST> JsonApiBuilder	rpc(String method, Consumer<EndpointDefinitionBuilder<REQUEST,JsonrpcResponse>> defBuilder, Supplier<List<Subrequest>> subroutes, ThrowingConsumer<Call<REQUEST,JsonrpcResponse>,Exception> handler, JsonSerializer<REQUEST> serializer)	Adds a rpc handler to the current builder.
<REQUEST, RESPONSE> JsonApiBuilder	rpc(String method, Consumer<EndpointDefinitionBuilder<REQUEST,RESPONSE>> defBuilder, ThrowingConsumer<Call<REQUEST,RESPONSE>,Exception> handler, JsonSerializer<REQUEST> requestSerializer, JsonSerializer<RESPONSE> responseSerializer)	Adds a rpc handler to the current builder.
void	setDebug(boolean debug)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JsonApiBuilder

public JsonApiBuilder()

Method Details

handleRequest

public JsonApiBuilder handleRequest(String method,
 ThrowingFunction<Call<JsonrpcRequest,JsonrpcResponse>,JsonrpcResponse,Exception> handler)

Adds a rpc request handler to the current builder.

Parameters:

method - the method of the handled rpc request

handler - the handler of the request

Returns:

this

handleRequest

public JsonApiBuilder handleRequest(String method,
 Consumer<EndpointDefinitionBuilder<JsonrpcRequest,JsonrpcResponse>> defBuilder,
 ThrowingFunction<Call<JsonrpcRequest,JsonrpcResponse>,JsonrpcResponse,Exception> handler)

Adds a rpc request handler to the current builder.

Parameters:

method - the method of the handled rpc request

defBuilder - the builder for the EndpointDefinitionBuilder

handler - the handler of the request

Returns:

this

handleRequest

public <REQUEST,
RESPONSE> JsonApiBuilder handleRequest(EndpointRequestType<REQUEST,RESPONSE> endpointType,
 Consumer<EndpointDefinitionBuilder<REQUEST,RESPONSE>> defBuilder,
 ThrowingFunction<Call<REQUEST,RESPONSE>,RESPONSE,Exception> handler)

Adds a rpc request handler to the current builder.

Type Parameters:

REQUEST - the type of the request

RESPONSE - the type of the response

Parameters:

endpointType - the EndpointRequestType of the handled rpc request

defBuilder - the builder for the EndpointDefinitionBuilder

handler - the handler of the request

Returns:

this

rpc

public JsonApiBuilder rpc(String method,
 ThrowingConsumer<Call<JsonrpcRequest,JsonrpcResponse>,Exception> handler)

Adds a rpc handler to the current builder.

Parameters:

method - the method of the handled rpc request

handler - the handler of the request

Returns:

this

rpc

public JsonApiBuilder rpc(String method,
 Consumer<EndpointDefinitionBuilder<JsonrpcRequest,JsonrpcResponse>> defBuilder,
 ThrowingConsumer<Call<JsonrpcRequest,JsonrpcResponse>,Exception> handler)

Adds a rpc handler to the current builder.

Parameters:

method - the method of the handled rpc request

defBuilder - the builder for the EndpointDefinitionBuilder

handler - the handler of the request

Returns:

this

rpc

public <REQUEST,
RESPONSE> JsonApiBuilder rpc(String method,
 Consumer<EndpointDefinitionBuilder<REQUEST,RESPONSE>> defBuilder,
 ThrowingConsumer<Call<REQUEST,RESPONSE>,Exception> handler,
 JsonSerializer<REQUEST> requestSerializer,
 JsonSerializer<RESPONSE> responseSerializer)

Adds a rpc handler to the current builder.

Type Parameters:

REQUEST - the type of the request

RESPONSE - the type of the response

Parameters:

method - the method of the handled rpc request

defBuilder - the builder for the EndpointDefinitionBuilder

handler - the handler of the request

requestSerializer - the JsonSerializer of the request

responseSerializer - the JsonSerializer of the response

Returns:

this

rpc

public <REQUEST> JsonApiBuilder rpc(String method,
 Consumer<EndpointDefinitionBuilder<REQUEST,JsonrpcResponse>> defBuilder,
 Supplier<List<Subrequest>> subroutes,
 ThrowingConsumer<Call<REQUEST,JsonrpcResponse>,Exception> handler,
 JsonSerializer<REQUEST> serializer)

Adds a rpc handler to the current builder.

Type Parameters:

REQUEST - the type of the request

Parameters:

method - the method of the handled rpc request

defBuilder - the builder for the EndpointDefinitionBuilder

subroutes - the subroutes which can be reached with this handler

handler - the handler of the request

serializer - the JsonSerializer of the request

Returns:

this

rpc

public JsonApiBuilder rpc(String method,
 Consumer<EndpointDefinitionBuilder<JsonrpcRequest,JsonrpcResponse>> defBuilder,
 Supplier<List<Subrequest>> subroutes,
 ThrowingConsumer<Call<JsonrpcRequest,JsonrpcResponse>,Exception> handler)

Adds a rpc handler to the current builder.

Parameters:

method - the method of the handled rpc request

defBuilder - the builder for the EndpointDefinitionBuilder

subroutes - the subroutes which can be reached with this handler

handler - the handler of the request

Returns:

this

delegate

public JsonApiBuilder delegate(String method,
 Consumer<EndpointDefinitionBuilder<JsonrpcRequest,JsonrpcResponse>> defBuilder,
 ThrowingFunction<Call<JsonrpcRequest,JsonrpcResponse>,JsonrpcRequest,Exception> handler,
 Function<JsonApiBuilder,JsonApiBuilder> builder,
 Function<JsonrpcResponse,JsonrpcResponse> responseMapper,
 Supplier<List<Subrequest>> subroutes)

Delegates the handled request to another endpoint.

Parameters:

method - the method of the handled rpc request

defBuilder - the builder for the EndpointDefinitionBuilder

handler - the handler of the request which returns the delegated request

builder - the path to the builder which handles the delegated request

responseMapper - the mapper of the response

subroutes - the subroutes which can be reached with this handler

Returns:

this

delegate

public JsonApiBuilder delegate(String method,
 ThrowingFunction<Call<JsonrpcRequest,JsonrpcResponse>,JsonrpcRequest,Exception> handler,
 Function<JsonApiBuilder,JsonApiBuilder> builder,
 Supplier<List<Subrequest>> subroutes)

Delegates the handled request to another endpoint.

Parameters:

method - the method of the handled rpc request

handler - the handler of the request which returns the delegated request

builder - the path to the builder which handles the delegated request

subroutes - the subroutes which can be reached with this handler

Returns:

this

delegate

public JsonApiBuilder delegate(String method,
 Consumer<EndpointDefinitionBuilder<JsonrpcRequest,JsonrpcResponse>> defBuilder,
 ThrowingFunction<Call<JsonrpcRequest,JsonrpcResponse>,JsonrpcRequest,Exception> handler,
 Function<JsonApiBuilder,JsonApiBuilder> builder)

Delegates the handled request to another endpoint.

Parameters:

method - the method of the handled rpc request

defBuilder - the builder for the EndpointDefinitionBuilder

handler - the handler of the request which returns the delegated request

builder - the path to the builder which handles the delegated request

Returns:

this

delegate

public JsonApiBuilder delegate(String method,
 ThrowingFunction<Call<JsonrpcRequest,JsonrpcResponse>,JsonrpcRequest,Exception> handler,
 Function<JsonApiBuilder,JsonApiBuilder> builder)

Delegates the handled request to another endpoint.

Parameters:

method - the method of the handled rpc request

handler - the handler of the request which returns the delegated request

builder - the path to the builder which handles the delegated request

Returns:

this

delegate

public JsonApiBuilder delegate(String method,
 Consumer<EndpointDefinitionBuilder<JsonrpcRequest,JsonrpcResponse>> defBuilder,
 ThrowingFunction<Call<JsonrpcRequest,JsonrpcResponse>,JsonrpcRequest,Exception> handler)

Delegates the handled request to another endpoint.

Parameters:

method - the method of the handled rpc request

defBuilder - the builder for the EndpointDefinitionBuilder

handler - the handler of the request which returns the delegated request

Returns:

this

delegate

public JsonApiBuilder delegate(String method,
 ThrowingFunction<Call<JsonrpcRequest,JsonrpcResponse>,JsonrpcRequest,Exception> handler)

Delegates the handled request to another endpoint.

Parameters:

method - the method of the handled rpc request

handler - the handler of the request which returns the delegated request

Returns:

this

removeEndpoint

public JsonApiEndpoint removeEndpoint(String method)

Removes an endpoint by its method.

Parameters:

method - the method of the endpoint to remove

Returns:

the endpoint which got removed or null if no endpoint with this method exists

addBuilder

public void addBuilder(JsonApiBuilder builder)

Adds a JsonApiBuilder to the current builder. All methods are "copied" to this builder and available for both then.

Parameters:

builder - the JsonApiBuilder to add

See Also:

• removeBuilder(JsonApiBuilder)

removeBuilder

public void removeBuilder(JsonApiBuilder builder)

Removes a JsonApiBuilder and all its methods from this builder.

Parameters:

builder - the JsonApiBuilder to remove

See Also:

• addBuilder(JsonApiBuilder)

addEndpointAddedListener

public void addEndpointAddedListener(Consumer<JsonApiEndpoint> listener)

Adds a listener to call when a endpoint got added to the current builder.

Parameters:

listener - the listener to call when the event happened

removeEndpointAddedListener

public void removeEndpointAddedListener(Consumer<JsonApiEndpoint> listener)

Removes a listener which was subscribed to the endpoint added event.

Parameters:

listener - the listener to remove

addEndpointRemovedListener

public void addEndpointRemovedListener(Consumer<JsonApiEndpoint> listener)

Adds a listener to call when a endpoint got removed to the current builder.

Parameters:

listener - the listener to call when the event happened

removeEndpointRemovedListener

public void removeEndpointRemovedListener(Consumer<JsonApiEndpoint> listener)

Removes a listener which was subscribed to the endpoint removed event.

Parameters:

listener - the listener to remove

getEndpoints

public Map<String,JsonApiEndpoint> getEndpoints()

isDebug

public boolean isDebug()

setDebug

public void setDebug(boolean debug)

close

public void close()

Closes this builder.

Removes all JsonApiBuilder from this builder.

handle

public void handle(Call<JsonrpcRequest,JsonrpcResponse> call)

Handles a Call.

A Call is usually created and passed to a builder when a request from an user is called in the UI or via code directly (BackendController, WebsocketController, RestApi, ...).

Parameters:

call - the call to handle