com.haulmont.cuba.web

Interface Connection

All Known Implementing Classes:

AbstractConnection, DefaultConnection

public interface Connection

Interface to be implemented by objects that connect web-client to the middleware.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Connection.SessionMode
static class	Connection.UserSessionInitEvent Event that is used for additional initialization during update(UserSession, SessionMode, Consumer).

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
void	addConnectionListener(ConnectionListener listener) Add a connection listener.
void	addSubstitutionListener(UserSubstitutionListener listener) Add a user substitution listener.
default boolean	checkRememberMe(java.lang.String login, java.lang.String rememberMeToken) Deprecated.
UserSession	getSession() Get current user session.
boolean	isAlive() Check if session is alive on middleware
boolean	isAuthenticated() Check if the client was authenticated.
boolean	isConnected() Check if the client is connected to the middleware.
void	login(java.lang.String login, java.lang.String password, java.util.Locale locale) Log in to the system.
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.
void	logout() Log out of the system.
void	removeConnectionListener(ConnectionListener listener) Remove a connection listener.
void	removeSubstitutionListener(UserSubstitutionListener listener) Remove a user substitution listener.
void	substituteUser(User substitutedUser) Substitute a user in the current session with another user.
void	update(UserSession session, Connection.SessionMode sessionMode) Update internal state with the passed user session object.
void	update(UserSession session, Connection.SessionMode sessionMode, java.util.function.Consumer<Connection.UserSessionInitEvent> sessionInitializer) Update internal state with the passed user session object.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

login

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

Log in to the system.

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

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

Log in to the system.

Parameters:

locale - user locale

Throws:

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

loginByRememberMe

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

Log in to the system.

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

logout

void logout()

Log out of the system.

substituteUser

void substituteUser(User substitutedUser)

Substitute a user in the current session with another user. This method creates a new UserSession instance, but with the same session ID.

New user is usually obtained from the current user's substitution list: see User.getSubstitutions()

Parameters:

substitutedUser - new user

isConnected

boolean isConnected()

Check if the client is connected to the middleware.

Returns:

true if connected

isAuthenticated

boolean isAuthenticated()

Check if the client was authenticated.

Returns:

true if authenticated

isAlive

boolean isAlive()

Check if session is alive on middleware

Returns:

true if call to middleware performed successfully

checkRememberMe

@Deprecated
default boolean checkRememberMe(java.lang.String login,
                                            java.lang.String rememberMeToken)

Deprecated.

Check if remember me token exists in db

Parameters:

login - user login

rememberMeToken - remember me token

Returns:

true if remember me token exists in db

getSession

@Nullable
UserSession getSession()

Get current user session.

Returns:

user session object or null if not connected

update

void update(UserSession session,
            Connection.SessionMode sessionMode)
     throws LoginException

Update internal state with the passed user session object. Also fires connection listeners.

Parameters:

session - new UserSession object

Throws:

LoginException - in case of unsuccessful update

update

void update(UserSession session,
            Connection.SessionMode sessionMode,
            @Nullable
            java.util.function.Consumer<Connection.UserSessionInitEvent> sessionInitializer)
     throws LoginException

Update internal state with the passed user session object. Also fires connection listeners.

Parameters:

session - new UserSession object

sessionInitializer - optional callback that will be triggered after session setup and before triggering connection state change listeners

Throws:

LoginException - in case of unsuccessful update

addConnectionListener

void addConnectionListener(ConnectionListener listener)

Add a connection listener.

Parameters:

listener - listener to add

removeConnectionListener

void removeConnectionListener(ConnectionListener listener)

Remove a connection listener.

Parameters:

listener - listener to remove

addSubstitutionListener

void addSubstitutionListener(UserSubstitutionListener listener)

Add a user substitution listener.

Parameters:

listener - listener to add

removeSubstitutionListener

void removeSubstitutionListener(UserSubstitutionListener listener)

Remove a user substitution listener.

Parameters:

listener - listener to remove