public interface TenantAdministrationAPI extends TenantAdministrationAPI
Modifier and Type | Method and Description |
---|---|
byte[] |
getCurrentBDMAccessControlFile()
Retrieves the Business Data Model access control currently installed.
|
ExecutionResult |
installBDMAccessControl(byte[] bdmAccessControlXml)
Installs or updates the Business Data Model access control.
|
boolean |
isBDMAccessControlInstalled()
Checks if the Business Data Model access control is currently installed.
|
void |
uninstallBDMAccessControl()
Uninstalls the current Business Data Model access control completely.
|
ExecutionResult |
validateBDMAccessControl(byte[] bdmAccessControlXml)
Validates the given Business Data Model access control file.
|
cleanAndUninstallBusinessDataModel, getBusinessDataModelVersion, getClientBDMZip, installBusinessDataModel, isPaused, pause, resume, uninstallBusinessDataModel
ExecutionResult installBDMAccessControl(byte[] bdmAccessControlXml) throws BDMAccessControlException, BusinessDataRepositoryDeploymentException, InvalidXMLException
ExecutionResult
containing potential minor validation statuses (with levels INFO or WARNING).
In case of failure, this method throws a BDMAccessControlException with an ExecutionResult
containing the full validation statuses (with levels
INFO, WARNING, ERROR). The validation ERROR's must be corrected for the installation to be successful.bdmAccessControlXml
- the xml file content, matching the XSD, as generated by
com.bonitasoft.engine.bdm.accesscontrol.BDMAccessControlParser#convert(com.bonitasoft.engine.bdm.accesscontrol.model.BusinessObjectAccessControlModel)
ExecutionResult
containing minor validation statuses (INFO or WARNING)BusinessDataRepositoryDeploymentException
- if the installation / update fails.BDMAccessControlException
- if the provided model is invalid. More details on the validation errors are given in the exception.InvalidXMLException
- if the given xml is not an xml file matching the xsd.boolean isBDMAccessControlInstalled() throws BusinessDataRepositoryException
BusinessDataRepositoryException
void uninstallBDMAccessControl() throws BusinessDataRepositoryDeploymentException
BusinessDataRepositoryDeploymentException
byte[] getCurrentBDMAccessControlFile() throws BusinessDataRepositoryException
BusinessDataRepositoryException
ExecutionResult validateBDMAccessControl(byte[] bdmAccessControlXml) throws IllegalArgumentException, InvalidXMLException
bdmAccessControlXml
- the xml matching the XSD, as generated by
com.bonitasoft.engine.bdm.accesscontrol.BDMAccessControlParser#convert(com.bonitasoft.engine.bdm.accesscontrol.model.BusinessObjectAccessControlModel)
ExecutionResult
containing the validation statuses (may be WARNINGS, ERRORS, or INFO)InvalidXMLException
- if the given xml is not an xml file matching the xsdIllegalArgumentException
Status}
Copyright © 2018 Bonitasoft S.A.. All rights reserved.