public interface PlatformLoginAPI
Using this API you can obtain a PlatformSession
that can be used to retreive a PlatformAPIAccessor.
PlatformSession
gives access to platform APIs only:
Modifier and Type | Method and Description |
---|---|
PlatformSession |
login(String userName,
String password)
Login with username and password of the platform administrator defined in
bonita-platform.properties |
void |
logout(PlatformSession session)
Logout from a platform.
|
PlatformSession login(String userName, String password) throws PlatformLoginException, InvalidPlatformCredentialsException
bonita-platform.properties
userName
- the platform administrator namepassword
- the platform administrator passwordPlatformLoginException
- occurs when an exception is thrown during login the platformInvalidPlatformCredentialsException
- occurs when thr username or password is not validvoid logout(PlatformSession session) throws PlatformLogoutException, SessionNotFoundException
session
- the platform session to logout from.PlatformLogoutException
- occurs when an exception is thrown during logout the platformSessionNotFoundException
- if the session is not found on the server side. This may occurs when the session has expired.Copyright © 2020 Bonitasoft S.A. All rights reserved.