io.cdap.http

Interface AuthHandler

public interface AuthHandler

Basic interface for implementing an AuthHandler.

Method Summary

Modifier and Type	Method and Description
String	getWWWAuthenticateHeader() Returns the value for the WWW-Authenticate header field that will be set for requests which were rejected by isAuthenticated(HttpRequest) or hasRoles(HttpRequest, String[]).
boolean	hasRoles(io.netty.handler.codec.http.HttpRequest request, String[] roles) This method is responsible for deciding whether a request meets the role requirement.
boolean	isAuthenticated(io.netty.handler.codec.http.HttpRequest request) This method is responsible for deciding whether a request is authenticated.

Method Detail

isAuthenticated

boolean isAuthenticated(io.netty.handler.codec.http.HttpRequest request)

This method is responsible for deciding whether a request is authenticated.

Parameters:

request - the HttpRequest in question.

Returns:

true if this request should be handled.

See Also:

Secured

hasRoles

boolean hasRoles(io.netty.handler.codec.http.HttpRequest request,
                 String[] roles)

This method is responsible for deciding whether a request meets the role requirement.

Parameters:

request - the HttpRequest in question.

roles - the roles that are required for this request to be handled.

Returns:

true if this request should be handled.

See Also:

RequiredRoles

getWWWAuthenticateHeader

String getWWWAuthenticateHeader()

Returns the value for the WWW-Authenticate header field that will be set for requests which were rejected by isAuthenticated(HttpRequest) or hasRoles(HttpRequest, String[]).

Returns:

value of the WWW-Authenticate header field