Package org.logdoc.fairhttp.service.api.helpers

Class Route

java.lang.Object

org.logdoc.fairhttp.service.api.helpers.Route

public class Route
extends Object

Author:

Denis Danilin | me@loslobos.ru 01.03.2023 14:27 FairHttpService ☭ sweat and blood

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Route.Method

Field Summary

Fields

Modifier and Type	Field	Description
Response	breakWithResponse
BiFunction<Request,Map<String,String>,?>	callback
String	endpoint
boolean	indirect
String	method

Method Summary

Modifier and Type	Method	Description
static Route	async(String method, String endpoint, BiFunction<Request,Map<String,String>,CompletionStage<Response>> callback)
static Route	async(Route.Method method, String endpoint, BiFunction<Request,Map<String,String>,CompletionStage<Response>> callback)
Route	breakIf(BiFunction<Request,Map<String,String>,Boolean> breakIfPredicate, Response breakWithResponse)	Adds condition with when successfully applied may interrupt request with given response, before any call is made to business logic
boolean	shouldBreak(Request request, Map<String,String> pathMap)
static Route	sync(String method, String endpoint, BiFunction<Request,Map<String,String>,Response> callback)
static Route	sync(Route.Method method, String endpoint, BiFunction<Request,Map<String,String>,Response> callback)

Methods inherited from class java.lang.Object

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

Field Detail

method

public final String method

endpoint

public final String endpoint

indirect

public final boolean indirect

callback

public final BiFunction<Request,Map<String,String>,?> callback

breakWithResponse

public Response breakWithResponse

Method Detail

async

public static Route async(String method,
                          String endpoint,
                          BiFunction<Request,Map<String,String>,CompletionStage<Response>> callback)

Parameters:

method - HTTP method (GET, POST, PUT, etc)

endpoint - Fully qualified endpoint. If its patterned - it must be Java RegEx synthax compliant and groups must be correctly mappable to callback arguments

callback - invocation of request with mapped path variables by names given in pathVarsNames

sync

public static Route sync(String method,
                         String endpoint,
                         BiFunction<Request,Map<String,String>,Response> callback)

Parameters:

method - HTTP method (GET, POST, PUT, etc)

endpoint - Fully qualified endpoint. If its patterned - it must be Java RegEx synthax compliant and groups must be correctly mappable to callback arguments

callback - invocation of request with mapped path variables by names given in pathVarsNames

async

public static Route async(Route.Method method,
                          String endpoint,
                          BiFunction<Request,Map<String,String>,CompletionStage<Response>> callback)

Parameters:

method - HTTP method (GET, POST, PUT, etc)

endpoint - Fully qualified endpoint. If its patterned - it must be Java RegEx synthax compliant and groups must be correctly mappable to callback arguments

callback - invocation of request with mapped path variables by names given in pathVarsNames

sync

public static Route sync(Route.Method method,
                         String endpoint,
                         BiFunction<Request,Map<String,String>,Response> callback)

Parameters:

method - HTTP method (GET, POST, PUT, etc)

endpoint - Fully qualified endpoint. If its patterned - it must be Java RegEx synthax compliant and groups must be correctly mappable to callback arguments

callback - invocation of request with mapped path variables by names given in pathVarsNames

breakIf

public Route breakIf(BiFunction<Request,Map<String,String>,Boolean> breakIfPredicate,
                     Response breakWithResponse)

Adds condition with when successfully applied may interrupt request with given response, before any call is made to business logic

Parameters:

breakIfPredicate - predicate to be applied

breakWithResponse - response to be used if condition is true

Returns:

route itself

shouldBreak

public boolean shouldBreak(Request request,
                           Map<String,String> pathMap)