com.haulmont.cuba.security.app

Interface LoginService

All Known Implementing Classes:

LoginServiceBean

Deprecated.

Use AuthenticationService

@Deprecated
public interface LoginService

Service interface defining methods to login users to the middleware.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
boolean	checkRememberMe(java.lang.String login, java.lang.String rememberMeToken) Deprecated. Is not supported any more, returns false
int	getBruteForceBlockIntervalSec() Deprecated. is not supported any more
UserSession	getSession(java.util.UUID sessionId) Deprecated. use TrustedClientService.findSession(String, UUID)
UserSession	getSystemSession(java.lang.String trustedClientPassword) Deprecated. use TrustedClientService.getSystemSession(String)
boolean	isBruteForceProtectionEnabled() Deprecated. always returns false
UserSession	login(java.lang.String login, java.lang.String password, java.util.Locale locale) Deprecated. Use AuthenticationService.login(Credentials) with LoginPasswordCredentials.
UserSession	login(java.lang.String login, java.lang.String password, java.util.Locale locale, java.util.Map<java.lang.String,java.lang.Object> params) Deprecated. Use AuthenticationService.login(Credentials) with LoginPasswordCredentials.
int	loginAttemptsLeft(java.lang.String login, java.lang.String ipAddress) Deprecated. is not supported any more
UserSession	loginByRememberMe(java.lang.String login, java.lang.String rememberMeToken, java.util.Locale locale) Deprecated. Use AuthenticationService.login(Credentials) with RememberMeCredentials.
UserSession	loginByRememberMe(java.lang.String login, java.lang.String rememberMeToken, java.util.Locale locale, java.util.Map<java.lang.String,java.lang.Object> params) Deprecated. Use AuthenticationService.login(Credentials) with RememberMeCredentials.
UserSession	loginTrusted(java.lang.String login, java.lang.String password, java.util.Locale locale) Deprecated. Use AuthenticationService.login(Credentials) with TrustedClientCredentials.
UserSession	loginTrusted(java.lang.String login, java.lang.String password, java.util.Locale locale, java.util.Map<java.lang.String,java.lang.Object> params) Deprecated. Use AuthenticationService.login(Credentials) with TrustedClientCredentials.
void	logout() Deprecated. Use AuthenticationService.logout()
int	registerUnsuccessfulLogin(java.lang.String login, java.lang.String ipAddress) Deprecated. is not supported any more
UserSession	substituteUser(User substitutedUser) Deprecated. Use AuthenticationService.substituteUser(User)

Field Detail

NAME

static final java.lang.String NAME

Deprecated.

See Also:

Constant Field Values

Method Detail

logout

@Deprecated
void logout()

Deprecated. Use AuthenticationService.logout()

Log out and destroy an active user session.

substituteUser

@Deprecated
UserSession substituteUser(User substitutedUser)

Deprecated. Use AuthenticationService.substituteUser(User)

Substitute a user, obtaining all its security related environment.
This method replaces an active UserSession with the new one, which is returned.

Parameters:

substitutedUser - a user to substitute. Must be in the current users' User.getSubstitutions() list.

Returns:

new UserSession instance that contains:

• id - the previously active user session id
• user - the logged in user
• substitutedUser - the user passed to this method
• all security data - loaded for the substitutedUser

getSession

@Nullable
 @Deprecated
UserSession getSession(java.util.UUID sessionId)

Deprecated. use TrustedClientService.findSession(String, UUID)

Get a UserSession from the cache of currently active sessions.

Parameters:

sessionId - the session id

Returns:

a UserSession instance or null, if not found

getSystemSession

@Deprecated
UserSession getSystemSession(java.lang.String trustedClientPassword)
                                  throws LoginException

Deprecated. use TrustedClientService.getSystemSession(String)

Get system user session from a trusted client.
Do not call logout() for obtained user session. It is cached on middleware for multiple clients.
Do not cache system session on clients since it is not replicated in cluster.

Parameters:

trustedClientPassword - trusted client password

Returns:

created user session

Throws:

LoginException - in case of unsuccessful login

login

@Deprecated
UserSession login(java.lang.String login,
                              java.lang.String password,
                              java.util.Locale locale)
                       throws LoginException

Deprecated. Use AuthenticationService.login(Credentials) with LoginPasswordCredentials.

Log in using login and user's password.

Parameters:

login - login

