com.haulmont.cuba.web

Class DefaultConnection

java.lang.Object

com.haulmont.cuba.web.AbstractConnection

com.haulmont.cuba.web.DefaultConnection

All Implemented Interfaces:

ExternallyAuthenticatedConnection, Connection

@Component(value="cuba_Connection")
 @Scope(value="prototype")
public class DefaultConnection
extends AbstractConnection
implements ExternallyAuthenticatedConnection

Default Connection implementation for web-client.

Nested Class Summary

Nested classes/interfaces inherited from interface com.haulmont.cuba.web.Connection

Connection.SessionMode, Connection.UserSessionInitEvent

Field Summary

Fields inherited from interface com.haulmont.cuba.web.auth.ExternallyAuthenticatedConnection

EXTERNAL_AUTH_USER_SESSION_ATTRIBUTE

Fields inherited from interface com.haulmont.cuba.web.Connection

NAME

Constructor Summary

Constructors

Constructor and Description
DefaultConnection()

Method Summary

Modifier and Type	Method and Description
void	login(java.lang.String login, java.lang.String password, java.util.Locale locale) Log in to the system.
void	loginAfterExternalAuthentication(java.lang.String login, java.util.Locale locale) Log in to the system after external authentication.
void	loginAnonymous(java.util.Locale locale) Log in to the system.
void	loginByRememberMe(java.lang.String login, java.lang.String rememberMeToken, java.util.Locale locale) Log in to the system.
java.lang.String	logoutExternalAuthentication() Logout from external authentication.

Methods inherited from class com.haulmont.cuba.web.AbstractConnection

addConnectionListener, addSubstitutionListener, getSession, isAlive, isAuthenticated, isConnected, logout, removeConnectionListener, removeSubstitutionListener, substituteUser, update, update

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.haulmont.cuba.web.Connection

checkRememberMe

Constructor Detail

DefaultConnection

public DefaultConnection()

Method Detail

login

public void login(java.lang.String login,
                  java.lang.String password,
                  java.util.Locale locale)
           throws LoginException

Description copied from interface: Connection

Log in to the system.

Specified by:

login in interface Connection

Parameters:

login - user login name

password - encrypted user password

locale - user locale

Throws:

LoginException - in case of unsuccessful login due to wrong credentials or other issues

loginAnonymous

public void loginAnonymous(java.util.Locale locale)
                    throws LoginException

Description copied from interface: Connection

Log in to the system.

Specified by:

loginAnonymous in interface Connection

Parameters:

locale - user locale

Throws:

LoginException - in case of unsuccessful login due to wrong credentials or other issues

loginByRememberMe

public void loginByRememberMe(java.lang.String login,
                              java.lang.String rememberMeToken,
                              java.util.Locale locale)
                       throws LoginException

Description copied from interface: Connection

Log in to the system.

Specified by:

loginByRememberMe in interface Connection

Parameters:

login - user login name

rememberMeToken - remember me token

locale - user locale

Throws:

LoginException - in case of unsuccessful login due to wrong credentials or other issues

loginAfterExternalAuthentication

public void loginAfterExternalAuthentication(java.lang.String login,
                                             java.util.Locale locale)
                                      throws LoginException

Description copied from interface: ExternallyAuthenticatedConnection

Log in to the system after external authentication.

Specified by:

loginAfterExternalAuthentication in interface ExternallyAuthenticatedConnection

Parameters:

login - user login name

locale - user locale

Throws:

LoginException - in case of unsuccessful login due to wrong credentials or other issues

logoutExternalAuthentication

public java.lang.String logoutExternalAuthentication()

Description copied from interface: ExternallyAuthenticatedConnection

Logout from external authentication.

Specified by:

logoutExternalAuthentication in interface ExternallyAuthenticatedConnection

Returns:

target url of external identity provider or null.