Package org.springframework.hateoas.server.reactive

Class WebFluxLinkBuilder

java.lang.Object

org.springframework.hateoas.server.core.LinkBuilderSupport<T>

org.springframework.hateoas.server.core.TemplateVariableAwareLinkBuilderSupport<WebFluxLinkBuilder>

org.springframework.hateoas.server.reactive.WebFluxLinkBuilder

All Implemented Interfaces:

LinkBuilder

public class WebFluxLinkBuilder
extends TemplateVariableAwareLinkBuilderSupport<WebFluxLinkBuilder>

Utility for building reactive Links.

Since:

1.0

Author:

Greg Turnquist, Oliver Drotbohm

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebFluxLinkBuilder.WebFluxBuilder
static class	WebFluxLinkBuilder.WebFluxLink	Intermediate representation of a Link within a reactive pipeline to easily add Affordances from method invocations.

Method Summary

Modifier and Type	Method	Description
protected WebFluxLinkBuilder	createNewInstance(UriComponents components, List<Affordance> affordances, TemplateVariables variables)
protected WebFluxLinkBuilder	getThis()	Returns the current concrete instance.
static WebFluxLinkBuilder.WebFluxBuilder	linkTo(Object invocation)	Create a WebFluxLinkBuilder by checking if the Reactor Context contains a ServerWebExchange and using that combined with the Spring Web annotations to build a full URI.
static WebFluxLinkBuilder.WebFluxBuilder	linkTo(Object invocation, ServerWebExchange exchange)	Create a WebFluxLinkBuilder using an explicitly defined ServerWebExchange.
static <T> T	methodOn(Class<T> controller, Object... parameters)	Wrapper for DummyInvocationUtils.methodOn(Class, Object...) to be available in case you work with static imports of WebFluxLinkBuilder.

Methods inherited from class org.springframework.hateoas.server.core.TemplateVariableAwareLinkBuilderSupport

createNewInstance, toString

Methods inherited from class org.springframework.hateoas.server.core.LinkBuilderSupport

addAffordances, getAffordances, slash, slash, toUri, withRel, withSelfRel

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.hateoas.server.LinkBuilder

withRel

Method Details

linkTo

public static WebFluxLinkBuilder.WebFluxBuilder linkTo(Object invocation)

Create a WebFluxLinkBuilder by checking if the Reactor Context contains a ServerWebExchange and using that combined with the Spring Web annotations to build a full URI. If there is no exchange, then fall back to relative URIs. Usually used with methodOn(Class, Object...) to refer to a method invocation.

Parameters:

invocation - must not be null.

See Also:

• methodOn(Class, Object...)

linkTo

public static WebFluxLinkBuilder.WebFluxBuilder linkTo(Object invocation,
 ServerWebExchange exchange)

Create a WebFluxLinkBuilder using an explicitly defined ServerWebExchange. This is possible if your WebFlux method includes the exchange and you want to pass it straight in.

Parameters:

invocation - must not be null.

exchange - must not be null.

methodOn

public static <T> T methodOn(Class<T> controller,
 Object... parameters)

Wrapper for DummyInvocationUtils.methodOn(Class, Object...) to be available in case you work with static imports of WebFluxLinkBuilder.

Parameters:

controller - must not be null.

parameters - parameters to extend template variables in the type level mapping.

Returns:

createNewInstance

protected WebFluxLinkBuilder createNewInstance(UriComponents components,
 List<Affordance> affordances,
 TemplateVariables variables)

Specified by:

createNewInstance in class TemplateVariableAwareLinkBuilderSupport<WebFluxLinkBuilder>

getThis

protected WebFluxLinkBuilder getThis()

Description copied from class: LinkBuilderSupport

Returns the current concrete instance.

Specified by:

getThis in class LinkBuilderSupport<WebFluxLinkBuilder>

Returns: