org.rhq.enterprise.server.content

Interface ContentManagerRemote

All Known Subinterfaces:

ContentManagerLocal

All Known Implementing Classes:

ContentManagerBean

public interface ContentManagerRemote

Author:

Jay Shaughnessy

Method Summary

Methods

Modifier and Type	Method and Description
org.rhq.core.domain.content.PackageVersion	createPackageVersion(org.rhq.core.domain.auth.Subject subject, String packageName, int packageTypeId, String version, Integer architectureId, byte[] packageBytes) Creates a new package version in the system.
org.rhq.core.domain.content.PackageVersion	createPackageVersionWithDisplayVersion(org.rhq.core.domain.auth.Subject subject, String packageName, int packageTypeId, String version, String displayVersion, Integer architectureId, byte[] packageBytes) Creates a new package version in the system.
org.rhq.core.domain.content.PackageVersion	createPackageVersionWithDisplayVersion(org.rhq.core.domain.auth.Subject subject, String packageName, int packageTypeId, String version, String displayVersion, Integer architectureId, String temporaryContentHandle) Creates a new package version in the system with content denoted by the temporaryContentHandle.
String	createTemporaryContentHandle() Creates a temporary file for fragmented content upload.
void	deletePackages(org.rhq.core.domain.auth.Subject subject, int resourceId, int[] installedPackageIds, String requestNotes) Deletes the specified package from the resource.
void	deletePackageVersion(org.rhq.core.domain.auth.Subject subject, int packageVersionId) Deletes the specified PackageVersion from the system.
void	deployPackages(org.rhq.core.domain.auth.Subject subject, int[] resourceIds, int[] packageVersionIds) Deprecated.
void	deployPackagesWithNote(org.rhq.core.domain.auth.Subject subject, int[] resourceIds, int[] packageVersionIds, String requestNotes) Deploys packages on the specified resources.
List<org.rhq.core.domain.content.Architecture>	findArchitectures(org.rhq.core.domain.auth.Subject subject) Returns all architectures known to the system.
org.rhq.core.domain.util.PageList<org.rhq.core.domain.content.InstalledPackage>	findInstalledPackagesByCriteria(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.criteria.InstalledPackageCriteria criteria)
org.rhq.core.domain.util.PageList<org.rhq.core.domain.content.Package>	findPackagesByCriteria(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.criteria.PackageCriteria criteria) If the criteria object filters on repo id, the subject needs to be able to access that repo.
org.rhq.core.domain.util.PageList<org.rhq.core.domain.content.composite.PackageAndLatestVersionComposite>	findPackagesWithLatestVersion(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.criteria.PackageCriteria criteria) Akin to findPackagesByCriteria(Subject, PackageCriteria) but also determines the latest version of the returned packages.
org.rhq.core.domain.content.PackageType	findPackageType(org.rhq.core.domain.auth.Subject subject, Integer resourceTypeId, String packageTypeName) This re tries to find a package type of given name defined by the resource type provided.
List<org.rhq.core.domain.content.PackageType>	findPackageTypes(org.rhq.core.domain.auth.Subject subject, String resourceTypeName, String pluginName) This gets the package types that can be deployed to the given resource.
org.rhq.core.domain.content.composite.PackageTypeAndVersionFormatComposite	findPackageTypeWithVersionFormat(org.rhq.core.domain.auth.Subject subject, Integer resourceTypeId, String packageTypeName) Similar to findPackageType(Subject, Integer, String) but returns the package type along with the version format specification.
org.rhq.core.domain.util.PageList<org.rhq.core.domain.content.PackageVersion>	findPackageVersionsByCriteria(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.criteria.PackageVersionCriteria criteria) If a resourceId filter is not set via PackageVersionCriteria.addFilterResourceId(Integer) then this method requires InventoryManager permissions.
org.rhq.core.domain.content.InstalledPackage	getBackingPackageForResource(org.rhq.core.domain.auth.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).
byte[]	getPackageBytes(org.rhq.core.domain.auth.Subject subject, int resourceId, int installedPackageId) This can be a dangerous call for large packages as the entire package will attempt to be loaded.
void	uploadContentFragment(String temporaryContentHandle, byte[] fragment, int off, int len) Saves the fragment in the temporary file denoted by temporaryContentHandle.

