com.haulmont.cuba.web

Interface Connection

All Known Implementing Classes:

ConnectionImpl, TestConnection

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.StateChangeEvent
static class	Connection.UserSubstitutedEvent

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
void	addStateChangeListener(java.util.function.Consumer<Connection.StateChangeEvent> listener) Add a connection listener.
void	addUserSubstitutionListener(java.util.function.Consumer<Connection.UserSubstitutedEvent> listener) Add a user substitution listener.
UserSession	getSession() Get current user session.
default UserSession	getSessionNN() 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(Credentials credentials) Authenticates a user, starts session and changes state of the connection.
default void	login(java.lang.String login, java.lang.String password, java.util.Locale locale) Deprecated.
default void	loginAnonymous(java.util.Locale locale) Deprecated.
default void	loginByRememberMe(java.lang.String login, java.lang.String rememberMeToken, java.util.Locale locale) Deprecated.
void	logout() Log out of the system.
void	removeStateChangeListener(java.util.function.Consumer<Connection.StateChangeEvent> listener) Remove a connection listener.
void	removeUserSubstitutionListener(java.util.function.Consumer<Connection.UserSubstitutedEvent> listener) Remove a user substitution listener.
void	substituteUser(User substitutedUser) Substitute a user in the current session with another user.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

login

void login(Credentials credentials)
    throws LoginException

Authenticates a user, starts session and changes state of the connection.

Parameters:

credentials - credentials

Throws:

LoginException - if authentication fails

logout

void logout()

Log out of the system.

getSession

@Nullable
UserSession getSession()

Get current user session.

Returns:

user session object or null if not connected

getSessionNN

@Nonnull
default UserSession getSessionNN()

Get current user session.

Returns:

user session object or null if not connected

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

addStateChangeListener

void addStateChangeListener(java.util.function.Consumer<Connection.StateChangeEvent> listener)

Add a connection listener.

Parameters:

listener - listener to add

removeStateChangeListener

void removeStateChangeListener(java.util.function.Consumer<Connection.StateChangeEvent> listener)

Remove a connection listener.

Parameters:

listener - listener to remove

addUserSubstitutionListener

void addUserSubstitutionListener(java.util.function.Consumer<Connection.UserSubstitutedEvent> listener)

Add a user substitution listener.

Parameters:

listener - listener to add

removeUserSubstitutionListener

void removeUserSubstitutionListener(java.util.function.Consumer<Connection.UserSubstitutedEvent> listener)

Remove a user substitution listener.

Parameters:

listener - listener to remove

login

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

Deprecated.

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

@Deprecated
default void loginAnonymous(java.util.Locale locale)
                                 throws LoginException

Deprecated.

Log in to the system.

Parameters:

locale - user locale

Throws:

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

loginByRememberMe

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

Deprecated.

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