Constructor and Description |
---|
APIClient() |
APIClient(APISession session) |
Modifier and Type | Method and Description |
---|---|
IdentityAPI |
getIdentityAPI()
Get API to manage the organization, i.e., users, groups and roles.
|
LogAPI |
getLogAPI()
Get API to read logs stored in database to track actions made by users.
|
protected LoginAPI |
getLoginAPI() |
MonitoringAPI |
getMonitoringAPI()
Get API to monitor tenant resources consumption.
|
ProcessAPI |
getProcessAPI()
Get API to manage the business processes.
|
ProfileAPI |
getProfileAPI()
Get API to manage portal user profiles.
|
ReportingAPI |
getReportingAPI()
Get API to manage reporting capabilities.
|
TenantAdministrationAPI |
getTenantAdministrationAPI()
Get the API to manage tenant administration tasks.
|
ThemeAPI |
getThemeAPI()
Get API to manage themes (Portal and mobile).
|
void |
login(long tenantId,
Map<String,Serializable> credentials)
Connects a user, identified by credentials, in order to use API methods of a tenant.
|
void |
login(long tenantId,
String username,
String password)
Connects a user, identified by his (her) username and password, in order to use API methods of a tenant.
|
getAPI, getBusinessDataAPI, getCommandAPI, getCustomPageAPI, getDAO, getLivingApplicationAPI, getLoginAPI, getPermissionAPI, getSession, loadClass, login, logout
public APIClient()
public APIClient(APISession session)
protected LoginAPI getLoginAPI()
getLoginAPI
in class APIClient
public void login(long tenantId, String username, String password) throws LoginException
tenantId
- the tenant identifierusername
- the user namepassword
- the passwordLoginException
- occurs when an exception is thrown during the login (userName does not exist, or couple (userName, password) is incorrect)public void login(long tenantId, Map<String,Serializable> credentials) throws LoginException
tenantId
- the tenant identifiercredentials
- the credentials to login with. Can be username / password couple, SSO ticket, ... depending on the implementation.LoginException
- occurs when an exception is thrown during the login (userName does not exist, or couple (userName, password) is incorrect)public IdentityAPI getIdentityAPI()
getIdentityAPI
in class APIClient
public ProcessAPI getProcessAPI()
getProcessAPI
in class APIClient
public MonitoringAPI getMonitoringAPI()
public LogAPI getLogAPI()
public ThemeAPI getThemeAPI()
getThemeAPI
in class APIClient
public ProfileAPI getProfileAPI()
getProfileAPI
in class APIClient
public ReportingAPI getReportingAPI()
public TenantAdministrationAPI getTenantAdministrationAPI()
getTenantAdministrationAPI
in class APIClient
Copyright © 2018 Bonitasoft S.A.. All rights reserved.