com.haulmont.cuba.web.auth

Interface CubaAuthProvider

All Superinterfaces:

javax.servlet.Filter

All Known Implementing Classes:

IdpAuthProvider, LdapAuthProvider, NoOpAuthProvider

Deprecated.

Use LoginProvider and/or HttpRequestFilter instead.

@Deprecated
public interface CubaAuthProvider
extends javax.servlet.Filter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME Deprecated.

Method Summary

Modifier and Type	Method and Description
void	authenticate(java.lang.String login, java.lang.String password, java.util.Locale messagesLocale) Deprecated. Use LoginProvider instead.
default java.lang.String	logout() Deprecated. Use application event handler for AppLoggedOutEvent instead.
default void	pingUserSession(UserSession userSession) Deprecated. Use application event handler for SessionHeartbeatEvent instead.
default void	userSessionLoggedIn(UserSession userSession) Deprecated. Use application event handler for UserConnectedEvent instead.

Methods inherited from interface javax.servlet.Filter

destroy, doFilter, init

Field Detail

NAME

static final java.lang.String NAME

Deprecated.

See Also:

Constant Field Values

Method Detail

authenticate

@Deprecated
void authenticate(java.lang.String login,
                              java.lang.String password,
                              java.util.Locale messagesLocale)
                       throws LoginException

Deprecated. Use LoginProvider instead.

Login procedure with user and password.

Parameters:

login - User login

password - User password

messagesLocale - Locale for error messages

Throws:

LoginException - Login exception

logout

@Nullable
 @Deprecated
default java.lang.String logout()

Deprecated. Use application event handler for AppLoggedOutEvent instead.

Logout from external authentication

Returns:

target url of external identity provider or null

userSessionLoggedIn

default void userSessionLoggedIn(UserSession userSession)

Deprecated. Use application event handler for UserConnectedEvent instead.

Handler for user session logged in event. Called by application UI tier when CUBA user session is created. Triggered after standard session initialization, right before UI initialization.

Parameters:

userSession - user session

pingUserSession

default void pingUserSession(UserSession userSession)

Deprecated. Use application event handler for SessionHeartbeatEvent instead.

Send ping to identity provider if supported by auth provider.

Parameters:

userSession - user session