org.zalando.riptide.problem.ProblemRoute Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of riptide-problem Show documentation
Client side response routing
There is a newer version: 4.1.0
package org.zalando.riptide.problem;

import org.apiguardian.api.API;
import org.springframework.http.MediaType;
import org.zalando.fauxpas.ThrowingConsumer;
import org.zalando.problem.Exceptional;
import org.zalando.problem.Problem;
import org.zalando.riptide.Navigators;
import org.zalando.riptide.Route;

import static org.apiguardian.api.API.Status.STABLE;
import static org.springframework.http.MediaType.parseMediaType;
import static org.zalando.riptide.Bindings.anyContentType;
import static org.zalando.riptide.Bindings.on;
import static org.zalando.riptide.Navigators.contentType;
import static org.zalando.riptide.NoRoute.noRoute;
import static org.zalando.riptide.Route.call;
import static org.zalando.riptide.RoutingTree.dispatch;

@API(status = STABLE)
public final class ProblemRoute {

    private static final MediaType PROBLEM = parseMediaType("application/problem+json");

    /**
     * @see Zalando RESTful API Guidelines
     */
    private static final MediaType X_DOT_PROBLEM = parseMediaType("application/x.problem+json");

    /**
     * Alternative spelling for {@link #X_DOT_PROBLEM}.
     */
    private static final MediaType X_DASH_PROBLEM = parseMediaType("application/x-problem+json");

    private static final Route PROPAGATE = problemHandling(Exceptional::propagate);

    private ProblemRoute() {

    }

    /**
     * Produces a {@link Route route} that dispatches on the {@link Navigators#contentType() content type} and
     * recognises {@code application/problem+json} as well as {@code application/x-problem+json} and
     * {@code application/x.problem+json} as {@link Problem problems} and {@link Exceptional#propagate() propagates}
     * them.
     *
     * @see #problemHandling(ThrowingConsumer)
     * @see Exceptional#propagate()
     * @return static route for handling problems by propagating them as exceptions
     */
    public static Route problemHandling() {
        return PROPAGATE;
    }

    /**
     * Produces a {@link Route route} that dispatches on the {@link Navigators#contentType() content type} and
     * recognises {@code application/problem+json} as well as {@code application/x-problem+json} and
     * {@code application/x.problem+json} as {@link Problem problems} and handles them given the supplied consumer.
     *
     * @param consumer the exception handler
     * @return a route for handling problems dynamically
     */
    public static Route problemHandling(final ThrowingConsumer consumer) {
        return problemHandling(consumer, noRoute());
    }

    /**
     * Produces a {@link Route route} that dispatches on the {@link Navigators#contentType() content type} and
     * recognises {@code application/problem+json} as well as {@code application/x-problem+json} and
     * {@code application/x.problem+json} as {@link Problem problems} and {@link Exceptional#propagate() propagates}
     * them. The given fallback will be used if none of the mentioned content types matches.
     *
     * @param fallback the fallback route
     * @return a route for handling problems dynamically
     */
    public static Route problemHandling(final Route fallback) {
        return problemHandling(Exceptional::propagate, fallback);
    }

    /**
     * Produces a {@link Route route} that dispatches on the {@link Navigators#contentType() content type} and
     * recognises {@code application/problem+json} as well as {@code application/x-problem+json} and
     * {@code application/x.problem+json} as {@link Problem problems} and handles them given the supplied consumer.
     * The given fallback will be used if none of the mentioned content types matches.
     *
     * @param consumer the exception handler
     * @param fallback the fallback route
     * @return a route for handling problems dynamically
     */
    public static Route problemHandling(final ThrowingConsumer consumer,
            final Route fallback) {

        final Route route = call(Exceptional.class, consumer);

        return dispatch(contentType(),
                on(PROBLEM).call(route),
                on(X_DOT_PROBLEM).call(route),
                on(X_DASH_PROBLEM).call(route),
                anyContentType().call(fallback));
    }

}