Package com.djrapitops.plan.delivery.webserver.resolver.swagger

Class SwaggerPageResolver

java.lang.Object

com.djrapitops.plan.delivery.webserver.resolver.swagger.SwaggerPageResolver

All Implemented Interfaces:

Resolver

@Singleton
public class SwaggerPageResolver
extends Object
implements Resolver

Constructor Summary

Constructors

Constructor	Description
SwaggerPageResolver(ResponseFactory responseFactory)

Method Summary

Modifier and Type	Method	Description
boolean	canAccess(Request request)	Implement access control if authorization is enabled.
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, requiresAuth

Constructor Details

SwaggerPageResolver

@Inject
public SwaggerPageResolver(ResponseFactory responseFactory)

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.

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