Package com.djrapitops.plan.delivery.web

Interface ResolverService

public interface ResolverService

Service for modifying webserver request resolution.

It is recommended to use plugin based namespace in your custom targets, eg. "/flyplugin/flying" to avoid collisions with other plugins. You can also use getResolver(String) to check if target already has a resolver.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ResolverService.Holder

Method Summary

Modifier and Type	Method	Description
static ResolverService	getInstance()
Optional<Resolver>	getResolver(String target)	Obtain a Resolver for a target.
List<Resolver>	getResolvers(String target)	Obtain all Resolvers that match the target.
void	registerResolver(String pluginName, String start, Resolver resolver)	Register a new resolver.
void	registerResolverForMatches(String pluginName, Pattern pattern, Resolver resolver)	Register a new resolver with regex that matches start of target.

Method Details

getInstance

static ResolverService getInstance()

registerResolver

void registerResolver(String pluginName,
 String start,
 Resolver resolver)

Register a new resolver.

Parameters:

pluginName - Name of the plugin that is registering (For error messages)

start - Start of the target to match against, eg "/example" will send "/example/target" etc to the Resolver.

resolver - Resolver to use for this

Throws:

IllegalArgumentException - If pluginName is null or empty.

registerResolverForMatches

void registerResolverForMatches(String pluginName,
 Pattern pattern,
 Resolver resolver)

Register a new resolver with regex that matches start of target.

NOTICE: It is recommended to avoid too generic regex like "/.*" to not override existing resolvers.

Parameters (?param=value) are not included in the regex matching.

Parameters:

pluginName - Name of the plugin that is registering (For error messages)

pattern - Regex Pattern, "/example.*" will send "/exampletarget" etc to the Resolver.

resolver - Resolver to use for this.

Throws:

IllegalArgumentException - If pluginName is null or empty.

getResolver

Optional<Resolver> getResolver(String target)

Obtain a Resolver for a target.

First matching resolver will be returned. registerResolver(java.lang.String, java.lang.String, com.djrapitops.plan.delivery.web.resolver.Resolver) resolvers have higher priority than registerResolverForMatches(java.lang.String, java.util.regex.Pattern, com.djrapitops.plan.delivery.web.resolver.Resolver).

Can be used when making Resolver middleware.

Parameters:

target - "/example/target"

Returns:

Resolver if registered or empty.

getResolvers

List<Resolver> getResolvers(String target)

Obtain all Resolvers that match the target.

If first returns Optional.empty next one should be used.

Requires Capability PAGE_EXTENSION_RESOLVERS_LIST.

Parameters:

target - "/example/target"

Returns:

List of Resolvers if registered or empty list.