Package com.djrapitops.plan.delivery.web.resolver

Class CompositeResolver

java.lang.Object

com.djrapitops.plan.delivery.web.resolver.CompositeResolver

All Implemented Interfaces:

Resolver

public final class CompositeResolver
extends Object
implements Resolver

Utility Resolver for organizing resolution in a tree-like structure.

CompositeResolver removes first part of the target with URIPath.omitFirst() before calling the child Resolvers.

Example: resolverService.registerResolver("/test/", compositeResolver); The Resolvers added to CompositeResolver will be given Request with URIPath "/".

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CompositeResolver.Builder

Method Summary

Modifier and Type	Method	Description
static CompositeResolver.Builder	builder()
boolean	canAccess(Request request)	Implement access control if authorization is enabled.
boolean	requiresAuth(Request request)
Optional<Response>	resolve(Request request)	Implement request resolution.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.djrapitops.plan.delivery.web.resolver.Resolver

newResponseBuilder

Method Details

builder

public static CompositeResolver.Builder builder()

canAccess

public boolean canAccess(Request request)

Description copied from interface: Resolver

Implement access control if authorization is enabled.

Is not called when access control is not active.

Specified by:

canAccess in interface Resolver

Parameters:

request - HTTP request, contains all information necessary to check access.

Returns:

true if allowed or invalid target, false if response should be 403 (forbidden)

See Also:

for that has access permissions.

resolve

public Optional<Response> resolve(Request request)

Description copied from interface: Resolver

Implement request resolution.

Specified by:

resolve in interface Resolver

Parameters:

request - HTTP request, contains all information necessary to resolve the request.

Returns:

Response or empty if the response should be 404 (not found).

See Also:

for return value, for path /example/path etc, for parameters ?param=value etc

requiresAuth

public boolean requiresAuth(Request request)

Specified by:

requiresAuth in interface Resolver