password - user's encrypted password

locale - client locale

Returns:

created user session

Throws:

LoginException - in case of unsuccessful log in

login

@Deprecated
UserSession login(java.lang.String login,
                              java.lang.String password,
                              java.util.Locale locale,
                              java.util.Map<java.lang.String,java.lang.Object> params)
                       throws LoginException

Deprecated. Use AuthenticationService.login(Credentials) with LoginPasswordCredentials.

Login using user name and password

Parameters:

login - login name

password - encrypted password

locale - client locale

params - map of login parameters. Supported parameters are:

• "com.haulmont.cuba.core.global.ClientType": "WEB" or "DESKTOP". It is used to check the "cuba.gui.loginToClient" specific permission.
• "cuba.syncNewUserSessionReplication": true or false. Indicates that a new user session created on login should be sent to the cluster synchronously. Overrides the application property with the same name.

Returns:

created user session

Throws:

LoginException - in case of unsuccessful login

loginTrusted

@Deprecated
UserSession loginTrusted(java.lang.String login,
                                     java.lang.String password,
                                     java.util.Locale locale)
                              throws LoginException

Deprecated. Use AuthenticationService.login(Credentials) with TrustedClientCredentials.

Log in from a trusted client.

Parameters:

login - login

password - client's encrypted trusted password

locale - client locale

Returns:

created user session

Throws:

LoginException - in case of unsuccessful log in

loginTrusted

@Deprecated
UserSession loginTrusted(java.lang.String login,
                                     java.lang.String password,
                                     java.util.Locale locale,
                                     java.util.Map<java.lang.String,java.lang.Object> params)
                              throws LoginException

Deprecated. Use AuthenticationService.login(Credentials) with TrustedClientCredentials.

Login using user name and trusted password

Parameters:

login - login name

password - client's encrypted trusted password

locale - client locale

params - login params

Returns:

created user session

Throws:

LoginException - in case of unsuccessful login

loginByRememberMe

@Deprecated
UserSession loginByRememberMe(java.lang.String login,
                                          java.lang.String rememberMeToken,
                                          java.util.Locale locale)
                                   throws LoginException

Deprecated. Use AuthenticationService.login(Credentials) with RememberMeCredentials.

Login using user name and remember me token

Parameters:

login - login name

rememberMeToken - client's remember me token

locale - client locale

Returns:

created user session

Throws:

LoginException - in case of unsuccessful login

loginByRememberMe

@Deprecated
UserSession loginByRememberMe(java.lang.String login,
                                          java.lang.String rememberMeToken,
                                          java.util.Locale locale,
                                          java.util.Map<java.lang.String,java.lang.Object> params)
                                   throws LoginException

Deprecated. Use AuthenticationService.login(Credentials) with RememberMeCredentials.

Login using user name and remember me token

Parameters:

login - login name

rememberMeToken - client's remember me token

locale - client locale

params - login params

Returns:

created user session

Throws:

LoginException - in case of unsuccessful login

checkRememberMe

@Deprecated
boolean checkRememberMe(java.lang.String login,
                                    java.lang.String rememberMeToken)

Deprecated. Is not supported any more, returns false

Check if remember me token exists in db.

Parameters:

login - user login

rememberMeToken - remember me token

Returns:

true if remember me token exists in db

isBruteForceProtectionEnabled

@Deprecated
boolean isBruteForceProtectionEnabled()

Deprecated. always returns false

Returns:

true if the brute-force protection is enabled

getBruteForceBlockIntervalSec

@Deprecated
int getBruteForceBlockIntervalSec()

Deprecated. is not supported any more

Returns:

a time interval in seconds for which a user is blocked after a series of unsuccessful login attempts

loginAttemptsLeft

@Deprecated
int loginAttemptsLeft(java.lang.String login,
                                  java.lang.String ipAddress)

Deprecated. is not supported any more

Returns a number of login attempts left for the specified pair of login and IP-address

Parameters:

login - user login

ipAddress - user IP-address

Returns:

number of login attempts left

registerUnsuccessfulLogin

@Deprecated
int registerUnsuccessfulLogin(java.lang.String login,
                                          java.lang.String ipAddress)

Deprecated. is not supported any more

Registers unsuccessful login attempt

Parameters:

login - user login

ipAddress - user IP-address

Returns:

a number of login attempts left for the specified pair of login and IP-address