org.bonitasoft.engine.api

Interface LoginAPI

public interface LoginAPI

The LoginAPI allows to log in (and out) onto the Engine. This is a mandatory step to go further using the Engine APIs. Other Engine APIs are only accessible through the returned APISession.

Author:

Matthieu Chaffotte, Zhang Bole

See Also:

APISession

Method Summary

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.

Method Detail

login

APISession login(String userName,
                 String password)
          throws LoginException,
                 UnknownUserException

Connects the user in order to use API methods of the default tenant.

Parameters:

userName - the user name

password - the password

Returns:

the session to use with other tenant API methods

Throws:

LoginException - occurs when an exception is thrown during login

UnknownUserException - occurs when the user trying to login is unknown to the engine

login

APISession login(Map<String,Serializable> credentials)
          throws LoginException

Connects the user in order to use API methods of the default tenant.

Parameters:

credentials - the properties to use to login

Returns:

the session to use with other tenant API methods

Throws:

LoginException - occurs when an exception is thrown during login

logout

void logout(APISession session)
     throws SessionNotFoundException,
            LogoutException

Disconnects the logged user on a tenant according to the given session.

Parameters:

session - the tenant session

Throws:

SessionNotFoundException - 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 logout