com.haulmont.cuba.portal

Interface Connection

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

PortalConnection

public interface Connection
extends java.io.Serializable

Interface to be implemented by middleware connection objects on Web Portal.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
void	addListener(ConnectionListener listener) Add a connection listener.
PortalSession	getSession() Get current user session.
boolean	isConnected() Check if the client is connected to the middleware.
void	login(java.util.Locale locale, java.lang.String ipAddress, java.lang.String clientInfo) Log in to the system with system account.
void	login(java.lang.String login, java.lang.String password, java.util.Locale locale, java.lang.String ipAddress, java.lang.String clientInfo) Log in to the system.
void	logout() Log out of the system.
void	removeListener(ConnectionListener listener) Remove a connection listener.
void	update(PortalSession session) 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,
           @Nullable
           java.lang.String ipAddress,
           @Nullable
           java.lang.String clientInfo)
    throws LoginException

Log in to the system.

Parameters:

login - user login name

password - encrypted user password

locale - user locale

ipAddress - IP address

clientInfo - Client info

Throws:

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

login

void login(java.util.Locale locale,
           @Nullable
           java.lang.String ipAddress,
           @Nullable
           java.lang.String clientInfo)
    throws LoginException

Log in to the system with system account.

Parameters:

locale - Locale

ipAddress - IP address

clientInfo - Client info

Throws:

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

logout

void logout()

Log out of the system. Returns URL to which the user will be redirected after logout.

isConnected

boolean isConnected()

Check if the client is connected to the middleware.

Returns:

true if connected

getSession

@Nullable
PortalSession getSession()

Get current user session.

Returns:

user session object or null if not connected

update

void update(PortalSession session)
     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

addListener

void addListener(ConnectionListener listener)

Add a connection listener.

Parameters:

listener - listener to add

removeListener

void removeListener(ConnectionListener listener)

Remove a connection listener.

Parameters:

listener - listener to remove