com.haulmont.cuba.web.security

Class ConnectionImpl

java.lang.Object

com.haulmont.cuba.web.security.ConnectionImpl

All Implemented Interfaces:

Connection

@Component(value="cuba_Connection")
 @Scope(value="vaadin")
public class ConnectionImpl
extends java.lang.Object
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.UserSubstitutedEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthenticationService	authenticationService
protected BackgroundWorker	backgroundWorker
protected EventHub	eventHub
protected Events	events
protected GlobalConfig	globalConfig
protected java.util.List<LoginProvider>	loginProviders
protected Messages	messages
protected java.lang.String	userRemoteAddress
protected UserSessionService	userSessionService

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(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.
protected ClientUserSession	createSession(UserSession userSession)
protected java.util.TimeZone	detectTimeZone()
protected void	fireStateChangeListeners(UserSession previousSession, UserSession newSession)
protected void	fireSubstitutionListeners()
protected java.util.List<LoginProvider>	getProviders()
UserSession	getSession() Get current user session.
protected ClientUserSession	getSessionInternal()
protected java.lang.String	getUserRemoteAddress()
protected com.vaadin.server.WebBrowser	getWebBrowserDetails()
protected void	init()
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.
protected AuthenticationDetails	loginInternal(Credentials credentials)
void	logout() Log out of the system.
protected java.lang.String	makeClientInfo()
protected void	preprocessCredentials(Credentials credentials)
protected void	publishAfterLoginEvent(Credentials credentials, AuthenticationDetails authenticationDetails)
protected void	publishBeforeLoginEvent(Credentials credentials)
protected void	publishDisconnectedEvent(UserSession previousSession)
protected void	publishLoginFailed(Credentials credentials, LoginProvider provider, LoginException e)
protected void	publishUserConnectedEvent(Credentials credentials)
protected void	publishUserSessionFinishedEvent(UserSession session)
protected void	publishUserSessionStartedEvent(Credentials credentials, AuthenticationDetails authenticationDetails)
protected void	publishUserSessionSubstitutedEvent(UserSession previousSession, UserSession session)
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.
protected void	setSessionInternal(ClientUserSession userSession)
void	substituteUser(User substitutedUser) Substitute a user in the current session with another user.

Methods inherited from class java.lang.Object

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

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

getSessionNN, login, loginAnonymous, loginByRememberMe

Field Detail

authenticationService

@Inject
protected AuthenticationService authenticationService

userSessionService

@Inject
protected UserSessionService userSessionService

loginProviders

@Inject
protected java.util.List<LoginProvider> loginProviders

events

@Inject
protected Events events

messages

@Inject
protected Messages messages

backgroundWorker

@Inject
protected BackgroundWorker backgroundWorker

globalConfig

@Inject
protected GlobalConfig globalConfig

userRemoteAddress

protected java.lang.String userRemoteAddress

eventHub

protected EventHub eventHub

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

createSession

protected ClientUserSession createSession(UserSession userSession)

preprocessCredentials

protected void preprocessCredentials(Credentials credentials)

getUserRemoteAddress

@Nullable
protected java.lang.String getUserRemoteAddress()

makeClientInfo

protected java.lang.String makeClientInfo()

detectTimeZone

protected java.util.TimeZone detectTimeZone()

getWebBrowserDetails

protected com.vaadin.server.WebBrowser getWebBrowserDetails()

loginInternal

protected AuthenticationDetails loginInternal(Credentials credentials)
                                       throws LoginException

Throws:

LoginException

fireStateChangeListeners

protected void fireStateChangeListeners(UserSession previousSession,
                                        UserSession newSession)

fireSubstitutionListeners

protected void fireSubstitutionListeners()

publishUserConnectedEvent

protected void publishUserConnectedEvent(Credentials credentials)

publishBeforeLoginEvent

protected void publishBeforeLoginEvent(Credentials credentials)
                                throws LoginException

Throws:

LoginException

publishAfterLoginEvent

protected void publishAfterLoginEvent(Credentials credentials,
                                      AuthenticationDetails authenticationDetails)

publishLoginFailed

protected void publishLoginFailed(Credentials credentials,
                                  LoginProvider provider,
                                  LoginException e)
                           throws LoginException

Throws:

LoginException

publishUserSessionStartedEvent

protected void publishUserSessionStartedEvent(Credentials credentials,
                                              AuthenticationDetails authenticationDetails)

getSessionInternal

protected ClientUserSession getSessionInternal()

setSessionInternal

protected void setSessionInternal(ClientUserSession userSession)

logout

public void logout()

Description copied from interface: Connection

Log out of the system.

Specified by:

logout in interface Connection

publishUserSessionFinishedEvent

protected void publishUserSessionFinishedEvent(UserSession session)

publishUserSessionSubstitutedEvent

protected void publishUserSessionSubstitutedEvent(UserSession previousSession,
                                                  UserSession session)

publishDisconnectedEvent

protected void publishDisconnectedEvent(UserSession previousSession)

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

getProviders

protected java.util.List<LoginProvider> getProviders()

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(java.util.function.Consumer<Connection.StateChangeEvent> 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(java.util.function.Consumer<Connection.StateChangeEvent> 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(java.util.function.Consumer<Connection.UserSubstitutedEvent> 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(java.util.function.Consumer<Connection.UserSubstitutedEvent> listener)

Description copied from interface: Connection

Remove a user substitution listener.

Specified by:

removeUserSubstitutionListener in interface Connection

Parameters:

listener - listener to remove

init

@PostConstruct
protected void init()