com.prosyst.mprm.admin.system

Interface BackendBundle

All Superinterfaces:

com.prosyst.admin.framework.BundleDefinition

All Known Subinterfaces:

DeployedBackendBundle

public interface BackendBundle
extends com.prosyst.admin.framework.BundleDefinition

Represents a bundle stored in the system database. Provides access to the information about the bundle. Bundle information includes properties available via it's manifest like name, vendor, version, etc. Some of the methods is not supposed to return the expected value if the bundle is received through specific(regarding a single backend host) BackendBundleAdmin.

Version:

1.0.0

Author:

Kaloyan Radev

Method Summary

Modifier and Type	Method and Description
boolean	compareIgnoreVersion(BackendBundle bundle) Compares this bundle with the supplied object.
int	compareVersions(BackendBundle bundle) Compares versions of two bundles.
boolean	equals(java.lang.Object bundle) Compares this bundle with the supplied object.
java.lang.String[]	getDeploymentTargets() Returns the deployment targets of this bundle.
java.lang.String	getLocation() Returns the location of the bundle.
java.lang.String	getPackageName() Returns the name of the pack containing this bundle.
boolean	isEnabled() If this bundle is optional (respectively belonging to a bundle pack) this method returns whether to be installed when its pack is installed.
boolean	isOptional() Returns whether this bundle is optional in the bundle pack it belongs to.

Methods inherited from interface com.prosyst.admin.framework.BundleDefinition

getBundleCategory, getBundleDescription, getBundleName, getExportPackages, getImportPackages, getLocations, getManifest, getVendor, getVersion

Method Detail

getDeploymentTargets

java.lang.String[] getDeploymentTargets()

Returns the deployment targets of this bundle. Deployment target could be any constant Roles class - The Control Center Roles.CC, all management servers Roles.MS, all remote access servers Roles.RAS, the management console Roles.MC or an identificator of specific management server ManagementServer.getId(). It is permitted this method not to return the actual value if the instance is received through specific BackendBundleAdmin.

Returns:

the deployment targets of this bundle

getLocation

java.lang.String getLocation()

Returns the location of the bundle.

Returns:

the bundle's backend location.

getPackageName

java.lang.String getPackageName()

Returns the name of the pack containing this bundle. It is permitted this method not to return the actual value if the bundle is received through specific BackendBundleAdmin.

Returns:

the bundle's backend package.

isOptional

boolean isOptional()

Returns whether this bundle is optional in the bundle pack it belongs to. If bundle doesn't belong to any pack method returns false. Optional bundles can be set whether to be installed when it's pack is installed. It is permitted this method not to return the actual value if the bundle is received through specific BackendBundleAdmin.

Returns:

whether the bundle is optional

isEnabled

boolean isEnabled()

If this bundle is optional (respectively belonging to a bundle pack) this method returns whether to be installed when its pack is installed. If this bundle is not optional the method returns true. It is permitted this method not to return the actual value if the bundle is received through specific BackendBundleAdmin.

Returns:

whether the bundle is enabled/must be installed/

equals

boolean equals(java.lang.Object bundle)

Compares this bundle with the supplied object. Two bundles are equal if: Their properties "Bundle-Name", "Bundle-Vendor", "Bundle-Version" are not null and are equal, or if some of these properties is null - if their locations are equal.

Overrides:

equals in class java.lang.Object

Parameters:

bundle - the compared bundle. Should be subclass of BundleDefinition class

Returns:

true if bundles are equal.

compareIgnoreVersion

boolean compareIgnoreVersion(BackendBundle bundle)

Compares this bundle with the supplied object. This method is the same as method equals(java.lang.Object) but ignores version property from the comparison.

Parameters:

bundle - the compared bundle.

Returns:

true if two bundles has the same name and vendor.

compareVersions

int compareVersions(BackendBundle bundle)

Compares versions of two bundles. Returns -1 if the bundle passed as argument has newer version then this bundle, 1 if the version is older and 0 if the versions are equal.

Parameters:

bundle - the compared bundle.

Returns:

-1, 0, 1