org.rhq.enterprise.server.content

Interface ContentManagerLocal

All Superinterfaces:

ContentManagerRemote

All Known Implementing Classes:

ContentManagerBean

public interface ContentManagerLocal
extends ContentManagerRemote

EJB interface to the server content subsystem.

Author:

Jason Dobies

Field Summary

Fields

Modifier and Type	Field and Description
static String	UPLOAD_DISPLAY_VERSION
static String	UPLOAD_FILE_INSTALL_DATE
static String	UPLOAD_FILE_NAME
static String	UPLOAD_FILE_SIZE This is currently ignored as the file size is computed upon persist.
static String	UPLOAD_MD5
static String	UPLOAD_OWNER This doesn't seem to serve any purpose.
static String	UPLOAD_SHA256 This is currently ignored as the SHA is computed upon persist.

Method Summary

Methods

Modifier and Type	Method and Description
void	checkForTimedOutRequests(org.rhq.core.domain.auth.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(org.rhq.core.domain.content.transfer.RemovePackagesResponse response) For documentation, see ContentServerService.completeDeletePackageRequest(org.rhq.core.domain.content.transfer.RemovePackagesResponse) .
void	completeDeployPackageRequest(org.rhq.core.domain.content.transfer.DeployPackagesResponse response) For documentation, see ContentServerService.completeDeployPackageRequest(org.rhq.core.domain.content.transfer.DeployPackagesResponse) .
void	completeRetrievePackageBitsRequest(ContentServiceResponse response, InputStream bitStream) For documentation, see ContentServerService.completeRetrievePackageBitsRequest(org.rhq.core.clientapi.server.content.ContentServiceResponse, java.io.InputStream) )}.
org.rhq.core.domain.content.ContentServiceRequest	createDeployRequest(int resourceId, String username, Set<org.rhq.core.domain.content.transfer.ResourcePackageDetails> packages, String requestNotes) For internal use only - Adds a request entry to the database to track the deployment of a group of packages.
org.rhq.core.domain.content.PackageVersion	createPackageVersionWithDisplayVersion(org.rhq.core.domain.auth.Subject subject, String packageName, int packageTypeId, String version, String displayVersion, int architectureId, InputStream packageBitStream) Creates a new package version in the system.
org.rhq.core.domain.content.ContentServiceRequest	createRemoveRequest(int resourceId, String username, int[] installedPackageIds, String requestNotes) For internal use only - Adds a request entry to the database to track the deleting of currently installed packages from the resource.
org.rhq.core.domain.content.ContentServiceRequest	createRetrieveBitsRequest(int resourceId, 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(org.rhq.core.domain.auth.Subject user, int[] resourceIds, int[] installedPackageIds) Deletes the specified package from the resource.
void	deployPackages(org.rhq.core.domain.auth.Subject user, int resourceId, Set<org.rhq.core.domain.content.transfer.ResourcePackageDetails> packages, String requestNotes) Deploys a package on the specified resource.
void	failRequest(int requestId, 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.
List<String>	findInstalledPackageVersions(org.rhq.core.domain.auth.Subject subject, int resourceId) Returns list of version strings for installed packages on the resource.
org.rhq.core.domain.content.Architecture	getNoArchitecture() Returns the entity associated with no architecture.
org.rhq.core.domain.content.PackageType	getResourceCreationPackageType(int resourceTypeId) Returns the package type that backs resources of the specified type.
File	getTemporaryContentFile(String temporaryContentHandle) Get the file denoted by this temporaryContentHandle.
org.rhq.core.domain.content.PackageVersion	getUploadedPackageVersion(org.rhq.core.domain.auth.Subject subject, String packageName, int packageTypeId, String version, int architectureId, InputStream packageBitStream, Map<String,String> packageUploadDetails, Integer repoId) This method is essentially the same as #createPackageVersion(Subject, String, int, String, int, InputStream) but will update the package bits if a package version with the provided identification already exists.
void	handleDiscoveredPackage(org.rhq.core.domain.resource.Resource resource, org.rhq.core.domain.content.transfer.ResourcePackageDetails discoveredPackage, Set<org.rhq.core.domain.content.InstalledPackage> doomedPackages, long timestamp)
Set<org.rhq.core.domain.content.transfer.ResourcePackageDetails>	loadDependencies(int requestId, Set<org.rhq.core.domain.content.PackageDetailsKey> keys) For documentation, see ContentServerService.loadDependencies(int, java.util.Set)
void	mergeDiscoveredPackages(ContentDiscoveryReport report) For documentation, see ContentServerService.mergeDiscoveredPackages(org.rhq.core.clientapi.server.content.ContentDiscoveryReport) .
org.rhq.core.domain.content.Package	persistOrMergePackageSafely(org.rhq.core.domain.content.Package pkg) Finds, and if it doesn't exist, persists the package.
org.rhq.core.domain.content.PackageVersion	persistOrMergePackageVersionSafely(org.rhq.core.domain.content.PackageVersion pv) Finds, and if it doesn't exist, persists the package version.
org.rhq.core.domain.content.Package	persistPackage(org.rhq.core.domain.content.Package pkg) Very simple method that pesists the given package within its own transaction.
org.rhq.core.domain.content.PackageVersion	persistPackageVersion(org.rhq.core.domain.content.PackageVersion pv) Very simple method that persists the given package version within its own transaction.
org.rhq.core.domain.content.PackageType	persistServersidePackageType(org.rhq.core.domain.content.PackageType packageType) This method is used to persist new package types that are defined on the server-side by some kind of plugin.
void	removeInstalledPackages(org.rhq.core.domain.resource.Resource resource, Set<org.rhq.core.domain.content.InstalledPackage> doomedPackages, long timestamp)
void	retrieveBitsFromResource(org.rhq.core.domain.auth.Subject user, int resourceId, int installedPackageId) Requests the plugin load and send the actual bits for the specified package.
List<org.rhq.core.domain.content.transfer.DeployPackageStep>	translateInstallationSteps(int resourceId, org.rhq.core.domain.content.transfer.ResourcePackageDetails packageDetails) Requests the plugin translate the installation steps of the specified package.
void	updateBlobStream(InputStream stream, org.rhq.core.domain.content.PackageBits bits, Map<String,String> contentDetails)
void	writeBlobOutToStream(OutputStream stream, org.rhq.core.domain.content.PackageBits bits, boolean closeStreams)

Methods inherited from interface org.rhq.enterprise.server.content.ContentManagerRemote

createPackageVersion, createPackageVersionWithDisplayVersion, createPackageVersionWithDisplayVersion, createTemporaryContentHandle, deletePackages, deletePackageVersion, deployPackages, deployPackagesWithNote, findArchitectures, findInstalledPackagesByCriteria, findPackagesByCriteria, findPackagesWithLatestVersion, findPackageType, findPackageTypes, findPackageTypeWithVersionFormat, findPackageVersionsByCriteria, getBackingPackageForResource, getPackageBytes, uploadContentFragment

Field Detail

UPLOAD_FILE_SIZE

static final String UPLOAD_FILE_SIZE

This is currently ignored as the file size is computed upon persist.

See Also:

Constant Field Values

UPLOAD_FILE_INSTALL_DATE

static final String UPLOAD_FILE_INSTALL_DATE

See Also:

Constant Field Values

UPLOAD_OWNER

static final String UPLOAD_OWNER

This doesn't seem to serve any purpose.

See Also:

Constant Field Values

UPLOAD_FILE_NAME

static final String UPLOAD_FILE_NAME

See Also:

Constant Field Values

UPLOAD_MD5

static final String UPLOAD_MD5

See Also:

Constant Field Values

UPLOAD_DISPLAY_VERSION

static final String UPLOAD_DISPLAY_VERSION

See Also:

Constant Field Values

UPLOAD_SHA256

static final String UPLOAD_SHA256

This is currently ignored as the SHA is computed upon persist.

See Also:

Constant Field Values

Method Detail

deployPackages

void deployPackages(org.rhq.core.domain.auth.Subject user,
                  int resourceId,
                  Set<org.rhq.core.domain.content.transfer.ResourcePackageDetails> packages,
                  String requestNotes)

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.

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

deletePackages

void deletePackages(org.rhq.core.domain.auth.Subject user,
                  int[] resourceIds,
                  int[] installedPackageIds)

Deletes the specified package from the resource.

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

retrieveBitsFromResource

void retrieveBitsFromResource(org.rhq.core.domain.auth.Subject user,
                            int resourceId,
                            int installedPackageId)

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

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

translateInstallationSteps

List<org.rhq.core.domain.content.transfer.DeployPackageStep> translateInstallationSteps(int resourceId,
                                                                                      org.rhq.core.domain.content.transfer.ResourcePackageDetails packageDetails)
                                                                                        throws Exception

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

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:

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

mergeDiscoveredPackages

void mergeDiscoveredPackages(ContentDiscoveryReport report)

For documentation, see ContentServerService.mergeDiscoveredPackages(org.rhq.core.clientapi.server.content.ContentDiscoveryReport) .

completeDeployPackageRequest

void completeDeployPackageRequest(org.rhq.core.domain.content.transfer.DeployPackagesResponse response)

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

completeDeletePackageRequest

void completeDeletePackageRequest(org.rhq.core.domain.content.transfer.RemovePackagesResponse response)

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

completeRetrievePackageBitsRequest

void completeRetrievePackageBitsRequest(ContentServiceResponse response,
                                      InputStream bitStream)

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

loadDependencies

Set<org.rhq.core.domain.content.transfer.ResourcePackageDetails> loadDependencies(int requestId,
                                                                                Set<org.rhq.core.domain.content.PackageDetailsKey> keys)

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

createDeployRequest

org.rhq.core.domain.content.ContentServiceRequest createDeployRequest(int resourceId,
                                                                    String username,
                                                                    Set<org.rhq.core.domain.content.transfer.ResourcePackageDetails> packages,
                                                                    String requestNotes)

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.

Parameters:

resourceId - resource against which the package request was executed

username - user who made the request

packages - packages being deployed in the request

requestNotes - user-specified notes on what the request entails

Returns:

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

createRemoveRequest

org.rhq.core.domain.content.ContentServiceRequest createRemoveRequest(int resourceId,
                                                                    String username,
                                                                    int[] installedPackageIds,
                                                                    String requestNotes)

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.

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)

createRetrieveBitsRequest

org.rhq.core.domain.content.ContentServiceRequest createRetrieveBitsRequest(int resourceId,
                                                                          String username,
                                                                          int installedPackageId)

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.

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)

