public interface BackendBundlesDatabase
| Modifier and Type | Method and Description |
|---|---|
void |
addBundle(com.prosyst.mprm.data.system.BackendBundleInfo info,
java.io.InputStream input)
Adds a backend bundle.
|
void |
addConfig(com.prosyst.mprm.data.system.BundleConfigInfo config)
Adds a backend bundle configuration.
|
void |
addDBConfig(com.prosyst.mprm.data.system.DBConfigInfo dbServiceConfig)
Adds a DB service configuration.
|
void |
addDBMetaTypeProvider(com.prosyst.mprm.data.system.ExtendedDBMTP mtp)
Adds a DB configuration metatype provider.
|
void |
addMetaTypeProvider(com.prosyst.mprm.data.system.ExtendedMTP mtp)
Adds a bundle meta type provider.
|
void |
addPackage(com.prosyst.mprm.data.system.PackageInfo info)
Adds a backend bundle package.
|
java.lang.String[] |
addPermissions(com.prosyst.mprm.data.system.BundlePermissions permissions)
Adds backend bundle permissions.
|
com.prosyst.mprm.data.system.BackendBundleInfo |
getBundle(java.lang.String location)
Returns a backend bundle.
|
com.prosyst.mprm.data.system.BackendBundleInfo |
getBundle(java.lang.String bundleName,
java.lang.String bundleVendor)
Returns backend bundle with specified bundle name and vendor, if such exists in the database.
|
java.io.InputStream |
getBundleJar(java.lang.String location)
Returns the jar file of a backend bundle.
|
com.prosyst.mprm.data.system.BackendBundleInfo[] |
getBundles(java.lang.String[] roles)
Returns all backend bundles targeted for the specified roles.
|
com.prosyst.mprm.data.system.BundleConfigInfo[] |
getConfigs(java.lang.String[] roles,
java.lang.String location,
java.lang.String fpid,
java.lang.String pid)
Returns all backend bundle configurations matching search criteria.
|
com.prosyst.mprm.data.system.DBConfigInfo[] |
getDBConfigs(java.lang.String location,
java.lang.String dbName,
java.lang.String fpid,
java.lang.String pid)
Returns DB service configs with the specified bundle location, database name, FPID, and PID.
|
com.prosyst.mprm.data.system.DBConfigInfo[] |
getDBConfigs(java.lang.String scope,
java.lang.String location,
java.lang.String dbName,
java.lang.String fpid,
java.lang.String pid)
Returns DB service configs with the specified scope, bundle location, database name,
FPID, and PID.
|
com.prosyst.mprm.data.system.ExtendedDBMTP |
getDBMetaTypeProvider(java.lang.String pid) |
com.prosyst.mprm.data.system.ExtendedDBMTP[] |
getDBMetaTypeProviders(java.lang.String location,
java.lang.String database,
boolean loadMtp)
Searches for DB configuration metadata.
|
com.prosyst.mprm.data.system.ExtendedDBMTP[] |
getDBMetaTypeProviders(java.lang.String location,
java.lang.String database,
boolean isFactory,
boolean loadMtp)
Searches for DB configuration metadata.
|
com.prosyst.mprm.data.system.ExtendedMTP |
getMetaTypeProvider(java.lang.String pid)
Searches and returns metatype provider identified by its pid.
|
com.prosyst.mprm.data.system.ExtendedMTP[] |
getMetaTypeProviders(java.lang.String location,
boolean loadMtp)
Searches for bundle configuration metadata.
|
com.prosyst.mprm.data.system.ExtendedMTP[] |
getMetaTypeProviders(java.lang.String location,
boolean isFactory,
boolean loadMtp)
Searches for bundle configuration metadata.
|
com.prosyst.mprm.data.system.PackageInfo |
getPackage(java.lang.String name)
Returns named backend bundle package.
|
com.prosyst.mprm.data.system.BackendBundleInfo[] |
getPackageBundles(java.lang.String pack,
java.lang.String[] roles,
boolean onlyActive)
Returns backend bundles according to package name and roles filter.
|
java.lang.String[] |
getPackageNames()
Returns the names of the bundle packages stored into the database.
|
com.prosyst.mprm.data.system.PackageInfo[] |
getPackages()
Returns all backend bundle packages.
|
java.lang.String[] |
getPackagesDependentOn(java.lang.String pack)
Returns the names of all packages that depend on a given package.
|
com.prosyst.mprm.data.system.BundlePermissions[] |
getPermissions(java.lang.String[] roles)
Returns the permissions for all bundles and a specific set of roles.
|
com.prosyst.mprm.data.system.BundlePermissions[] |
getPermissions(java.lang.String location,
java.lang.String[] roles)
Returns the permissions for a backend bundle and specific set of roles.
|
com.prosyst.mprm.data.system.BackendBundleInfo[] |
getUserBundles(java.lang.String[] roles)
Returns user backend bundles targeted for the specified roles.
|
com.prosyst.mprm.data.system.ExtendedDBMTP |
loadDBMetaTypeProvider(com.prosyst.mprm.data.system.ExtendedDBMTP mtpInfo)
Initializes the
ExtendedMTP.mtp field of the passed object
and returns it back. |
com.prosyst.mprm.data.system.ExtendedMTP |
loadMetaTypeProvider(com.prosyst.mprm.data.system.ExtendedMTP mtpInfo)
Initializes the
ExtendedMTP.mtp of the passed object
and returns it back. |
void |
removeBundle(java.lang.String location)
Removes a backend bundle.
|
void |
removeBundles()
Removes all backend bundles.
|
void |
removeConfigs(java.lang.String[] roles,
java.lang.String location,
java.lang.String fpid,
java.lang.String pid)
Removes backend bundle configurations matching search criteria.
|
void |
removeDBConfigs(java.lang.String location,
java.lang.String dbName,
java.lang.String fpid,
java.lang.String pid)
Removes DB service configs with the specified bundle location, database name, FPID, and PID.
|
void |
removeDBConfigs(java.lang.String scope,
java.lang.String location,
java.lang.String dbName,
java.lang.String fpid,
java.lang.String pid)
Removes DB service configs with the specified scope, bundle location, FPID, and PID.
|
void |
removeDBMetaTypeProviders(java.lang.String location,
java.lang.String pid)
Removes DB config metadata.
|
void |
removeMetaTypeProviders(java.lang.String location,
java.lang.String pid)
Removes bundle configuration metadata.
|
void |
removePackage(java.lang.String name)
Removes a backend bundle package, along with all its bundles
and dependencies (i.e.
|
void |
removePackageBundles(java.lang.String pack)
Removes backend bundles belonging to a single package, or all package backend bundles.
|
void |
removePackages()
Removes all backend bundle packages, along with all their bundles
and dependencies (i.e.
|
void |
removePermissions(java.lang.String[] roles)
Removes the permissions for all bundles and a specific set of roles.
|
void |
removePermissions(java.lang.String location,
java.lang.String[] roles)
Removes backend bundle permissions.
|
void |
removeUserBundles()
Removes all user backend bundles.
|
void |
setPermissions(com.prosyst.mprm.data.system.BundlePermissions permissions)
Sets backend bundle permissions.
|
void |
updateBundle(com.prosyst.mprm.data.system.BackendBundleInfo info,
java.io.InputStream input)
Updates a backend bundle.
|
void |
updatePackage(com.prosyst.mprm.data.system.PackageInfo info)
Updates a backend bundle package.
|
void addPackage(com.prosyst.mprm.data.system.PackageInfo info)
throws DatabaseException
info - the package{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionvoid updatePackage(com.prosyst.mprm.data.system.PackageInfo info)
throws DatabaseException
info - the package{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptioncom.prosyst.mprm.data.system.PackageInfo getPackage(java.lang.String name)
throws DatabaseException
name - the name of the package to retrieve{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptioncom.prosyst.mprm.data.system.PackageInfo[] getPackages()
throws DatabaseException
{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionjava.lang.String[] getPackageNames()
throws DatabaseException
{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionjava.lang.String[] getPackagesDependentOn(java.lang.String pack)
throws DatabaseException
{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionvoid removePackage(java.lang.String name)
throws DatabaseException
name - the name of the package to be removed{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionvoid removePackages()
throws DatabaseException
{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptioncom.prosyst.mprm.data.system.BackendBundleInfo[] getPackageBundles(java.lang.String pack,
java.lang.String[] roles,
boolean onlyActive)
throws DatabaseException
Null arguments are excluded from the search filter.
Returned array is ORDERED BY package startup order, then by bundle startup order.pack - package name; may be nullroles - the roles; may be nullonlyActive - if true, returns only active packages and bundles.{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptioncom.prosyst.mprm.data.system.BackendBundleInfo[] getUserBundles(java.lang.String[] roles)
throws DatabaseException
Null arguments are excluded from the search filter.roles - roles; may be null{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptioncom.prosyst.mprm.data.system.BackendBundleInfo[] getBundles(java.lang.String[] roles)
throws DatabaseException
Null arguments are excluded from the search filter.
Returned array contains first package bundles ORDERED BY package startup order,
then by bundle startup order, after them user bundles ORDERED BY bundle startup order.roles - roles; may be null{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptioncom.prosyst.mprm.data.system.BackendBundleInfo getBundle(java.lang.String bundleName,
java.lang.String bundleVendor)
throws DatabaseException
bundleName - Bundle-Name tag from bundle manifestbundleVendor - Bundle-Vendor tag from bundle manifestnull{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionvoid removePackageBundles(java.lang.String pack)
throws DatabaseException
pack - package name; if null, all package bundles are removed.{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionvoid removeUserBundles()
throws DatabaseException
{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionvoid removeBundles()
throws DatabaseException
{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionvoid addBundle(com.prosyst.mprm.data.system.BackendBundleInfo info,
java.io.InputStream input)
throws DatabaseException
info - the bundle info.input - the jar file of the bundle.{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionvoid updateBundle(com.prosyst.mprm.data.system.BackendBundleInfo info,
java.io.InputStream input)
throws DatabaseException
info argument except the manifest must be valid.
The bundle is searched for update according to its location.info - the bundle info; if info.manifest is null,
the manifest is not updatedinput - the jar file of the bundle; if null, the bundle jar is not updated{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionjava.io.InputStream getBundleJar(java.lang.String location)
throws DatabaseException
location - the location of the bundle{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptioncom.prosyst.mprm.data.system.BackendBundleInfo getBundle(java.lang.String location)
throws DatabaseException
location - the location of the bundle{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionvoid removeBundle(java.lang.String location)
throws DatabaseException
location - non-null location{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionvoid addDBMetaTypeProvider(com.prosyst.mprm.data.system.ExtendedDBMTP mtp)
throws DatabaseException
mtp - DB MTP info to add.{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptioncom.prosyst.mprm.data.system.ExtendedDBMTP getDBMetaTypeProvider(java.lang.String pid)
throws DatabaseException
pid - {@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptioncom.prosyst.mprm.data.system.ExtendedDBMTP[] getDBMetaTypeProviders(java.lang.String location,
java.lang.String database,
boolean isFactory,
boolean loadMtp)
throws DatabaseException
Null arguments are excluded from the search filter.location - bundle location; may be nulldatabase - database name; may be nullisFactory - loadMtp - ExtendedMTP.mtp field is initialized
only if loadMtp is true{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptioncom.prosyst.mprm.data.system.ExtendedDBMTP[] getDBMetaTypeProviders(java.lang.String location,
java.lang.String database,
boolean loadMtp)
throws DatabaseException
Null arguments are excluded from the search filter.location - bundle location; may be nulldatabase - database name; may be nullloadMtp - ExtendedMTP.mtp field is initialized
only if loadMtp is true{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptioncom.prosyst.mprm.data.system.ExtendedDBMTP loadDBMetaTypeProvider(com.prosyst.mprm.data.system.ExtendedDBMTP mtpInfo)
throws DatabaseException
ExtendedMTP.mtp field of the passed object
and returns it back.mtpInfo - MTP info object, used to construct the search filter for the binary MTP datamtp field.
If the DB search returned nothing, field will be set to null{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionvoid removeDBMetaTypeProviders(java.lang.String location,
java.lang.String pid)
throws DatabaseException
Null arguments are excluded from the search filter.location - bundle location; may be nullpid - metadata pid; may be null{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionvoid addDBConfig(com.prosyst.mprm.data.system.DBConfigInfo dbServiceConfig)
throws DatabaseException
dbServiceConfig - the DB service configuration.{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptioncom.prosyst.mprm.data.system.DBConfigInfo[] getDBConfigs(java.lang.String location,
java.lang.String dbName,
java.lang.String fpid,
java.lang.String pid)
throws DatabaseException
Null arguments are excluded from the search filter.location - bundle location; may be nulldbName - database name; may be nullfpid - the FPID; may be nullpid - the configuration PID; may be null{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptioncom.prosyst.mprm.data.system.DBConfigInfo[] getDBConfigs(java.lang.String scope,
java.lang.String location,
java.lang.String dbName,
java.lang.String fpid,
java.lang.String pid)
throws DatabaseException
Null arguments are excluded from the search filter.scope - you can pass one of the following scopes:
DBConfigInfo.SCOPE_COMMON
to get all DB service configs whose MSID IS NULL.
DBConfigInfo.SCOPE_MS
to get all DB service whose MSID IS NOT NULL.
location - bundle location; may be nulldbName - database name; may be nullfpid - the FPID; may be nullpid - the configuration PID; may be null{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionvoid removeDBConfigs(java.lang.String scope,
java.lang.String location,
java.lang.String dbName,
java.lang.String fpid,
java.lang.String pid)
throws DatabaseException
Null arguments are excluded from the search filter.scope - you can pass one of the following scopes:
DBConfigInfo.SCOPE_COMMON
to remove all DB service configs whose MSID IS NULL.
DBConfigInfo.SCOPE_MS
to remove all DB service whose MSID IS NOT NULL.
location - bundle location; may be nulldbName - database name; may be nullfpid - the FPID; may be nullpid - the PID; may be null{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionvoid removeDBConfigs(java.lang.String location,
java.lang.String dbName,
java.lang.String fpid,
java.lang.String pid)
throws DatabaseException
Null arguments are excluded from the search filter.location - bundle location; may be nulldbName - database name; may be nullfpid - the FPID; may be nullpid - the configuration PID; may be null{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionjava.lang.String[] addPermissions(com.prosyst.mprm.data.system.BundlePermissions permissions)
throws DatabaseException
permissions - permissions info; object fields are treated in the following way:
bundleLocationnull, permissions are added to the default set for the role
rolenull, the permissions are added to the set for the default role
permissionsnull <=>String[0]
{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionvoid setPermissions(com.prosyst.mprm.data.system.BundlePermissions permissions)
throws DatabaseException
permissions - permissions info; object fields are treated in the following way:
bundleLocationnull, permissions are added to the default set for the role
rolenull, the permissions are added to the set for the default role
permissionsnull <=>String[0]
{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptioncom.prosyst.mprm.data.system.BundlePermissions[] getPermissions(java.lang.String[] roles)
throws DatabaseException
roles - roles; if null, it is excluded from the search filter{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptioncom.prosyst.mprm.data.system.BundlePermissions[] getPermissions(java.lang.String location,
java.lang.String[] roles)
throws DatabaseException
location - bundle location; null means get default permissions for passed rolesroles - roles; if null, it is excluded from the search filter{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionvoid removePermissions(java.lang.String location,
java.lang.String[] roles)
throws DatabaseException
location - bundle location; null means remove default permissions for passed rolesroles - roles; if null, it is excluded from the search filter{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionvoid removePermissions(java.lang.String[] roles)
throws DatabaseException
roles - roles; if null, it is excluded from the search filter{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionvoid addMetaTypeProvider(com.prosyst.mprm.data.system.ExtendedMTP mtp)
throws DatabaseException
mtp - MTP info{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptioncom.prosyst.mprm.data.system.ExtendedMTP getMetaTypeProvider(java.lang.String pid)
throws DatabaseException
pid - the metatype provider pid{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptioncom.prosyst.mprm.data.system.ExtendedMTP[] getMetaTypeProviders(java.lang.String location,
boolean isFactory,
boolean loadMtp)
throws DatabaseException
Null arguments are excluded from the search filter.location - bundle location; may be nullisFactory - loadMtp - ExtendedMTP.mtp field is initialized
only if loadMtp is true{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptioncom.prosyst.mprm.data.system.ExtendedMTP[] getMetaTypeProviders(java.lang.String location,
boolean loadMtp)
throws DatabaseException
Null arguments are excluded from the search filter.location - bundle location; may be nullloadMtp - ExtendedMTP.mtp field is initialized
only if loadMtp is true{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptioncom.prosyst.mprm.data.system.ExtendedMTP loadMetaTypeProvider(com.prosyst.mprm.data.system.ExtendedMTP mtpInfo)
throws DatabaseException
ExtendedMTP.mtp of the passed object
and returns it back.mtpInfo - MTP info object, used to construct the search filter for the binary MTP datamtp field.
If the DB search returned nothing, field will be set to null!{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionvoid removeMetaTypeProviders(java.lang.String location,
java.lang.String pid)
throws DatabaseException
Null arguments are excluded from the search filter.location - bundle location; may be nullpid - metadata pid; may be null{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionvoid addConfig(com.prosyst.mprm.data.system.BundleConfigInfo config)
throws DatabaseException
config - Bundle configuration to be added.{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptioncom.prosyst.mprm.data.system.BundleConfigInfo[] getConfigs(java.lang.String[] roles,
java.lang.String location,
java.lang.String fpid,
java.lang.String pid)
throws DatabaseException
Null arguments are excluded from the search filter.roles - roles; may be nulllocation - bundle location; may be nullfpid - FPID; may be nullpid - PID; may be null{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionvoid removeConfigs(java.lang.String[] roles,
java.lang.String location,
java.lang.String fpid,
java.lang.String pid)
throws DatabaseException
Null arguments are excluded from the search filter.roles - roles; may be nulllocation - bundle location; may be nullfpid - FPID; may be nullpid - PID; may be null{@link - DatabaseException} if underlying database server exception is thrownDatabaseExceptionCopyright © 2019 Bosch Software Innovations GmbH. All Rights Reserved.