com.prosyst.mprm.admin.system

Interface BackendBundleInventory

All Known Subinterfaces:

Configurator, ConfiguratorManager, SystemObserver

public interface BackendBundleInventory

Enables system operator to observe and change the mPRM base backend bundles configuration - bundle packages, bundles, bundle configurations & permissions. Every operation can throw CommunicationException if error between the remote server & client occurs.

Version:

1.0.0

Author:

Kaloyan Radev

Method Summary

Modifier and Type	Method and Description
BackendBundle	addBundle(java.io.InputStream is, java.lang.String[] deploymentTargets) Adds a backend bundle from the bundle's jar file input stream and sets specified deployment targets to it.
BackendBundlePack	addBundlePack(java.io.InputStream is) Adds bundle pack using specified input stream to the pack's zip file.
void	addPermission(java.lang.String roleId, java.lang.String bundleLocation, PermissionInfo permission) Adds a permission to backend bundle.
java.lang.String	createFactoryConfiguration(java.lang.String roleId, java.lang.String factoryPid) Creates a new factory configuration with given factory pid.
void	deleteConfiguration(java.lang.String roleId, java.lang.String pid) Deletes configuration with given pid for specified role.
BackendBundle	getBundle(java.lang.String bundleLocation) Returns backend bundle identified by its location.
BackendBundle	getBundle(java.lang.String packName, java.lang.String bundleName, java.lang.String bundleVendor) Returns backend bundle identified by its package, name and vendor.
BackendBundlePack	getBundlePack(java.lang.String packName) Returns single backend bundle pack identified by its name.
BackendBundlePack[]	getBundlePacks() Returns all backend bundle packs within the mPRM system.
BackendBundle[]	getBundles() Returns all backend bundles within the mPRM system.
BackendBundle[]	getBundles(java.lang.String packName, java.lang.String targetRole) Returns filtered set of backend bundles.
java.io.InputStream	getBundleStream(java.lang.String bundleLocation) Returns stream to specified backend bundle.
RoleConfig	getConfiguration(java.lang.String roleId, java.lang.String pid) Returns a configuration of backend bundle having a given pid.
MetaTypeProviderExtension	getMetaTypeProvider(java.lang.String pid) Returns configuration metatype for a given pid.
MetaTypeProviderExtension[]	getMetaTypeProviders(java.lang.String bundleLocation) Returns configuration metatypes of backend bundle.
PermissionInfo[]	getPermissions(java.lang.String roleId, java.lang.String bundleLocation) Returns security permissions of a backend bundle.
java.lang.String[]	getPidsOfFactoryConfiguration(java.lang.String roleId, java.lang.String factoryPid) Returns array of String objects representing pids of configurations which belongs to a configuration group of particular factory pid.
void	removeBundle(java.lang.String bundleLocation) Removes a backend bundle specified by location.
void	removeBundlePack(java.lang.String packName) Removes backend bundle pack specified by name.
void	removePermission(java.lang.String roleId, java.lang.String bundleLocation, PermissionInfo permission) Removes a permission of backend bundle.
void	setConfiguration(java.lang.String roleId, java.lang.String factoryPid, java.lang.String pid, java.util.Dictionary data) Sets configuration properties for a role with given pid and factory pid.
void	setPermissions(java.lang.String roleId, java.lang.String bundleLocation, PermissionInfo[] permissions) Sets a set of permissions to backend bundle.
BackendBundle	updateBundle(java.lang.String bundleLocation, java.io.InputStream is) Updates backend bundle using specified input stream.
BackendBundlePack	updateBundlePack(java.lang.String packName, java.io.InputStream is) Updates bundle pack using specified input stream to the pack's zip file.
BackendBundle	updateBundleTargets(java.lang.String bundleLocation, java.lang.String[] deploymentTargets) Updates backend bundle deployment targets.

Method Detail

getBundlePacks

BackendBundlePack[] getBundlePacks()
                            throws CommunicationException,
                                   java.lang.Exception

Returns all backend bundle packs within the mPRM system.

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

getBundlePack

