Package org.restheart.plugins

Interface Service<R extends ServiceRequest<?>,S extends ServiceResponse<?>>

Type Parameters:

R - Request the request type

S - Response the response type

All Superinterfaces:

ConfigurablePlugin, CORSHeaders, ExchangeTypeResolver<R,S>, HandlingPlugin<R,S>, Plugin

All Known Subinterfaces:

BsonService, ByteArrayService, JsonService, StringService

public interface Service<R extends ServiceRequest<?>,S extends ServiceResponse<?>>
extends HandlingPlugin<R,S>, ConfigurablePlugin, CORSHeaders

Services allow to extend the API adding web services

Author:

Andrea Di Cesare <andrea@softinstigate.com>

Field Summary

Fields inherited from interface org.restheart.exchange.CORSHeaders

ACCESS_CONTROL_ALLOW_CREDENTIAL, ACCESS_CONTROL_ALLOW_HEADERS, ACCESS_CONTROL_ALLOW_METHODS, ACCESS_CONTROL_ALLOW_ORIGIN, ACCESS_CONTROL_EXPOSE_HEADERS, DEFAULT_ACCESS_CONTROL_ALLOW_CREDENTIALS, DEFAULT_ACCESS_CONTROL_ALLOW_HEADERS, DEFAULT_ACCESS_CONTROL_ALLOW_METHODS, DEFAULT_ACCESS_CONTROL_ALLOW_ORIGIN, DEFAULT_ACCESS_CONTROL_EXPOSE_HEADERS

Method Summary

Modifier and Type	Method	Description
default BiConsumer<R,S>	handle()	BiConsumer that handles the request Allows to provide the handlig logic with functional style
default void	handle(R request, S response)	handles the request the handling logic can also be provided overriding handle()
default BiConsumer<R,S>	handleOptions()	helper BiConsumer to handle OPTIONS requests
default void	handleOptions(R request)	helper method to handle OPTIONS requests
Function<io.undertow.server.HttpServerExchange,R>	request()
Consumer<io.undertow.server.HttpServerExchange>	requestInitializer()
Function<io.undertow.server.HttpServerExchange,S>	response()
Consumer<io.undertow.server.HttpServerExchange>	responseInitializer()

Methods inherited from interface org.restheart.plugins.ConfigurablePlugin

arg, argOrDefault

Methods inherited from interface org.restheart.exchange.CORSHeaders

accessControlAllowCredentials, accessControlAllowHeaders, accessControlAllowMethods, accessControlAllowOrigin, accessControlExposeHeaders

Methods inherited from interface org.restheart.plugins.ExchangeTypeResolver

requestType, responseType

Method Details

handle

default void handle(R request,
 S response)
             throws Exception

handles the request the handling logic can also be provided overriding handle()

Parameters:

request -

response -

Throws:

Exception

handle

default BiConsumer<R,S> handle()
                        throws Exception

BiConsumer that handles the request Allows to provide the handlig logic with functional style

Returns:

the BiConsumer that handles the request

Throws:

Exception

requestInitializer

Consumer<io.undertow.server.HttpServerExchange> requestInitializer()

Returns:

the Consumer used to instantiate the request object

responseInitializer

Consumer<io.undertow.server.HttpServerExchange> responseInitializer()

Returns:

the Consumer used to instantiate the response object

request

Function<io.undertow.server.HttpServerExchange,R> request()

Returns:

the Function used to retrieve the request object

response

Function<io.undertow.server.HttpServerExchange,S> response()

Returns:

the Function used to retrieve the response object

handleOptions

default void handleOptions(R request)

helper method to handle OPTIONS requests

Parameters:

request -

Throws:

Exception

handleOptions

default BiConsumer<R,S> handleOptions()

helper BiConsumer to handle OPTIONS requests

Parameters:

request -

Throws:

Exception