io.dropwizard.auth

Interface Authorizer<P extends Principal>

Type Parameters:

P - the type of principals

All Known Implementing Classes:

CachingAuthorizer, ExampleAuthorizer, PermitAllAuthorizer

public interface Authorizer<P extends Principal>

An interface for classes which authorize principal objects.

Method Summary

Modifier and Type	Method and Description
boolean	authorize(P principal, String role) Deprecated. Use authorize(Principal, String, ContainerRequestContext) instead
default boolean	authorize(P principal, String role, javax.ws.rs.container.ContainerRequestContext requestContext) Decides if access is granted for the given principal in the given role.
default AuthorizationContext<P>	getAuthorizationContext(P principal, String role, javax.ws.rs.container.ContainerRequestContext requestContext) Returns an AuthorizationContext object, to be used in CachingAuthorizer as cache key.

Method Detail

authorize

@Deprecated
boolean authorize(P principal,
                              String role)

Deprecated. Use authorize(Principal, String, ContainerRequestContext) instead

Decides if access is granted for the given principal in the given role.

Parameters:

principal - a Principal object, representing a user

role - a user role

Returns:

true, if the access is granted, false otherwise

authorize

default boolean authorize(P principal,
                          String role,
                          @Nullable
                          javax.ws.rs.container.ContainerRequestContext requestContext)

Decides if access is granted for the given principal in the given role.

Parameters:

principal - a Principal object, representing a user

role - a user role

requestContext - a request context.

Returns:

true, if the access is granted, false otherwise

Since:

2.0

getAuthorizationContext

default AuthorizationContext<P> getAuthorizationContext(P principal,
                                                        String role,
                                                        @Nullable
                                                        javax.ws.rs.container.ContainerRequestContext requestContext)

Returns an AuthorizationContext object, to be used in CachingAuthorizer as cache key.

Parameters:

principal - a Principal object, representing a user

role - a user role

requestContext - a request context.

Returns:

AuthorizationContext object, to be used in CachingAuthorizer.

Since:

2.1