BackendBundlePack getBundlePack(java.lang.String packName)
                         throws CommunicationException,
                                java.lang.Exception

Returns single backend bundle pack identified by its name.

Parameters:

packName - unique name of the pack

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

addBundlePack

BackendBundlePack addBundlePack(java.io.InputStream is)
                         throws CommunicationException,
                                java.lang.Exception

Adds bundle pack using specified input stream to the pack's zip file. If pack with the same name already exists exception is thrown.

Parameters:

is - pack's input stream

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

updateBundlePack

BackendBundlePack updateBundlePack(java.lang.String packName,
                                   java.io.InputStream is)
                            throws CommunicationException,
                                   java.lang.Exception

Updates bundle pack using specified input stream to the pack's zip file.

Parameters:

packName - unique name of the pack

is - pack's input stream

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

removeBundlePack

void removeBundlePack(java.lang.String packName)
               throws CommunicationException,
                      java.lang.Exception

Removes backend bundle pack specified by name. System pack is not removable.

Parameters:

packName - unique name of the pack

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

getBundles

BackendBundle[] getBundles()
                    throws CommunicationException,
                           java.lang.Exception

Returns all backend bundles within the mPRM system. Result is same as calling getBundles(null, null).

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

getBundles

BackendBundle[] getBundles(java.lang.String packName,
                           java.lang.String targetRole)
                    throws CommunicationException,
                           java.lang.Exception

Returns filtered set of backend bundles.

Parameters:

packName - name of the pack containing the bundles, null for all bundles, empty string for all non packaged bundles.

targetRole - the target role of the bundle. Note that it returns also the bundles of the roles which this role is implied by!

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

getBundle

BackendBundle getBundle(java.lang.String bundleLocation)
                 throws CommunicationException,
                        java.lang.Exception

Returns backend bundle identified by its location.

Parameters:

bundleLocation - of the bundle

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

getBundleStream

java.io.InputStream getBundleStream(java.lang.String bundleLocation)
                             throws CommunicationException,
                                    java.lang.Exception

Returns stream to specified backend bundle.

Parameters:

bundleLocation - of the bundle

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

getBundle

BackendBundle getBundle(java.lang.String packName,
                        java.lang.String bundleName,
                        java.lang.String bundleVendor)
                 throws CommunicationException,
                        java.lang.Exception

Returns backend bundle identified by its package, name and vendor.

Parameters:

packName - name of the pack containing backend bundle, null for all packs, empty string for bundles which do not belong to any package

bundleName - name of the bundle

bundleVendor - vendor of the bundle

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

addBundle

BackendBundle addBundle(java.io.InputStream is,
                        java.lang.String[] deploymentTargets)
                 throws CommunicationException,
                        java.lang.Exception

Adds a backend bundle from the bundle's jar file input stream and sets specified deployment targets to it. A deployment target can be: Roles.CC, Roles.MS, Roles.RAS, Roles.MC or an id of specific management server.

Parameters:

is - bundle's input stream

deploymentTargets - list of backend modules this bundle is targeted to

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

updateBundle

BackendBundle updateBundle(java.lang.String bundleLocation,
                           java.io.InputStream is)
                    throws CommunicationException,
                           java.lang.Exception

Updates backend bundle using specified input stream.

Parameters:

bundleLocation - of the bundle

is - bundle's input stream

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

updateBundleTargets

BackendBundle updateBundleTargets(java.lang.String bundleLocation,
                                  java.lang.String[] deploymentTargets)
                           throws CommunicationException,
                                  java.lang.Exception

Updates backend bundle deployment targets. A deployment target can be: Roles.CC, Roles.MS, Roles.RAS, Roles.MC or an id of specific management server.

Parameters:

bundleLocation - location identifying the bundle

deploymentTargets - the new deployment targets for the bundle

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

removeBundle

void removeBundle(java.lang.String bundleLocation)
           throws CommunicationException,
                  java.lang.Exception

Removes a backend bundle specified by location. If the bundle belongs to a bundle pack this should cause an Exception to be thrown.

Parameters:

bundleLocation - of the bundle

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

getMetaTypeProviders

