com.haulmont.cuba.portal.sys

Class PortalConnection

java.lang.Object

com.haulmont.cuba.portal.sys.PortalConnection

All Implemented Interfaces:

Connection, java.io.Serializable

public class PortalConnection
extends java.lang.Object
implements Connection

See Also:

Serialized Form

Field Summary

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

NAME

Constructor Summary

Constructors

Constructor and Description
PortalConnection()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

PortalConnection

public PortalConnection()

Method Detail

login

public 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

Description copied from interface: Connection

Log in to the system.

Specified by:

login in interface Connection

Parameters:

login - user login name

password - encrypted user password

locale - user locale

ipAddress - IP address

clientInfo - Client info

Throws:

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

login

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

Description copied from interface: Connection

Log in to the system with system account.

Specified by:

login in interface Connection

Parameters:

locale - Locale

ipAddress - IP address

clientInfo - Client info

Throws:

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

logout

public void logout()

Description copied from interface: Connection

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

Specified by:

logout in interface Connection

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

getSession

public PortalSession 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

update

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

addListener

public void addListener(ConnectionListener listener)

Description copied from interface: Connection

Add a connection listener.

Specified by:

addListener in interface Connection

Parameters:

listener - listener to add

removeListener

public void removeListener(ConnectionListener listener)

Description copied from interface: Connection

Remove a connection listener.

Specified by:

removeListener in interface Connection

Parameters:

listener - listener to remove