com.haulmont.cuba.web.security

Class ConnectionImpl

java.lang.Object

com.haulmont.bali.events.EventRouter

com.haulmont.cuba.web.security.ConnectionImpl

All Implemented Interfaces:

ExternallyAuthenticatedConnection, Connection

@Component(value="cuba_Connection")
 @Scope(value="vaadin")
public class ConnectionImpl
extends EventRouter
implements Connection

Default Connection implementation for web-client.

Nested Class Summary

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

Connection.StateChangeEvent, Connection.StateChangeListener, Connection.UserSubstitutedEvent, Connection.UserSubstitutionListener

Field Summary

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

NAME

Constructor Summary

Constructors

Constructor and Description
ConnectionImpl()

Method Summary

Modifier and Type	Method and Description
void	addStateChangeListener(Connection.StateChangeListener listener) Add a connection listener.
void	addUserSubstitutionListener(Connection.UserSubstitutionListener listener) Add a user substitution listener.
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(Credentials credentials) Authenticates a user, starts session and changes state of the connection.
void	logout() Log out of the system.
void	removeStateChangeListener(Connection.StateChangeListener listener) Remove a connection listener.
void	removeUserSubstitutionListener(Connection.UserSubstitutionListener listener) Remove a user substitution listener.
void	substituteUser(User substitutedUser) Substitute a user in the current session with another user.

Methods inherited from class com.haulmont.bali.events.EventRouter

addListener, addListener, fireEvent, hasListeners, removeListener, removeListener, removeListeners

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

getSessionNN, login, loginAnonymous, loginByRememberMe

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

loginAfterExternalAuthentication, logoutExternalAuthentication

Constructor Detail

ConnectionImpl

public ConnectionImpl()

Method Detail

login

public void login(Credentials credentials)
           throws LoginException

Description copied from interface: Connection

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

Specified by:

login in interface Connection

Parameters:

credentials - credentials

Throws:

LoginException - if authentication fails

logout

public void logout()

Description copied from interface: Connection

Log out of the system.

Specified by:

logout in interface Connection

getSession

@Nullable
public UserSession getSession()

Description copied from interface: Connection

Get current user session.

Specified by:

getSession in interface Connection

Returns:

user session object or null if not connected

substituteUser

public void substituteUser(User substitutedUser)

Description copied from interface: Connection

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()

Specified by:

substituteUser in interface Connection

Parameters:

substitutedUser - new user

isConnected

public boolean isConnected()

Description copied from interface: Connection

Check if the client is connected to the middleware.

Specified by:

isConnected in interface Connection

Returns:

true if connected

isAuthenticated

public boolean isAuthenticated()

Description copied from interface: Connection

Check if the client was authenticated.

Specified by:

isAuthenticated in interface Connection

Returns:

true if authenticated

isAlive

public boolean isAlive()

Description copied from interface: Connection

Check if session is alive on middleware

Specified by:

isAlive in interface Connection

Returns:

true if call to middleware performed successfully

addStateChangeListener

public void addStateChangeListener(Connection.StateChangeListener listener)

Description copied from interface: Connection

Add a connection listener.

Specified by:

addStateChangeListener in interface Connection

Parameters:

listener - listener to add

removeStateChangeListener

public void removeStateChangeListener(Connection.StateChangeListener listener)

Description copied from interface: Connection

Remove a connection listener.

Specified by:

removeStateChangeListener in interface Connection

Parameters:

listener - listener to remove

addUserSubstitutionListener

public void addUserSubstitutionListener(Connection.UserSubstitutionListener listener)

Description copied from interface: Connection

Add a user substitution listener.

Specified by:

addUserSubstitutionListener in interface Connection

Parameters:

listener - listener to add

removeUserSubstitutionListener

public void removeUserSubstitutionListener(Connection.UserSubstitutionListener listener)

Description copied from interface: Connection

Remove a user substitution listener.

Specified by:

removeUserSubstitutionListener in interface Connection

Parameters:

listener - listener to remove