MetaTypeProviderExtension[] getMetaTypeProviders(java.lang.String bundleLocation)
                                          throws CommunicationException,
                                                 java.lang.Exception

Returns configuration metatypes of backend bundle.

Parameters:

bundleLocation - location of the bundle or null for all bundles

Returns:

an array of MetaTypeProviderExtension objects.

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

getMetaTypeProvider

MetaTypeProviderExtension getMetaTypeProvider(java.lang.String pid)
                                       throws CommunicationException,
                                              java.lang.Exception

Returns configuration metatype for a given pid.

Returns:

the MetaTypeProviderExtension representing metatype for configurations with this pid. If there is no configuration for this pid, null is returned.

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

getPidsOfFactoryConfiguration

java.lang.String[] getPidsOfFactoryConfiguration(java.lang.String roleId,
                                                 java.lang.String factoryPid)
                                          throws CommunicationException,
                                                 java.lang.Exception

Returns array of String objects representing pids of configurations which belongs to a configuration group of particular factory pid.

Parameters:

roleId - identificator of host role

factoryPid - factory pid.

Returns:

array of pids belonging to the supplied factory pid.

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

getConfiguration

RoleConfig getConfiguration(java.lang.String roleId,
                            java.lang.String pid)
                     throws CommunicationException,
                            java.lang.Exception

Returns a configuration of backend bundle having a given pid. If there is no configuration with the supplied pid, null is returned.

Parameters:

roleId - identificator of host role

pid - the pid of the configuration.

Returns:

dictionary with the configuration values.

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

createFactoryConfiguration

java.lang.String createFactoryConfiguration(java.lang.String roleId,
                                            java.lang.String factoryPid)
                                     throws CommunicationException,
                                            java.lang.Exception

Creates a new factory configuration with given factory pid.

Parameters:

roleId - identificator of host role

factoryPid - factory pid of the configuration being created.

Returns:

pid of the new configuration.

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

deleteConfiguration

void deleteConfiguration(java.lang.String roleId,
                         java.lang.String pid)
                  throws CommunicationException,
                         java.lang.Exception

Deletes configuration with given pid for specified role.

Parameters:

roleId - identificator of host role

pid - the pid of the configuration.

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

setConfiguration

void setConfiguration(java.lang.String roleId,
                      java.lang.String factoryPid,
                      java.lang.String pid,
                      java.util.Dictionary data)
               throws CommunicationException,
                      java.lang.Exception

Sets configuration properties for a role with given pid and factory pid.

Parameters:

roleId - identificator of host role

factoryPid - factory pid of the configuration being created.

pid - the pid of the configuration.

data - configuration properties.

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

getPermissions

PermissionInfo[] getPermissions(java.lang.String roleId,
                                java.lang.String bundleLocation)
                         throws CommunicationException,
                                java.lang.Exception

Returns security permissions of a backend bundle.

Parameters:

roleId - identificator of host role

bundleLocation - the location of the bundle

Returns:

an array, holding the permissions of the deployed bundle and an empty array if no permissions are set.

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

setPermissions

void setPermissions(java.lang.String roleId,
                    java.lang.String bundleLocation,
                    PermissionInfo[] permissions)
             throws CommunicationException,
                    java.lang.Exception

Sets a set of permissions to backend bundle. Previously given permissions are removed.

Parameters:

roleId - identificator of host role

bundleLocation - location of the bundle

permissions - security permissions which will be granted to backend bundle.

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

addPermission

void addPermission(java.lang.String roleId,
                   java.lang.String bundleLocation,
                   PermissionInfo permission)
            throws CommunicationException,
                   java.lang.Exception

Adds a permission to backend bundle.

Parameters:

roleId - target backend role.

bundleLocation - target backend bundle location.

permission - security permission being granted to backend bundle.

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

removePermission

void removePermission(java.lang.String roleId,
                      java.lang.String bundleLocation,
                      PermissionInfo permission)
               throws CommunicationException,
                      java.lang.Exception

Removes a permission of backend bundle.

Parameters:

roleId - identificator of host role

bundleLocation - location of the bundle

permission - security permission being removed from backend bundle.

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception