/** * Logout from a platform. * * @param session * the platform session to logout from. * @throws PlatformLogoutException * occurs when an exception is thrown during logout the platform * @throws SessionNotFoundException * if the session is not found on the server side. This may occurs when the session has expired. */ @NoSessionRequired void logout(PlatformSession session) throws PlatformLogoutException, SessionNotFoundException;
/** * Disconnects the logged user on a tenant according to the given session. * * @param 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. * @throws LogoutException * occurs when an exception is thrown during the logout */ @NoSessionRequired void logout(APISession session) throws SessionNotFoundException, LogoutException;
/** * Connects the user in order to use API methods of the default tenant. * * @param credentials * the properties to use to login * @return the session to use with other tenant API methods * @throws LoginException * occurs when an exception is thrown during login */ @NoSessionRequired APISession login(Map<String, Serializable> credentials) throws LoginException;
/** * Connects the user in order to use API methods of the default tenant. * * @param credentials * the properties to use to login * @return the session to use with other tenant API methods * @throws LoginException * occurs when an exception is thrown during login */ @NoSessionRequired APISession login(Map<String, Serializable> credentials) throws LoginException;
/** * Disconnects the logged user on a tenant according to the given session. * * @param 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. * @throws LogoutException * occurs when an exception is thrown during the logout */ @NoSessionRequired void logout(APISession session) throws SessionNotFoundException, LogoutException;
/** * Logout from a platform. * * @param session * the platform session to logout from. * @throws PlatformLogoutException * occurs when an exception is thrown during logout the platform * @throws SessionNotFoundException * if the session is not found on the server side. This may occurs when the session has expired. */ @NoSessionRequired void logout(PlatformSession session) throws PlatformLogoutException, SessionNotFoundException;
/** * Login with username and password of the platform administrator defined in {@code bonita-platform.properties} * * @param userName * the platform administrator name * @param password * the platform administrator password * @return * the session created for you, can be used to retrieve platform APIs * @throws PlatformLoginException * occurs when an exception is thrown during login the platform * @throws InvalidPlatformCredentialsException * occurs when thr username or password is not valid */ @NoSessionRequired PlatformSession login(String userName, String password) throws PlatformLoginException, InvalidPlatformCredentialsException;
/** * Connects the user in order to use API methods of the default tenant. * * @param userName * the user name * @param password * the password * @return the session to use with other tenant API methods * @throws LoginException * occurs when an exception is thrown during login * @throws UnknownUserException * occurs when the user trying to login is unknown to the engine */ @NoSessionRequired APISession login(String userName, String password) throws LoginException, UnknownUserException;
/** * Connects the user in order to use API methods of the default tenant. * * @param userName * the user name * @param password * the password * @return the session to use with other tenant API methods * @throws LoginException * occurs when an exception is thrown during login * @throws UnknownUserException * occurs when the user trying to login is unknown to the engine */ @NoSessionRequired APISession login(String userName, String password) throws LoginException, UnknownUserException;
/** * Login with username and password of the platform administrator defined in {@code bonita-platform.properties} * * @param userName * the platform administrator name * @param password * the platform administrator password * @return * the session created for you, can be used to retrieve platform APIs * @throws PlatformLoginException * occurs when an exception is thrown during login the platform * @throws InvalidPlatformCredentialsException * occurs when thr username or password is not valid */ @NoSessionRequired PlatformSession login(String userName, String password) throws PlatformLoginException, InvalidPlatformCredentialsException;