Method Detail

createPackageVersion

org.rhq.core.domain.content.PackageVersion createPackageVersion(org.rhq.core.domain.auth.Subject subject,
                                                              String packageName,
                                                              int packageTypeId,
                                                              String version,
                                                              Integer architectureId,
                                                              byte[] packageBytes)

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.

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.

packageBytes -

Returns:

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

createPackageVersionWithDisplayVersion

org.rhq.core.domain.content.PackageVersion createPackageVersionWithDisplayVersion(org.rhq.core.domain.auth.Subject subject,
                                                                                String packageName,
                                                                                int packageTypeId,
                                                                                String version,
                                                                                String displayVersion,
                                                                                Integer architectureId,
                                                                                byte[] packageBytes)

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.

Use this method with caution: passing a content file as a byte array is memory hungry. Consider calling createPackageVersionWithDisplayVersion(org.rhq.core.domain.auth.Subject, String, int, String, String, Integer, String) instead.

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

displayVersion -

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

packageBytes -

Returns:

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

deletePackages

void deletePackages(org.rhq.core.domain.auth.Subject subject,
                  int resourceId,
                  int[] installedPackageIds,
                  String requestNotes)

Deletes the specified package from the resource.

Parameters:

subject - The logged in subject

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

installedPackageIds - identifies all of the packages to be deleted

requestNotes -

deletePackageVersion

void deletePackageVersion(org.rhq.core.domain.auth.Subject subject,
                        int packageVersionId)

Deletes the specified PackageVersion from the system. The PackageVersion must be an orphan to be deleted. If it is referenced by a content source, repo or installed package it must be removed via the higher level construct and this call will have no effect.

Parameters:

subject - The logged in subject

packageVersionId - The package version to delete

deployPackages

@Deprecated
void deployPackages(org.rhq.core.domain.auth.Subject subject,
                             int[] resourceIds,
                             int[] packageVersionIds)

Deprecated.

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.

Parameters:

subject - The logged in subject

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

packageVersionIds - packageVersions we want to install

deployPackagesWithNote

void deployPackagesWithNote(org.rhq.core.domain.auth.Subject subject,
                          int[] resourceIds,
                          int[] packageVersionIds,
                          String requestNotes)

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.

Parameters:

subject - The logged in subject

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

packageVersionIds - packageVersions we want to install

requestNotes - request notes

findArchitectures

List<org.rhq.core.domain.content.Architecture> findArchitectures(org.rhq.core.domain.auth.Subject subject)

Returns all architectures known to the system.

Parameters:

subject - The logged in subject

Returns:

list of all architectures in the database

findPackageTypes

List<org.rhq.core.domain.content.PackageType> findPackageTypes(org.rhq.core.domain.auth.Subject subject,
                                                             String resourceTypeName,
                                                             String pluginName)
                                                               throws ResourceTypeNotFoundException

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

Parameters:

subject - The logged in subject

resourceTypeName - The resource type in question

pluginName -

Returns:

The requested list of package types. Can be empty.

Throws:

ResourceTypeNotFoundException

findPackageType

org.rhq.core.domain.content.PackageType findPackageType(org.rhq.core.domain.auth.Subject subject,
                                                      Integer resourceTypeId,
                                                      String packageTypeName)

This re tries to find a package type of given name defined by the resource type provided.

The resource type id can be null, in which case only the server-side defined package types are searched for.

Parameters:

subject - the authenticated user

resourceTypeId - the id of the resource type associated with the package type or null if only server-side package types should be searched for

packageTypeName - the name of the package type to find

Returns:

the package type or null if not found

findPackageTypeWithVersionFormat

org.rhq.core.domain.content.composite.PackageTypeAndVersionFormatComposite findPackageTypeWithVersionFormat(org.rhq.core.domain.auth.Subject subject,
                                                                                                          Integer resourceTypeId,
                                                                                                          String packageTypeName)

Similar to findPackageType(Subject, Integer, String) but returns the package type along with the version format specification.

Parameters:

subject -

resourceTypeId -

packageTypeName -

Returns:

the composite or null if not found

findInstalledPackagesByCriteria

org.rhq.core.domain.util.PageList<org.rhq.core.domain.content.InstalledPackage> findInstalledPackagesByCriteria(org.rhq.core.domain.auth.Subject subject,
                                                                                                              org.rhq.core.domain.criteria.InstalledPackageCriteria criteria)

Parameters:

subject -

criteria - InstalledPackageCriteria

Returns:

InstalledPackages for the criteria

findPackageVersionsByCriteria

org.rhq.core.domain.util.PageList<org.rhq.core.domain.content.PackageVersion> findPackageVersionsByCriteria(org.rhq.core.domain.auth.Subject subject,
                                                                                                          org.rhq.core.domain.criteria.PackageVersionCriteria criteria)

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

Parameters:

subject -

criteria -

Returns:

Installed PackageVersions for the resource

Throws:

IllegalArgumentException - for invalid resourceId filter

findPackagesByCriteria

org.rhq.core.domain.util.PageList<org.rhq.core.domain.content.Package> findPackagesByCriteria(org.rhq.core.domain.auth.Subject subject,
                                                                                            org.rhq.core.domain.criteria.PackageCriteria criteria)

If the criteria object filters on repo id, the subject needs to be able to access that repo. If there is no filter on repos, the subject needs to have MANAGE_REPOSITORIES permission.

Parameters:

subject -

criteria -

Returns:

the packages, not null

findPackagesWithLatestVersion

org.rhq.core.domain.util.PageList<org.rhq.core.domain.content.composite.PackageAndLatestVersionComposite> findPackagesWithLatestVersion(org.rhq.core.domain.auth.Subject subject,
                                                                                                                                      org.rhq.core.domain.criteria.PackageCriteria criteria)

Akin to findPackagesByCriteria(Subject, PackageCriteria) but also determines the latest version of the returned packages.

The provided criteria has to be limited to a specific repo using PackageCriteria.addFilterRepoId(Integer).

Parameters:

subject -

criteria -

Returns:

the composites, not null

Throws:

IllegalArgumentException - if the criteria doesn't define a repo filter

getBackingPackageForResource

org.rhq.core.domain.content.InstalledPackage getBackingPackageForResource(org.rhq.core.domain.auth.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).

Parameters:

subject -

resourceId - a valid resource

Returns:

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

getPackageBytes

byte[] getPackageBytes(org.rhq.core.domain.auth.Subject subject,
                     int resourceId,
                     int installedPackageId)

This can be a dangerous call for large packages as the entire package will attempt to be loaded.

Parameters:

subject -

resourceId -

installedPackageId -

Returns:

the package bytes

createTemporaryContentHandle

String createTemporaryContentHandle()

Creates a temporary file for fragmented content upload.

Returns:

a temporary file handle

Since:

4.10

uploadContentFragment

void uploadContentFragment(String temporaryContentHandle,
                         byte[] fragment,
                         int off,
                         int len)

Saves the fragment in the temporary file denoted by temporaryContentHandle. The fragment bytes will be copied starting from the off index up to the minimum of off+len and fragment.length.

Parameters:

temporaryContentHandle - temporary file handle

fragment - fragment bytes

off - the offset

len -

Since:

4.10

createPackageVersionWithDisplayVersion

org.rhq.core.domain.content.PackageVersion createPackageVersionWithDisplayVersion(org.rhq.core.domain.auth.Subject subject,
                                                                                String packageName,
                                                                                int packageTypeId,
                                                                                String version,
                                                                                String displayVersion,
                                                                                Integer architectureId,
                                                                                String temporaryContentHandle)

Creates a new package version in the system with content denoted by the temporaryContentHandle. Use this method instead of createPackageVersionWithDisplayVersion(org.rhq.core.domain.auth.Subject, String, int, String, String, Integer, byte[]) to avoid passing content files as byte array parameters.

Sample code:

 String temporaryContentHandle = contentManager.createTemporaryContentHandle();
 while (... more bytes to send) {
     contentManager.uploadContentFragment(temporaryContentHandle, ...);
 }
 PackageVersion pv = contentManager.createPackageVersionWithDisplayVersion(..., temporaryContentHandle);
 

Parameters:

subject -

packageName -

packageTypeId -

version -

displayVersion -

architectureId -

temporaryContentHandle -

Returns:

the package version

Since:

4.10

See Also:

createPackageVersionWithDisplayVersion(org.rhq.core.domain.auth.Subject, String, int, String, String, Integer, byte[])