org.craftercms.studio.api.v2.service.security

Interface AuthenticationProvider

All Known Implementing Classes:

BaseAuthenticationProvider, DbAuthenticationProvider, HeadersAuthenticationProvider, LdapAuthenticationProvider

public interface AuthenticationProvider

Authentication Provider

Method Summary

Modifier and Type	Method and Description
boolean	doAuthenticate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, AuthenticationChain authenticationChain, String username, String password) Execute authentication for given username and password
boolean	isEnabled() Check if authentication provider is enabled
void	setEnabled(boolean enabled) Enable or disable authentication provider

Method Detail

doAuthenticate

boolean doAuthenticate(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response,
                       AuthenticationChain authenticationChain,
                       String username,
                       String password)
                throws AuthenticationSystemException,
                       BadCredentialsException,
                       UserNotFoundException

Execute authentication for given username and password

Parameters:

request - HTTP Request

response - HTTP Response

authenticationChain - Authentication chain

username - username to authenticate

password - password

Returns:

true if success, otherwise false

Throws:

AuthenticationSystemException - general authentication system error

BadCredentialsException - given credentials are bad

UserNotFoundException - username not found in the list of active users

isEnabled

boolean isEnabled()

Check if authentication provider is enabled

Returns:

true if authentication provider is enabled, otherwise false

setEnabled

void setEnabled(boolean enabled)

Enable or disable authentication provider

Parameters:

enabled - true to enable, false to disable