Class QueryJSONResolver

java.lang.Object

com.djrapitops.plan.delivery.webserver.resolver.json.query.QueryJSONResolver

All Implemented Interfaces:

AsyncResolver, Resolver

@Singleton
@Path("/v1/query")
public class QueryJSONResolver
extends Object
implements AsyncResolver

Constructor Summary

Constructors

Constructor	Description
QueryJSONResolver(QueryFilters filters, Processing processing, PlanConfig config, DBSystem dbSystem, ServerInfo serverInfo, JSONStorage jsonStorage, GraphJSONCreator graphJSONCreator, Locale locale, Formatters formatters, com.google.gson.Gson gson)

Method Summary

Modifier and Type	Method	Description
boolean	canAccess(Request request)	Implement access control if authorization is enabled.
CompletableFuture<Optional<Response>>	resolveAsync(Request request)	Implement asynchronous request resolution.

Methods inherited from class Object

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

Methods inherited from interface AsyncResolver

resolve

Methods inherited from interface Resolver

newResponseBuilder, requiresAuth, usedWebPermissions

Constructor Details

QueryJSONResolver

@Inject
public QueryJSONResolver(QueryFilters filters,
 Processing processing,
 PlanConfig config,
 DBSystem dbSystem,
 ServerInfo serverInfo,
 JSONStorage jsonStorage,
 GraphJSONCreator graphJSONCreator,
 Locale locale,
 Formatters formatters,
 com.google.gson.Gson gson)

Method Details

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 WebUser that has access permissions.

resolveAsync

@GET
public CompletableFuture<Optional<Response>> resolveAsync(Request request)

Description copied from interface: AsyncResolver

Implement asynchronous request resolution.

Specified by:

resolveAsync in interface AsyncResolver

Parameters:

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

Returns:

Future of Optional 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