Package se.fortnox.reactivewizard.jaxrs.response

Class ResponseDecorator

java.lang.Object

se.fortnox.reactivewizard.jaxrs.response.ResponseDecorator

public class ResponseDecorator
extends Object

Allows you to return response headers together with your result.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResponseDecorator.DecoratedResponseBuilder<T>
static class	ResponseDecorator.ResponseDecorations

Constructor Summary

Constructors

Constructor	Description
ResponseDecorator()

Method Summary

Modifier and Type	Method	Description
protected static <T> reactor.core.publisher.Flux<T>	apply(reactor.core.publisher.Flux<T> output, JaxRsResult<T> result)
static <T> ResponseDecorator.DecoratedResponseBuilder<T>	of(T value)	Creates a DecoratedResponseBuilder for the supplied Observable.
static <T> rx.Observable<T>	withHeaders(rx.Observable<T> value, Map<String,String> headers)	Use this to wrap your Observable with some headers.

Methods inherited from class java.lang.Object

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

Constructor Details

ResponseDecorator

public ResponseDecorator()

Method Details

withHeaders

@Nonnull
public static <T> rx.Observable<T> withHeaders(@Nonnull
 rx.Observable<T> value,
 @Nonnull
 Map<String,String> headers)

Use this to wrap your Observable with some headers. This must be the last decoration before returning from your resource. Any Observable operator applied after this will remove the headers.

Type Parameters:

T - is the type of value

Parameters:

value - is the response

headers - is your headers

Returns:

the value, decorated with headers.

of

@Nonnull
public static <T>
ResponseDecorator.DecoratedResponseBuilder<T> of(@Nonnull
 T value)

Creates a DecoratedResponseBuilder for the supplied Observable.

Use ResponseDecorator.DecoratedResponseBuilder.withHeaders(java.util.Map<java.lang.String, java.lang.String>) and ResponseDecorator.DecoratedResponseBuilder.withStatus(io.netty.handler.codec.http.HttpResponseStatus) to decorate your response. Use ResponseDecorator.DecoratedResponseBuilder.build() to create the decorated Observable.

This must be the last decoration before returning from your resource. Any Observable operator applied after this will remove the headers.

Example:

     ResponseDecorator.of(just("body"))
         .withHeaders(Map.of("Location", "/somewhere-else"))
         .withStatus(HttpResponseStatus.MOVED_PERMANENTLY)
         .build();
 

Type Parameters:

T - is the type of value

Parameters:

value - is the response

Returns:

DecoratedResponseBuilder<T>

apply

protected static <T> reactor.core.publisher.Flux<T> apply(@Nonnull
 reactor.core.publisher.Flux<T> output,
 @Nonnull
 JaxRsResult<T> result)