org.rhq.enterprise.server.content
Class ContentManagerBean

java.lang.Object
  org.rhq.enterprise.server.content.ContentManagerBean

All Implemented Interfaces:

ContentManagerLocal, ContentManagerRemote

public class ContentManagerBean
extends java.lang.Object
implements ContentManagerLocal, ContentManagerRemote

EJB that handles content subsystem interaction with resources, including content discovery reports and create/delete functionality.

Author:

Jason Dobies

Constructor Summary

ContentManagerBean()

Method Summary

void	checkForTimedOutRequests(Subject subject) For internal use only - Will check to see if any in progress content request jobs are taking too long to finish and if so marks them as failed.
void	completeDeletePackageRequest(RemovePackagesResponse response) For documentation, see ContentServerService.completeDeletePackageRequest(org.rhq.core.domain.content.transfer.RemovePackagesResponse) .
void	completeDeployPackageRequest(DeployPackagesResponse response) For documentation, see ContentServerService.completeDeployPackageRequest(org.rhq.core.domain.content.transfer.DeployPackagesResponse) .
void	completeRetrievePackageBitsRequest(ContentServiceResponse response, java.io.InputStream bitStream) For documentation, see ContentServerService.completeRetrievePackageBitsRequest(org.rhq.core.clientapi.server.content.ContentServiceResponse, java.io.InputStream) )}.
ContentServiceRequest	createDeployRequest(int resourceId, java.lang.String username, java.util.Set<ResourcePackageDetails> packages, java.lang.String notes) For internal use only - Adds a request entry to the database to track the deployment of a group of packages.
PackageVersion	createPackageVersion(java.lang.String packageName, int packageTypeId, java.lang.String version, int architectureId, java.io.InputStream packageBitStream) Creates a new package version in the system.
PackageVersion	createPackageVersion(Subject subject, java.lang.String packageName, int packageTypeId, java.lang.String version, java.lang.Integer architectureId, byte[] packageBytes) Creates a new package version in the system.
ContentServiceRequest	createRemoveRequest(int resourceId, java.lang.String username, int[] installedPackageIds, java.lang.String requestNotes) For internal use only - Adds a request entry to the database to track the deleting of currently installed packages from the resource.
ContentServiceRequest	createRetrieveBitsRequest(int resourceId, java.lang.String username, int installedPackageId) For internal use only - Adds a request entry to the database to track the request for a package's bits.
void	deletePackages(Subject user, int[] resourceIds, int[] installedPackageIds) Deletes the specified package from the resource.
void	deletePackages(Subject user, int resourceId, int[] installedPackageIds, java.lang.String requestNotes) Deletes the specified package from the resource.
void	deployPackages(Subject user, int[] resourceIds, int[] packageVersionIds) Deploys packages on the specified resources.
void	deployPackages(Subject user, int resourceId, java.util.Set<ResourcePackageDetails> packages, java.lang.String requestNotes) Deploys a package on the specified resource.
void	failRequest(int requestId, java.lang.Throwable error) For internal use only - Updates a persisted ContentServiceRequest in the case a failure is encountered during one of the use case methods (i.e.
java.util.List<Architecture>	findArchitectures(Subject subject) Returns all architectures known to the system.
PageList<InstalledPackage>	findInstalledPackagesByCriteria(Subject subject, InstalledPackageCriteria criteria)
java.util.List<java.lang.String>	findInstalledPackageVersions(Subject user, int resourceId) Returns list of version strings for installed packages on the resource.
java.util.List<PackageType>	findPackageTypes(Subject subject, java.lang.String resourceTypeName, java.lang.String pluginName) This gets the package types that can be deployed to the given resource.
PageList<PackageVersion>	findPackageVersionsByCriteria(Subject subject, PackageVersionCriteria criteria) If a resourceId filter is not set via PackageVersionCriteria.addFilterResourceId() then this method requires InventoryManager permissions.
InstalledPackage	getBackingPackageForResource(Subject subject, int resourceId) For a resource that is content-backed (aka package-backed), this call will return InstalledPackage information for the backing content (package).
Architecture	getNoArchitecture() Returns the entity associated with no architecture.
byte[]	getPackageBytes(Subject user, int resourceId, int installedPackageId)
PackageType	getResourceCreationPackageType(int resourceTypeId) Returns the package type that backs resources of the specified type.
java.util.Set<ResourcePackageDetails>	loadDependencies(int requestId, java.util.Set<PackageDetailsKey> keys) For documentation, see ContentServerService.loadDependencies(int, java.util.Set)
void	mergeDiscoveredPackages(ContentDiscoveryReport report) For documentation, see ContentServerService.mergeDiscoveredPackages(org.rhq.core.domain.content.transfer.ContentDiscoveryReport) .
Package	persistOrMergePackageSafely(Package pkg) Finds, and if it doesn't exist, persists the package.
PackageVersion	persistOrMergePackageVersionSafely(PackageVersion pv) Finds, and if it doesn't exist, persists the package version.
Package	persistPackage(Package pkg) Very simple method that pesists the given package within its own transaction.
PackageVersion	persistPackageVersion(PackageVersion pv) Very simple method that persists the given package version within its own transaction.
void	retrieveBitsFromResource(Subject user, int resourceId, int installedPackageId) Requests the plugin load and send the actual bits for the specified package.
java.util.List<DeployPackageStep>	translateInstallationSteps(int resourceId, ResourcePackageDetails packageDetails) Requests the plugin translate the installation steps of the specified package.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContentManagerBean

public ContentManagerBean()

Method Detail

mergeDiscoveredPackages

public void mergeDiscoveredPackages(ContentDiscoveryReport report)

Description copied from interface: ContentManagerLocal

For documentation, see ContentServerService.mergeDiscoveredPackages(org.rhq.core.domain.content.transfer.ContentDiscoveryReport) .

Specified by:

mergeDiscoveredPackages in interface ContentManagerLocal

deployPackages

public void deployPackages(Subject user,
                           int[] resourceIds,
                           int[] packageVersionIds)

Description copied from interface: ContentManagerRemote

Deploys packages on the specified resources. Each installed package entry should be populated with the PackageVersion being installed, along with the deployment configuration values if any. This method will take care of populating the rest of the values in each installed package object.

Specified by:

deployPackages in interface ContentManagerLocal

Specified by:

deployPackages in interface ContentManagerRemote

Parameters:

user - The logged in subject

resourceIds - identifies the resources against which the package will be deployed

packageVersionIds - packageVersions we want to install

See Also:

ContentManagerRemote#deployPackages(Subject, int[], int[])}

deployPackages

public void deployPackages(Subject user,
                           int resourceId,
                           java.util.Set<ResourcePackageDetails> packages,
                           java.lang.String requestNotes)

Description copied from interface: ContentManagerLocal

Deploys a package on the specified resource. Each installed package entry should be populated with the PackageVersion being installed, along with the deployment configuration values if any. This method will take care of populating the rest of the values in each installed package object.

Specified by:

deployPackages in interface ContentManagerLocal

Parameters:

user - the user who is requesting the creation

resourceId - identifies the resource against which the package will be deployed

packages - packages (with their deployment time configuration values) to deploy

requestNotes - user-specified notes on what is contained in this request

createDeployRequest

public ContentServiceRequest createDeployRequest(int resourceId,
                                                 java.lang.String username,
                                                 java.util.Set<ResourcePackageDetails> packages,
                                                 java.lang.String notes)

Description copied from interface: ContentManagerLocal

For internal use only - Adds a request entry to the database to track the deployment of a group of packages. This will be performed in a new transaction.

Specified by:

createDeployRequest in interface ContentManagerLocal

Parameters:

resourceId - resource against which the package request was executed

username - user who made the request

packages - packages being deployed in the request

notes - user-specified notes on what the request entails

Returns:

request entity after being persisted to the database (it's ID will be populated)

completeDeployPackageRequest

public void completeDeployPackageRequest(DeployPackagesResponse response)

Description copied from interface: ContentManagerLocal

For documentation, see ContentServerService.completeDeployPackageRequest(org.rhq.core.domain.content.transfer.DeployPackagesResponse) .

Specified by:

completeDeployPackageRequest in interface ContentManagerLocal

deletePackages

public void deletePackages(Subject user,
                           int[] resourceIds,
                           int[] installedPackageIds)

Description copied from interface: ContentManagerLocal

Deletes the specified package from the resource.

Specified by:

deletePackages in interface ContentManagerLocal

Parameters:

user - the user who is requesting the delete

resourceIds - identifies the resources from which the packages should be deleted

installedPackageIds - identifies all of the packages to be deleted

deletePackages

public void deletePackages(Subject user,
                           int resourceId,
                           int[] installedPackageIds,
                           java.lang.String requestNotes)

Description copied from interface: ContentManagerRemote

Deletes the specified package from the resource.

Specified by:

deletePackages in interface ContentManagerLocal

Specified by:

deletePackages in interface ContentManagerRemote

Parameters:

user - The logged in subject

resourceId - identifies the resource from which the packages should be deleted

installedPackageIds - identifies all of the packages to be deleted

See Also:

ContentManagerRemote#deletePackages(Subject, int, int[], String)}

createRemoveRequest

public ContentServiceRequest createRemoveRequest(int resourceId,
                                                 java.lang.String username,
                                                 int[] installedPackageIds,
                                                 java.lang.String requestNotes)

Description copied from interface: ContentManagerLocal

For internal use only - Adds a request entry to the database to track the deleting of currently installed packages from the resource. This will be performed in a new transaction.

Specified by:

createRemoveRequest in interface ContentManagerLocal

Parameters:

resourceId - resource against which the package request was executed

username - user who made the request

installedPackageIds - identifies the installed packages that are to be deleted; ids in this list must be of valid InstalledPackage objects on the resource

requestNotes - user-specified notes on what the request entails

Returns:

request entity after being persisted to the database (it's ID will be populated)

completeDeletePackageRequest

public void completeDeletePackageRequest(RemovePackagesResponse response)

Description copied from interface: ContentManagerLocal

For documentation, see ContentServerService.completeDeletePackageRequest(org.rhq.core.domain.content.transfer.RemovePackagesResponse) .

Specified by:

completeDeletePackageRequest in interface ContentManagerLocal

retrieveBitsFromResource

public void retrieveBitsFromResource(Subject user,
                                     int resourceId,
                                     int installedPackageId)

Description copied from interface: ContentManagerLocal

Requests the plugin load and send the actual bits for the specified package.

Specified by:

retrieveBitsFromResource in interface ContentManagerLocal

Parameters:

user - the user who is requesting the update

resourceId - identifies the resource against which the package exists

installedPackageId - id of the installed package to retrieve bits

getPackageBytes

public byte[] getPackageBytes(Subject user,
                              int resourceId,
                              int installedPackageId)

Specified by:

getPackageBytes in interface ContentManagerLocal

Specified by:

getPackageBytes in interface ContentManagerRemote

translateInstallationSteps

public java.util.List<DeployPackageStep> translateInstallationSteps(int resourceId,
                                                                    ResourcePackageDetails packageDetails)
                                                             throws java.lang.Exception

Description copied from interface: ContentManagerLocal

Requests the plugin translate the installation steps of the specified package.

Specified by:

translateInstallationSteps in interface ContentManagerLocal

Parameters:

resourceId - resource against which the package is being installed

packageDetails - package being installed

Returns:

list of deployment steps if the plugin specified them; null if they cannot be determined for this package

Throws:

java.lang.Exception - if there is an error either contacting the agent or in the plugin's generation of the steps

createRetrieveBitsRequest

public ContentServiceRequest createRetrieveBitsRequest(int resourceId,
                                                       java.lang.String username,
                                                       int installedPackageId)

Description copied from interface: ContentManagerLocal

For internal use only - Adds a request entry to the database to track the request for a package's bits. This will be performed in a new transaction.

Specified by:

createRetrieveBitsRequest in interface ContentManagerLocal

Parameters:

resourceId - resource against which the package request was executed

username - user who made the request

installedPackageId - package whose bits are being retrieved by the request; this must be the ID of a valid InstalledPackage on the resource.

Returns:

request entity after being persisted to the database (it's ID will be populated)

completeRetrievePackageBitsRequest

public void completeRetrievePackageBitsRequest(ContentServiceResponse response,
                                               java.io.InputStream bitStream)

Description copied from interface: ContentManagerLocal

For documentation, see ContentServerService.completeRetrievePackageBitsRequest(org.rhq.core.clientapi.server.content.ContentServiceResponse, java.io.InputStream) )}.

Specified by:

completeRetrievePackageBitsRequest in interface ContentManagerLocal

loadDependencies

public java.util.Set<ResourcePackageDetails> loadDependencies(int requestId,
                                                              java.util.Set<PackageDetailsKey> keys)

Description copied from interface: ContentManagerLocal

For documentation, see ContentServerService.loadDependencies(int, java.util.Set)

Specified by:

loadDependencies in interface ContentManagerLocal

failRequest

public void failRequest(int requestId,
                        java.lang.Throwable error)

Description copied from interface: ContentManagerLocal

For internal use only - Updates a persisted ContentServiceRequest in the case a failure is encountered during one of the use case methods (i.e. create, delete).

Specified by:

failRequest in interface ContentManagerLocal

Parameters:

requestId - identifies the previously persisted request

error - error encountered to cause the failure

findArchitectures

public java.util.List<Architecture> findArchitectures(Subject subject)

Description copied from interface: ContentManagerRemote

Returns all architectures known to the system.

Specified by:

findArchitectures in interface ContentManagerLocal

Specified by:

findArchitectures in interface ContentManagerRemote

Parameters:

subject - The logged in subject

Returns:

list of all architectures in the database

See Also:

ContentManagerRemote#findArchitectures(Subject)}

getNoArchitecture

public Architecture getNoArchitecture()

Description copied from interface: ContentManagerLocal

Returns the entity associated with no architecture.

Specified by:

getNoArchitecture in interface ContentManagerLocal

Returns:

no architecture entity

findPackageTypes

public java.util.List<PackageType> findPackageTypes(Subject subject,
                                                    java.lang.String resourceTypeName,
                                                    java.lang.String pluginName)
                                             throws ResourceTypeNotFoundException

Description copied from interface: ContentManagerRemote

This gets the package types that can be deployed to the given resource. It is a function of the resource type of the resource.

Specified by:

findPackageTypes in interface ContentManagerLocal

Specified by:

findPackageTypes in interface ContentManagerRemote

Parameters:

subject - The logged in subject

resourceTypeName - The resource type in question

Returns:

The requested list of package types. Can be empty.

Throws:

ResourceTypeNotFoundException

See Also:

ContentManagerRemote#findPackageTypes(Subject, String, String)}

checkForTimedOutRequests

public void checkForTimedOutRequests(Subject subject)

Description copied from interface: ContentManagerLocal

For internal use only - Will check to see if any in progress content request jobs are taking too long to finish and if so marks them as failed. This method will be periodically called by the Server.

Specified by:

checkForTimedOutRequests in interface ContentManagerLocal

Parameters:

subject - only the overlord may execute this system operation

createPackageVersion

public PackageVersion createPackageVersion(Subject subject,
                                           java.lang.String packageName,
                                           int packageTypeId,
                                           java.lang.String version,
                                           java.lang.Integer architectureId,
                                           byte[] packageBytes)

Description copied from interface: ContentManagerRemote

Creates a new package version in the system. If the parent package (identified by the packageName parameter) does not exist, it will be created. If a package version exists with the specified version ID, a new one will not be created and the existing package version instance will be returned.

Specified by:

createPackageVersion in interface ContentManagerLocal

Specified by:

createPackageVersion in interface ContentManagerRemote

Parameters:

subject - The logged in subject

packageName - parent package name; uniquely identifies the package under which this version goes

packageTypeId - identifies the type of package in case the general package needs to be created

version - identifies the version to be create

architectureId - architecture of the newly created package version. If null then no architecture restriction.

Returns:

newly created package version if one did not exist; existing package version that matches these data if one was found

See Also:

createPackageVersion(Subject, String, int, String, int, byte[]);

createPackageVersion

public PackageVersion createPackageVersion(java.lang.String packageName,
                                           int packageTypeId,
                                           java.lang.String version,
                                           int architectureId,
                                           java.io.InputStream packageBitStream)

Description copied from interface: ContentManagerLocal

Creates a new package version in the system. If the parent package (identified by the packageName parameter) does not exist, it will be created. If a package version exists with the specified version ID, a new one will not be created and the existing package version instance will be returned.

Specified by:

createPackageVersion in interface ContentManagerLocal

Parameters:

packageName - parent package name; uniquely identifies the package under which this version goes

packageTypeId - identifies the type of package in case the general package needs to be created

version - identifies the version to be create

architectureId - architecture of the newly created package version

Returns:

newly created package version if one did not exist; existing package version that matches these data if one was found

persistPackageVersion

public PackageVersion persistPackageVersion(PackageVersion pv)

Description copied from interface: ContentManagerLocal

Very simple method that persists the given package version within its own transaction.

This method is here to support ContentManagerLocal.persistOrMergePackageVersionSafely(PackageVersion), it is not meant for general consumption.

Specified by:

persistPackageVersion in interface ContentManagerLocal

Parameters:

pv - the package version to persist

Returns:

the newly persisted package version

persistOrMergePackageVersionSafely

public PackageVersion persistOrMergePackageVersionSafely(PackageVersion pv)

Description copied from interface: ContentManagerLocal

Finds, and if it doesn't exist, persists the package version. If it already exists, it will return the merge the given PV with the object it found and return the merged PV. This performs its tasks safely; that is, it makes sure that no contraint violations occur if the package version already exists.

This method is for a very specific use case - that is, when creating a package version in a place where, concurrently, someone else might try to create the same package version. It is not for general persisting/merging of package versions.

Specified by:

persistOrMergePackageVersionSafely in interface ContentManagerLocal

Parameters:

pv - the package version to find and possibly persist to the database

Returns:

the package version that was found/persisted

persistPackage

public Package persistPackage(Package pkg)

Description copied from interface: ContentManagerLocal

Very simple method that pesists the given package within its own transaction.

This method is here to support ContentManagerLocal.persistOrMergePackageSafely(Package), it is not meant for general consumption.

Specified by:

persistPackage in interface ContentManagerLocal

Parameters:

pkg - the package to persist

Returns:

the newly persisted package

persistOrMergePackageSafely

public Package persistOrMergePackageSafely(Package pkg)

Description copied from interface: ContentManagerLocal

Finds, and if it doesn't exist, persists the package. If it already exists, it will return the merge the given package with the object it found and return the merged package. This performs its tasks safely; that is, it makes sure that no contraint violations occur if the package already exists.

This method is for a very specific use case - that is, when creating a package in a place where, concurrently, someone else might try to create the same package. It is not for general persisting/merging of packages.

Specified by:

persistOrMergePackageSafely in interface ContentManagerLocal

Parameters:

pkg - the package to find and possibly persist to the database

Returns:

the package that was found/persisted

getResourceCreationPackageType

public PackageType getResourceCreationPackageType(int resourceTypeId)

Description copied from interface: ContentManagerLocal

Returns the package type that backs resources of the specified type.

Specified by:

getResourceCreationPackageType in interface ContentManagerLocal

Parameters:

resourceTypeId - identifies the resource type.

Returns:

backing package type if one exists; null otherwise

findInstalledPackageVersions

public java.util.List<java.lang.String> findInstalledPackageVersions(Subject user,
                                                                     int resourceId)

Description copied from interface: ContentManagerLocal

Returns list of version strings for installed packages on the resource.

Specified by:

findInstalledPackageVersions in interface ContentManagerLocal

Returns:

List of InstalledPackage versions

findInstalledPackagesByCriteria

public PageList<InstalledPackage> findInstalledPackagesByCriteria(Subject subject,
                                                                  InstalledPackageCriteria criteria)

Specified by:

findInstalledPackagesByCriteria in interface ContentManagerLocal

Specified by:

findInstalledPackagesByCriteria in interface ContentManagerRemote

criteria - InstalledPackageCriteria

Returns:

InstalledPackages for the criteria

See Also:

ContentManagerRemote#findInstalledPackagesByCriteria(Subject, InstalledPackageCriteria)}

findPackageVersionsByCriteria

public PageList<PackageVersion> findPackageVersionsByCriteria(Subject subject,
                                                              PackageVersionCriteria criteria)

Description copied from interface: ContentManagerRemote

If a resourceId filter is not set via PackageVersionCriteria.addFilterResourceId() then this method requires InventoryManager permissions. When set the user must have permission to view the resource.

Specified by:

findPackageVersionsByCriteria in interface ContentManagerLocal

Specified by:

findPackageVersionsByCriteria in interface ContentManagerRemote

Returns:

Installed PackageVersions for the resource

See Also:

ContentManagerRemote#findPackageVersionsByCriteria(Subject, PackageVersionCriteria)}

getBackingPackageForResource

public InstalledPackage getBackingPackageForResource(Subject subject,
                                                     int resourceId)

Description copied from interface: ContentManagerRemote

For a resource that is content-backed (aka package-backed), this call will return InstalledPackage information for the backing content (package).

Specified by:

getBackingPackageForResource in interface ContentManagerLocal

Specified by:

getBackingPackageForResource in interface ContentManagerRemote

resourceId - a valid resource

Returns:

The InstalledPackage object for the content-packed resource. Or null for non-existent or non-package backed resource.

See Also:

ContentManagerRemote#getBackingPackageForResource(Subject, int)