com.haulmont.cuba.web

Class AbstractConnection

java.lang.Object

com.haulmont.cuba.web.AbstractConnection

All Implemented Interfaces:

Connection

Direct Known Subclasses:

DefaultConnection

public abstract class AbstractConnection
extends java.lang.Object
implements Connection

Abstract class that encapsulates common connection behaviour 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.Connection

NAME

Constructor Summary

Constructors

Constructor and Description
AbstractConnection()

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.
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	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.

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, login, loginAnonymous, loginByRememberMe

Constructor Detail

AbstractConnection

public AbstractConnection()

Method Detail

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

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

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

update

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

Description copied from interface: Connection

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

Specified by:

update in interface Connection

Parameters:

session - new UserSession object

Throws:

LoginException - in case of unsuccessful update

update

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

Description copied from interface: Connection

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

Specified by:

update in interface Connection

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

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

logout

public void logout()

Description copied from interface: Connection

Log out of the system.

Specified by:

logout in interface Connection

addConnectionListener

public void addConnectionListener(ConnectionListener listener)

Description copied from interface: Connection

Add a connection listener.

Specified by:

addConnectionListener in interface Connection

Parameters:

listener - listener to add

removeConnectionListener

public void removeConnectionListener(ConnectionListener listener)

Description copied from interface: Connection

Remove a connection listener.

Specified by:

removeConnectionListener in interface Connection

Parameters:

listener - listener to remove

addSubstitutionListener

public void addSubstitutionListener(UserSubstitutionListener listener)

Description copied from interface: Connection

Add a user substitution listener.

Specified by:

addSubstitutionListener in interface Connection

Parameters:

listener - listener to add

removeSubstitutionListener

public void removeSubstitutionListener(UserSubstitutionListener listener)

Description copied from interface: Connection

Remove a user substitution listener.

Specified by:

removeSubstitutionListener in interface Connection

Parameters:

listener - listener to remove