public interface TenantAdministrationAPI extends TenantAdministrationAPI
Modifier and Type | Method and Description |
---|---|
TenantResource |
getBDMAccessControlResource()
Retrieves the BDM Access Control status, as a tenant-level resource.
|
byte[] |
getCurrentBDMAccessControlFile()
Retrieves the Business Data Model access control currently installed.
|
ExecutionResult |
installBDMAccessControl(byte[] bdmAccessControlXml)
Installs or updates the Business Data Model access control.
|
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, getBusinessDataModelResource, 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.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
TenantResource getBDMAccessControlResource()
TenantResource
representing the current BDM Access Control status on the current tenant,
or TenantResource.NONE if no BDM Access Control status is installed.Copyright © 2018 Bonitasoft S.A.. All rights reserved.