org.bonitasoft.engine.api

Interface PlatformLoginAPI

public interface PlatformLoginAPI

Manage the login on the platform.

Using this API you can obtain a PlatformSession that can be used to retreive a PlatformAPIAccessor.

PlatformSession gives access to platform APIs only:

• PlatformAPI
• PlatformCommandAPI

Author:

Matthieu Chaffotte, Baptiste Mesta, Emmanuel Duchastenier

Method Summary

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.

Method Detail

login

PlatformSession login(String userName,
                      String password)
               throws PlatformLoginException,
                      InvalidPlatformCredentialsException

Login with username and password of the platform administrator defined in bonita-platform.properties

Parameters:

userName - the platform administrator name

password - the platform administrator password

Returns:

the session created for you, can be used to retrieve platform APIs

Throws:

PlatformLoginException - occurs when an exception is thrown during login the platform

InvalidPlatformCredentialsException - occurs when thr username or password is not valid

logout

void logout(PlatformSession session)
     throws PlatformLogoutException,
            SessionNotFoundException

Logout from a platform.

Parameters:

session - the platform session to logout from.

Throws:

PlatformLogoutException - occurs when an exception is thrown during logout the platform

SessionNotFoundException - if the session is not found on the server side. This may occurs when the session has expired.