failRequest

void failRequest(int requestId,
               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. create, delete).

Parameters:

requestId - identifies the previously persisted request

error - error encountered to cause the failure

checkForTimedOutRequests

void checkForTimedOutRequests(org.rhq.core.domain.auth.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. This method will be periodically called by the Server.

Parameters:

subject - only the overlord may execute this system operation

createPackageVersionWithDisplayVersion

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

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 user requesting the package creation

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 - package display version

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

getUploadedPackageVersion

org.rhq.core.domain.content.PackageVersion getUploadedPackageVersion(org.rhq.core.domain.auth.Subject subject,
                                                                   String packageName,
                                                                   int packageTypeId,
                                                                   String version,
                                                                   int architectureId,
                                                                   InputStream packageBitStream,
                                                                   Map<String,String> packageUploadDetails,
                                                                   Integer repoId)

This method is essentially the same as #createPackageVersion(Subject, String, int, String, int, InputStream) but will update the package bits if a package version with the provided identification already exists.

Parameters:

subject - the current user

packageName - the name of the package (the general package will be created if none exists)

packageTypeId - the id of the package type. This is ignored if the newResourceTypeId is not null

version - the version of the package version being created

architectureId - the architecture of the package version

packageBitStream - the input stream with the package bits

packageUploadDetails - additional details about the package. See the constants defined in this interface

repoId - an optional id of the repo to insert the package version in

Returns:

the newly create package version

persistPackageVersion

org.rhq.core.domain.content.PackageVersion persistPackageVersion(org.rhq.core.domain.content.PackageVersion pv)

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

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

Parameters:

pv - the package version to persist

Returns:

the newly persisted package version

persistOrMergePackageVersionSafely

org.rhq.core.domain.content.PackageVersion persistOrMergePackageVersionSafely(org.rhq.core.domain.content.PackageVersion pv)

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.

Parameters:

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

Returns:

the package version that was found/persisted

persistPackage

org.rhq.core.domain.content.Package persistPackage(org.rhq.core.domain.content.Package pkg)

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

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

Parameters:

pkg - the package to persist

Returns:

the newly persisted package

persistOrMergePackageSafely

org.rhq.core.domain.content.Package persistOrMergePackageSafely(org.rhq.core.domain.content.Package pkg)

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.

Parameters:

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

Returns:

the package that was found/persisted

getNoArchitecture

org.rhq.core.domain.content.Architecture getNoArchitecture()

Returns the entity associated with no architecture.

Returns:

no architecture entity

findInstalledPackageVersions

List<String> findInstalledPackageVersions(org.rhq.core.domain.auth.Subject subject,
                                        int resourceId)

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

Parameters:

subject -

resourceId -

Returns:

List of InstalledPackage versions

getResourceCreationPackageType

org.rhq.core.domain.content.PackageType getResourceCreationPackageType(int resourceTypeId)

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

Parameters:

resourceTypeId - identifies the resource type.

Returns:

backing package type if one exists; null otherwise

persistServersidePackageType

org.rhq.core.domain.content.PackageType persistServersidePackageType(org.rhq.core.domain.content.PackageType packageType)

This method is used to persist new package types that are defined on the server-side by some kind of plugin.

Server-side package types are used to identify data stored in the content subsystem which don't have any agent-side counter-part. Such package types are required to have the resource type set to null.

Parameters:

packageType - the package type to persist

Returns:

the persisted package type

Throws:

IllegalArgumentException - if the supplied package type has non-null resource type

writeBlobOutToStream

void writeBlobOutToStream(OutputStream stream,
                        org.rhq.core.domain.content.PackageBits bits,
                        boolean closeStreams)

updateBlobStream

void updateBlobStream(InputStream stream,
                    org.rhq.core.domain.content.PackageBits bits,
                    Map<String,String> contentDetails)

getTemporaryContentFile

File getTemporaryContentFile(String temporaryContentHandle)

Get the file denoted by this temporaryContentHandle.

Parameters:

temporaryContentHandle -

Returns:

the file denoted by this temporaryContentHandle

See Also:

ContentManagerRemote.createTemporaryContentHandle()

handleDiscoveredPackage

void handleDiscoveredPackage(org.rhq.core.domain.resource.Resource resource,
                           org.rhq.core.domain.content.transfer.ResourcePackageDetails discoveredPackage,
                           Set<org.rhq.core.domain.content.InstalledPackage> doomedPackages,
                           long timestamp)

removeInstalledPackages

void removeInstalledPackages(org.rhq.core.domain.resource.Resource resource,
                           Set<org.rhq.core.domain.content.InstalledPackage> doomedPackages,
                           long timestamp)