org.bonitasoft.engine.core.platform.login

Interface PlatformLoginService

All Known Implementing Classes:

PlatformLoginServiceImpl

public interface PlatformLoginService

Since:

6.0

Author:

Elias Ricken de Medeiros, Matthieu Chaffotte

Method Summary

Modifier and Type	Method and Description
boolean	isValid(long sessionId) Verify if a session is valid
SPlatformSession	login(String userName, String password) login to the platform by userName and password
void	logout(long sessionId) logout the platform by sessionId

Method Detail

login

SPlatformSession login(String userName,
                       String password)
                throws SPlatformLoginException,
                       SInvalidPlatformCredentialsException

login to the platform by userName and password

Parameters:

userName - name of user

password - password of user

Returns:

an SPlatformSession object

Throws:

SPlatformLoginException

SInvalidPlatformCredentialsException

See Also:

SPlatformSession

logout

void logout(long sessionId)
     throws SSessionNotFoundException

logout the platform by sessionId

Parameters:

sessionId - identifier of platform session

Throws:

SSessionNotFoundException

isValid

boolean isValid(long sessionId)

Verify if a session is valid

Parameters:

sessionId - identifier of platform session

Returns:

true if session is valid, false otherwise.