public interface LoginAPI
APISession
Modifier and Type | Method and Description |
---|---|
APISession |
login(Map<String,Serializable> credentials)
Connects the user in order to use API methods of the default tenant.
|
APISession |
login(String userName,
String password)
Connects the user in order to use API methods of the default tenant.
|
void |
logout(APISession session)
Disconnects the logged user on a tenant according to the given session.
|
APISession login(String userName, String password) throws LoginException, UnknownUserException
userName
- the user namepassword
- the passwordLoginException
- occurs when an exception is thrown during loginUnknownUserException
- occurs when the user trying to login is unknown to the engineAPISession login(Map<String,Serializable> credentials) throws LoginException
credentials
- the properties to use to loginLoginException
- occurs when an exception is thrown during loginvoid logout(APISession session) throws SessionNotFoundException, LogoutException
session
- the tenant sessionSessionNotFoundException
- if the given session is not found on the server side. This may occurs when the session has expired.LogoutException
- occurs when an exception is thrown during the logoutCopyright © 2018 Bonitasoft S.A.. All rights reserved.