NoAuthResolver

All Superinterfaces:: Resolver

All Known Implementing Classes:: LocaleJSONResolver, LoginPageResolver, LoginResolver, LogoutResolver, MetadataJSONResolver, NetworkMetadataJSONResolver, PreferencesJSONResolver, PublicHtmlResolver, RegisterPageResolver, RegisterResolver, RootPageResolver, StaticResourceResolver, ThemeJSONResolver, VersionJSONResolver, WhoAmIJSONResolver

public interface NoAuthResolver extends Resolver

Special Resolver that gives responses without user authentication.

Method Summary

Modifier and Type

Method

Description

default boolean

canAccess(Request request)

Implement access control if authorization is enabled.

default boolean

requiresAuth(Request request)

Used to check if the resolver requires authentication to be used.

Optional<Response>

resolve(Request request)

Implement request resolution.

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

Method Details
- canAccess
  
  default 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
  
  Optional<Response> resolve(Request request)
  
  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
- requiresAuth
  
  default boolean requiresAuth(Request request)
  
  Description copied from interface: Resolver
  
  Used to check if the resolver requires authentication to be used.
  
  Specified by:
  
  requiresAuth in interface Resolver
  
  Parameters:
  
  request - Incoming request that you can use to figure out if authentication is required.
  
  Returns:
  
  true if you want 401 to be given when user has not logged in.