public interface BundleManagerRemote
| Modifier and Type | Method and Description |
|---|---|
org.rhq.core.domain.bundle.BundleFile |
addBundleFile(org.rhq.core.domain.auth.Subject subject,
int bundleVersionId,
String name,
String version,
org.rhq.core.domain.content.Architecture architecture,
InputStream fileStream)
Adds a BundleFile to the BundleVersion and implicitly creates the backing PackageVersion.
|
org.rhq.core.domain.bundle.BundleFile |
addBundleFileViaByteArray(org.rhq.core.domain.auth.Subject subject,
int bundleVersionId,
String name,
String version,
org.rhq.core.domain.content.Architecture architecture,
byte[] fileBytes)
A convenience method taking a byte array as opposed to a stream for the file bits.
|
org.rhq.core.domain.bundle.BundleFile |
addBundleFileViaPackageVersion(org.rhq.core.domain.auth.Subject subject,
int bundleVersionId,
String name,
int packageVersionId)
A convenience method taking an existing PackageVersion as opposed to a stream for the file bits.
|
org.rhq.core.domain.bundle.BundleFile |
addBundleFileViaURL(org.rhq.core.domain.auth.Subject subject,
int bundleVersionId,
String name,
String version,
org.rhq.core.domain.content.Architecture architecture,
String bundleFileUrl)
A convenience method taking a URL String whose content will be streamed to the server and used for the file bits.
|
org.rhq.core.domain.bundle.BundleFile |
addBundleFileViaURL(org.rhq.core.domain.auth.Subject subject,
int bundleVersionId,
String name,
String version,
org.rhq.core.domain.content.Architecture architecture,
String bundleFileUrl,
String userName,
String password)
A variant of
addBundleFileViaURL(Subject, int, String, String, Architecture, String) supporting the
HTTP basic authentication. |
void |
assignBundlesToBundleGroups(org.rhq.core.domain.auth.Subject subject,
int[] bundleGroupIds,
int[] bundleIds)
Assign the specified bundles to the specified bundle groups.
|
org.rhq.core.domain.bundle.BundleDeployment |
createBundleDeployment(org.rhq.core.domain.auth.Subject subject,
int bundleVersionId,
int bundleDestinationId,
String description,
org.rhq.core.domain.configuration.Configuration configuration)
Create a new bundle deployment.
|
org.rhq.core.domain.bundle.BundleDestination |
createBundleDestination(org.rhq.core.domain.auth.Subject subject,
int bundleId,
String name,
String description,
String destinationSpecification,
String deployDir,
Integer groupId)
Creates a bundle destination that describes a target for the bundle deployments.
|
org.rhq.core.domain.bundle.BundleGroup |
createBundleGroup(org.rhq.core.domain.auth.Subject subject,
org.rhq.core.domain.bundle.BundleGroup bundleGroup)
Create a new bundle group.
|
org.rhq.core.domain.bundle.BundleVersion |
createBundleVersionViaByteArray(org.rhq.core.domain.auth.Subject subject,
byte[] fileBytes)
Creates a bundle version based on the actual bytes of a Bundle Distribution file.
|
org.rhq.core.domain.bundle.BundleVersion |
createBundleVersionViaContentHandle(org.rhq.core.domain.auth.Subject subject,
String temporaryContentHandle)
Like
createBundleVersionViaFile(org.rhq.core.domain.auth.Subject, java.io.File) except that this method
takes a temporaryContentHandle as parameter instead of a file. |
org.rhq.core.domain.bundle.BundleVersion |
createBundleVersionViaFile(org.rhq.core.domain.auth.Subject subject,
File distributionFile)
Creates a bundle version based on a Bundle Distribution file.
|
org.rhq.core.domain.bundle.BundleVersion |
createBundleVersionViaRecipe(org.rhq.core.domain.auth.Subject subject,
String recipe)
Creates a bundle version based on single recipe string.
|
org.rhq.core.domain.bundle.BundleVersion |
createBundleVersionViaURL(org.rhq.core.domain.auth.Subject subject,
String distributionFileUrl)
Creates a bundle version based on a Bundle Distribution file.
|
org.rhq.core.domain.bundle.BundleVersion |
createBundleVersionViaURL(org.rhq.core.domain.auth.Subject subject,
String distributionFileUrl,
String username,
String password)
A version of the
createBundleVersionViaURL(org.rhq.core.domain.auth.Subject, String) that accepts a
username and password for basic authentication on the HTTP URLs. |
org.rhq.core.domain.bundle.BundleVersion |
createInitialBundleVersionViaByteArray(org.rhq.core.domain.auth.Subject subject,
int[] bundleGroupIds,
byte[] fileBytes)
Like #createBundleVersionViaByteArray except this method will assume this is a new bundle and is responsible
for creating the bundle as well as the bundle version.
|
org.rhq.core.domain.bundle.BundleVersion |
createInitialBundleVersionViaContentHandle(org.rhq.core.domain.auth.Subject subject,
int[] bundleGroupIds,
String temporaryContentHandle)
Like
createInitialBundleVersionViaFile(org.rhq.core.domain.auth.Subject, int[], java.io.File), except
that this method takes a temporaryContentHandle as parameter instead of a file. |
org.rhq.core.domain.bundle.BundleVersion |
createInitialBundleVersionViaFile(org.rhq.core.domain.auth.Subject subject,
int[] bundleGroupIds,
File distributionFile)
Like #createBundleVersionViaFile except this method will assume this is a new bundle and is responsible
for creating the bundle as well as the bundle version.
|
org.rhq.core.domain.bundle.BundleVersion |
createInitialBundleVersionViaRecipe(org.rhq.core.domain.auth.Subject subject,
int[] bundleGroupIds,
String recipe)
Like #createBundleVersionViaRecipe except this method will assume this is a new bundle and is responsible
for creating the bundle as well as the bundle version.
|
org.rhq.core.domain.bundle.BundleVersion |
createInitialBundleVersionViaURL(org.rhq.core.domain.auth.Subject subject,
int[] bundleGroupIds,
String distributionFileUrl)
Like #createBundleVersionViaURL except this method will assume this is a new bundle and is responsible
for creating the bundle as well as the bundle version.
|
org.rhq.core.domain.bundle.BundleVersion |
createInitialBundleVersionViaURL(org.rhq.core.domain.auth.Subject subject,
int[] bundleGroupIds,
String distributionFileUrl,
String username,
String password)
Like #createBundleVersionViaURL except this method will assume this is a new bundle and is responsible
for creating the bundle as well as the bundle version.
|
void |
deleteBundle(org.rhq.core.domain.auth.Subject subject,
int bundleId)
Remove everything associated with the Bundle with the exception of files laid down by related deployments.
|
void |
deleteBundleGroups(org.rhq.core.domain.auth.Subject subject,
int[] ids)
Delete a bundle group.
|
void |
deleteBundles(org.rhq.core.domain.auth.Subject subject,
int[] bundleIds)
Remove everything associated with the Bundles with the exception of files laid down by related deployments.
|
void |
deleteBundleVersion(org.rhq.core.domain.auth.Subject subject,
int bundleVersionId,
boolean deleteBundleIfEmpty)
Remove everything associated with the BundleVersion with the exception of files laid down by related deployments.
|
org.rhq.core.domain.util.PageList<org.rhq.core.domain.bundle.BundleDeployment> |
findBundleDeploymentsByCriteria(org.rhq.core.domain.auth.Subject subject,
org.rhq.core.domain.criteria.BundleDeploymentCriteria criteria)
Return the
BundleDeployments narrowed by the supplied Criteria. |
org.rhq.core.domain.util.PageList<org.rhq.core.domain.bundle.BundleDestination> |
findBundleDestinationsByCriteria(org.rhq.core.domain.auth.Subject subject,
org.rhq.core.domain.criteria.BundleDestinationCriteria criteria)
Return the
BundleDestinations narrowed by the supplied Criteria. |
org.rhq.core.domain.util.PageList<org.rhq.core.domain.bundle.BundleFile> |
findBundleFilesByCriteria(org.rhq.core.domain.auth.Subject subject,
org.rhq.core.domain.criteria.BundleFileCriteria criteria) |
org.rhq.core.domain.util.PageList<org.rhq.core.domain.bundle.BundleGroup> |
findBundleGroupsByCriteria(org.rhq.core.domain.auth.Subject subject,
org.rhq.core.domain.criteria.BundleGroupCriteria criteria)
Return the
BundleGroups narrowed by the supplied Criteria. |
org.rhq.core.domain.util.PageList<org.rhq.core.domain.bundle.BundleResourceDeployment> |
findBundleResourceDeploymentsByCriteria(org.rhq.core.domain.auth.Subject subject,
org.rhq.core.domain.criteria.BundleResourceDeploymentCriteria criteria)
Note that this can involves permissions on bundles and resources.
|
org.rhq.core.domain.util.PageList<org.rhq.core.domain.bundle.Bundle> |
findBundlesByCriteria(org.rhq.core.domain.auth.Subject subject,
org.rhq.core.domain.criteria.BundleCriteria criteria)
Return the
Bundles narrowed by the supplied Criteria. |
org.rhq.core.domain.util.PageList<org.rhq.core.domain.bundle.composite.BundleWithLatestVersionComposite> |
findBundlesWithLatestVersionCompositesByCriteria(org.rhq.core.domain.auth.Subject subject,
org.rhq.core.domain.criteria.BundleCriteria criteria) |
org.rhq.core.domain.util.PageList<org.rhq.core.domain.bundle.BundleVersion> |
findBundleVersionsByCriteria(org.rhq.core.domain.auth.Subject subject,
org.rhq.core.domain.criteria.BundleVersionCriteria criteria) |
List<org.rhq.core.domain.bundle.BundleType> |
getAllBundleTypes(org.rhq.core.domain.auth.Subject subject) |
org.rhq.core.domain.bundle.BundleType |
getBundleType(org.rhq.core.domain.auth.Subject subject,
String bundleTypeName) |
Set<String> |
getBundleVersionFilenames(org.rhq.core.domain.auth.Subject subject,
int bundleVersionId,
boolean withoutBundleFileOnly)
Determine the files required for a BundleVersion and return all of the filenames or optionally, just those
that lack BundleFiles for the BundleVersion.
|
org.rhq.core.domain.bundle.ResourceTypeBundleConfiguration |
getResourceTypeBundleConfiguration(org.rhq.core.domain.auth.Subject subject,
int compatGroupId)
Given the ID for a compatible group, this will return the bundle configuration metadata for that group's resource type.
|
void |
purgeBundleDestination(org.rhq.core.domain.auth.Subject subject,
int bundleDestinationId)
Purges the destination's live deployment content from the remote platforms.
|
org.rhq.core.domain.bundle.BundleDeployment |
scheduleBundleDeployment(org.rhq.core.domain.auth.Subject subject,
int bundleDeploymentId,
boolean isCleanDeployment)
Deploy the bundle to the destination, as described in the provided deployment.
|
org.rhq.core.domain.bundle.BundleDeployment |
scheduleRevertBundleDeployment(org.rhq.core.domain.auth.Subject subject,
int bundleDestinationId,
String deploymentDescription,
boolean isCleanDeployment)
For the specified destination, revert from the current live deployment to the deployment it had replaced.
|
void |
unassignBundlesFromBundleGroups(org.rhq.core.domain.auth.Subject subject,
int[] bundleGroupIds,
int[] bundleIds)
Unassign the specified bundles from the specified bundle groups.
|
org.rhq.core.domain.bundle.BundleGroup |
updateBundleGroup(org.rhq.core.domain.auth.Subject subject,
org.rhq.core.domain.bundle.BundleGroup bundleGroup)
Updates an existing bundle group.
|
org.rhq.core.domain.bundle.ResourceTypeBundleConfiguration getResourceTypeBundleConfiguration(org.rhq.core.domain.auth.Subject subject,
int compatGroupId)
throws Exception
subject - the user making the requestcompatGroupId - the ID for a compatible group whose type's bundle config is to be returnedExceptionorg.rhq.core.domain.bundle.BundleFile addBundleFile(org.rhq.core.domain.auth.Subject subject,
int bundleVersionId,
String name,
String version,
org.rhq.core.domain.content.Architecture architecture,
InputStream fileStream)
throws Exception
addBundleFileViaPackageVersion(Subject, int, String, int)
Required Permissions: Either: - Global.CREATE_BUNDLES and Global.VIEW_BUNDLES - Global.CREATE_BUNDLES and BundleGroup.VIEW_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG - BundleGroup.CREATE_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG
subject - user that must have proper permissionsbundleVersionId - id of the BundleVersion incorporating this BundleFilename - name of the BundleFile (and the resulting Package)version - version of the backing packagearchitecture - architecture appropriate for the backing package. Defaults to noarch (i.e. any architecture).fileStream - the file bitsExceptionorg.rhq.core.domain.bundle.BundleFile addBundleFileViaByteArray(org.rhq.core.domain.auth.Subject subject,
int bundleVersionId,
String name,
String version,
org.rhq.core.domain.content.Architecture architecture,
byte[] fileBytes)
throws Exception
Required Permissions: Either: - Global.CREATE_BUNDLES and Global.VIEW_BUNDLES - Global.CREATE_BUNDLES and BundleGroup.VIEW_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG - BundleGroup.CREATE_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG
subject - user that must have proper permissionsbundleVersionId - id of the BundleVersion incorporating this BundleFilename - name of the BundleFile (and the resulting Package)version - version of the backing packagearchitecture - architecture appropriate for the backing package. Defaults to noarch (i.e. any architecture).fileBytes - Exception#addBundleFile(Subject, int, String, String, Architecture, InputStream)}org.rhq.core.domain.bundle.BundleFile addBundleFileViaURL(org.rhq.core.domain.auth.Subject subject,
int bundleVersionId,
String name,
String version,
org.rhq.core.domain.content.Architecture architecture,
String bundleFileUrl)
throws Exception
Required Permissions: Either: - Global.CREATE_BUNDLES and Global.VIEW_BUNDLES - Global.CREATE_BUNDLES and BundleGroup.VIEW_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG - BundleGroup.CREATE_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG
subject - user that must have proper permissionsbundleVersionId - id of the BundleVersion incorporating this BundleFilename - name of the BundleFile (and the resulting Package)version - version of the backing packagearchitecture - architecture appropriate for the backing package. Defaults to noarch (i.e. any architecture).bundleFileUrl - ExceptionaddBundleFile(Subject, int, String, String, Architecture, InputStream)org.rhq.core.domain.bundle.BundleFile addBundleFileViaURL(org.rhq.core.domain.auth.Subject subject,
int bundleVersionId,
String name,
String version,
org.rhq.core.domain.content.Architecture architecture,
String bundleFileUrl,
String userName,
String password)
throws Exception
addBundleFileViaURL(Subject, int, String, String, Architecture, String) supporting the
HTTP basic authentication.
Required Permissions: Either: - Global.CREATE_BUNDLES and Global.VIEW_BUNDLES - Global.CREATE_BUNDLES and BundleGroup.VIEW_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG - BundleGroup.CREATE_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG
subject - user that must have proper permissionsbundleVersionId - id of the BundleVersion incorporating this BundleFilename - name of the BundleFile (and the resulting Package)version - version of the backing packagearchitecture - architecture appropriate for the backing package. Defaults to noarch (i.e. any architecture).bundleFileUrl - userName - password - ExceptionaddBundleFileViaURL(Subject, int, String, String, Architecture, String)org.rhq.core.domain.bundle.BundleFile addBundleFileViaPackageVersion(org.rhq.core.domain.auth.Subject subject,
int bundleVersionId,
String name,
int packageVersionId)
throws Exception
Required Permissions: Either: - Global.CREATE_BUNDLES and Global.VIEW_BUNDLES - Global.CREATE_BUNDLES and BundleGroup.VIEW_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG - BundleGroup.CREATE_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG
subject - user that must have proper permissionsbundleVersionId - id of the BundleVersion incorporating this BundleFilename - name of the BundleFile (and the resulting Package)packageVersionId - Exception#addBundleFile(Subject, int, String, String, Architecture, InputStream)}void assignBundlesToBundleGroups(org.rhq.core.domain.auth.Subject subject,
int[] bundleGroupIds,
int[] bundleIds)
Requires VIEW permission for the relevant bundle and one of: - Global.MANAGE_BUNDLE_GROUPS - Global.CREATE_BUNDLE - BundleGroup.ASSIGN_BUNDLES_TO_GROUP for the relevant bundle group - BundleGroup.CREATE_BUNDLES_IN_GROUP for the relevant bundle group
subject - bundleGroupIds - bundleIds - org.rhq.core.domain.bundle.BundleDeployment createBundleDeployment(org.rhq.core.domain.auth.Subject subject,
int bundleVersionId,
int bundleDestinationId,
String description,
org.rhq.core.domain.configuration.Configuration configuration)
throws Exception
Required Permissions: Either: - Global.DEPLOY_BUNDLES and a view of the relevant bundle and a view of the relevant resource group (may involve multiple roles) - Resource.DEPLOY_BUNDLES_TO_GROUP and a view of the relevant bundle and a view of the relevant resource group (may involve multiple roles)
subject - user that must have proper permissionsbundleVersionId - the BundleVersion being deployed by this deploymentbundleDestinationId - the BundleDestination for the deploymentdescription - an optional longer description describing this deploymentconfiguration - a Configuration (pojo) to be associated with this deployment.
This is validated against the configuration definition provided by the
bundle version.Exceptionorg.rhq.core.domain.bundle.BundleDestination createBundleDestination(org.rhq.core.domain.auth.Subject subject,
int bundleId,
String name,
String description,
String destinationSpecification,
String deployDir,
Integer groupId)
throws Exception
Required Permissions: Either: - Global.DEPLOY_BUNDLES and a view of the relevant bundle and a view of the relevant resource group (may involve multiple roles) - Resource.DEPLOY_BUNDLES_TO_GROUP and a view of the relevant bundle and a view of the relevant resource group (may involve multiple roles)
subject - user must have MANAGE_INVENTORY permissionbundleId - the Bundle to be deployed to this Destinationname - a name for this destination. not null or emptydescription - an optional longer description describing this destinationdestinationSpecification - The name of the destination location where the bundle will be deployed.
deployDir is relative to the directory that this name refers to.
This name isn't the directory itself, it refers to the named location as
defined in the agent plugin's descriptor for the resource's type.deployDir - the root dir for deployments to this destination or null if the type of the bundle does not
require itgroupId - the target platforms for deployments to this destinationExceptionorg.rhq.core.domain.bundle.BundleGroup createBundleGroup(org.rhq.core.domain.auth.Subject subject,
org.rhq.core.domain.bundle.BundleGroup bundleGroup)
throws Exception
Require Permissions: - Global.MANAGE_BUNDLE_GROUPS
subject - user that must have proper permissionsbundleGroup - the new bundle group name the unique bundle group nameExceptionorg.rhq.core.domain.bundle.BundleVersion createBundleVersionViaRecipe(org.rhq.core.domain.auth.Subject subject,
String recipe)
throws Exception
Required Permissions: Either: - Global.CREATE_BUNDLES and Global.VIEW_BUNDLES - Global.CREATE_BUNDLES and BundleGroup.VIEW_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG - BundleGroup.CREATE_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG
subject - user that must have proper permissionsrecipe - the recipe that defines the bundle version to be createdExceptionorg.rhq.core.domain.bundle.BundleVersion createInitialBundleVersionViaRecipe(org.rhq.core.domain.auth.Subject subject,
int[] bundleGroupIds,
String recipe)
throws Exception
Required Permissions: Either: - Global.CREATE_BUNDLES and Global.VIEW_BUNDLES - Global.CREATE_BUNDLES and BundleGroup.VIEW_BUNDLES_IN_GROUP for bundle group BG - BundleGroup.CREATE_BUNDLES_IN_GROUP for bundle group BG
subject - user that must have proper permissionsbundleGroupIds - identifies the bundle groups that the new bundle will be associated with; null or zero
length to leave unassigned.recipe - the recipe that defines the bundle version to be createdExceptionorg.rhq.core.domain.bundle.BundleVersion createBundleVersionViaFile(org.rhq.core.domain.auth.Subject subject,
File distributionFile)
throws Exception
Required Permissions: Either: - Global.CREATE_BUNDLES and Global.VIEW_BUNDLES - Global.CREATE_BUNDLES and BundleGroup.VIEW_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG - BundleGroup.CREATE_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG
subject - user that must have proper permissionsdistributionFile - a local Bundle Distribution file. It must be read accessible by the RHQ server process.Exceptionorg.rhq.core.domain.bundle.BundleVersion createBundleVersionViaContentHandle(org.rhq.core.domain.auth.Subject subject,
String temporaryContentHandle)
throws Exception
createBundleVersionViaFile(org.rhq.core.domain.auth.Subject, java.io.File) except that this method
takes a temporaryContentHandle as parameter instead of a file.subject - user that must have proper permissionstemporaryContentHandle - ExceptionContentManagerRemote.createTemporaryContentHandle(),
ContentManagerRemote.uploadContentFragment(String, byte[], int, int),
createBundleVersionViaFile(org.rhq.core.domain.auth.Subject, java.io.File)org.rhq.core.domain.bundle.BundleVersion createInitialBundleVersionViaFile(org.rhq.core.domain.auth.Subject subject,
int[] bundleGroupIds,
File distributionFile)
throws Exception
Required Permissions: Either: - Global.CREATE_BUNDLES and Global.VIEW_BUNDLES - Global.CREATE_BUNDLES and BundleGroup.VIEW_BUNDLES_IN_GROUP for bundle group BG - BundleGroup.CREATE_BUNDLES_IN_GROUP for bundle group BG
subject - user that must have proper permissionsbundleGroupIds - identifies the bundle groups that the new bundle will be associated with; null or zero
length to leave unassigned.distributionFile - a local Bundle Distribution file. It must be read accessible by the RHQ server process.Exceptionorg.rhq.core.domain.bundle.BundleVersion createInitialBundleVersionViaContentHandle(org.rhq.core.domain.auth.Subject subject,
int[] bundleGroupIds,
String temporaryContentHandle)
throws Exception
createInitialBundleVersionViaFile(org.rhq.core.domain.auth.Subject, int[], java.io.File), except
that this method takes a temporaryContentHandle as parameter instead of a file.subject - user that must have proper permissionsbundleGroupIds - identifies the bundle groups that the new bundle will be associated with; null or zero
length to leave unassigned.temporaryContentHandle - ExceptionContentManagerRemote.createTemporaryContentHandle(),
ContentManagerRemote.uploadContentFragment(String, byte[], int, int),
createInitialBundleVersionViaFile(org.rhq.core.domain.auth.Subject, int[], java.io.File)org.rhq.core.domain.bundle.BundleVersion createBundleVersionViaByteArray(org.rhq.core.domain.auth.Subject subject,
byte[] fileBytes)
throws Exception
createBundleVersionViaFile(Subject, File) but the caller is providing the actual
bytes of the file as opposed to the file itself.
WARNING: obviously, this requires the entire distribution file to have been loaded fully in memory.
For very large distribution files, this could cause OutOfMemoryErrors.
If this bundle version is the initial version of a new bundle that needs to be created, the subject must
have Global.VIEW_BUNDLES because the new bundle will not be associated with any bundle group.
Required Permissions: Either: - Global.CREATE_BUNDLES and Global.VIEW_BUNDLES - Global.CREATE_BUNDLES and BundleGroup.VIEW_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG - BundleGroup.CREATE_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG
subject - user that must have proper permissionsfileBytes - the file bits that make up the entire bundle distribution fileExceptionorg.rhq.core.domain.bundle.BundleVersion createInitialBundleVersionViaByteArray(org.rhq.core.domain.auth.Subject subject,
int[] bundleGroupIds,
byte[] fileBytes)
throws Exception
Required Permissions: Either: - Global.CREATE_BUNDLES and Global.VIEW_BUNDLES - Global.CREATE_BUNDLES and BundleGroup.VIEW_BUNDLES_IN_GROUP for bundle group BG - BundleGroup.CREATE_BUNDLES_IN_GROUP for bundle group BG
subject - user that must have proper permissionsbundleGroupIds - identifies the bundle groups that the new bundle will be associated with; null or zero
length to leave unassigned.fileBytes - the file bits that make up the entire bundle distribution fileExceptionorg.rhq.core.domain.bundle.BundleVersion createBundleVersionViaURL(org.rhq.core.domain.auth.Subject subject,
String distributionFileUrl)
throws Exception
createBundleVersionViaFile(Subject,File).
If this bundle version is the initial version of a new bundle that needs to be created, the subject must
have Global.VIEW_BUNDLES because the new bundle will not be associated with any bundle group.
Required Permissions: Either: - Global.CREATE_BUNDLES and Global.VIEW_BUNDLES - Global.CREATE_BUNDLES and BundleGroup.VIEW_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG - BundleGroup.CREATE_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG
subject - user that must have proper permissionsdistributionFileUrl - a URL String to the Bundle Distribution file. It must be live, resolvable and read accessible
by the RHQ server process.Exceptionorg.rhq.core.domain.bundle.BundleVersion createInitialBundleVersionViaURL(org.rhq.core.domain.auth.Subject subject,
int[] bundleGroupIds,
String distributionFileUrl)
throws Exception
Required Permissions: Either: - Global.CREATE_BUNDLES and Global.VIEW_BUNDLES - Global.CREATE_BUNDLES and BundleGroup.VIEW_BUNDLES_IN_GROUP for bundle group BG - BundleGroup.CREATE_BUNDLES_IN_GROUP for bundle group BG
subject - user that must have proper permissionsbundleGroupIds - identifies the bundle groups that the new bundle will be associated with; null or zero
length to leave unassigned.distributionFileUrl - a URL String to the Bundle Distribution file. It must be live, resolvable and read accessible
by the RHQ server process.Exceptionorg.rhq.core.domain.bundle.BundleVersion createBundleVersionViaURL(org.rhq.core.domain.auth.Subject subject,
String distributionFileUrl,
String username,
String password)
throws Exception
createBundleVersionViaURL(org.rhq.core.domain.auth.Subject, String) that accepts a
username and password for basic authentication on the HTTP URLs.
If this bundle version is the initial version of a new bundle that needs to be created, the subject must
have Global.VIEW_BUNDLES because the new bundle will not be associated with any bundle group.
Required Permissions: Either: - Global.CREATE_BUNDLES and Global.VIEW_BUNDLES - Global.CREATE_BUNDLES and BundleGroup.VIEW_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG - BundleGroup.CREATE_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG
subject - user that must have proper permissionsdistributionFileUrl - username - password - ExceptioncreateBundleVersionViaURL(org.rhq.core.domain.auth.Subject, String)org.rhq.core.domain.bundle.BundleVersion createInitialBundleVersionViaURL(org.rhq.core.domain.auth.Subject subject,
int[] bundleGroupIds,
String distributionFileUrl,
String username,
String password)
throws Exception
Required Permissions: Either: - Global.CREATE_BUNDLES and Global.VIEW_BUNDLES - Global.CREATE_BUNDLES and BundleGroup.VIEW_BUNDLES_IN_GROUP for bundle group BG - BundleGroup.CREATE_BUNDLES_IN_GROUP for bundle group BG
subject - user that must have proper permissionsbundleGroupIds - identifies the bundle groups that the new bundle will be associated with; null or zero
length to leave unassigned.distributionFileUrl - username - password - ExceptioncreateBundleVersionViaURL(org.rhq.core.domain.auth.Subject, String)void deleteBundles(org.rhq.core.domain.auth.Subject subject,
int[] bundleIds)
throws Exception
Required Permissions: Either: - Global.DELETE_BUNDLES and Global.VIEW_BUNDLES - Global.DELETE_BUNDLES and BundleGroup.VIEW_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG - BundleGroup.DELETE_BUNDLES_FROM_GROUP for bundle group BG and the relevant bundle is assigned to BG
subject - user that must have proper permissionsbundleIds - IDs of all bundles to be deletedException - if any part of the removal fails.void deleteBundle(org.rhq.core.domain.auth.Subject subject,
int bundleId)
throws Exception
Required Permissions: Either: - Global.DELETE_BUNDLES and Global.VIEW_BUNDLES - Global.DELETE_BUNDLES and BundleGroup.VIEW_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG - BundleGroup.DELETE_BUNDLES_FROM_GROUP for bundle group BG and the relevant bundle is assigned to BG
subject - user that must have proper permissionsbundleId - the id of the bundle to removeException - if any part of the removal fails.void deleteBundleGroups(org.rhq.core.domain.auth.Subject subject,
int[] ids)
throws Exception
Required Permissions: - Global.MANAGE_BUNDLE_GROUPS
subject - user that must have proper permissionsids - the bundle group idExceptionvoid deleteBundleVersion(org.rhq.core.domain.auth.Subject subject,
int bundleVersionId,
boolean deleteBundleIfEmpty)
throws Exception
Required Permissions: Either: - Global.DELETE_BUNDLES and Global.VIEW_BUNDLES - Global.DELETE_BUNDLES and BundleGroup.VIEW_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG - BundleGroup.DELETE_BUNDLES_FROM_GROUP for bundle group BG and the relevant bundle is assigned to BG
subject - user that must have proper permissionsbundleVersionId - the id of the bundle version to removedeleteBundleIfEmpty - if true and if this method deletes the last bundle version for its
bundle, then that bundle entity itself will be completely purgedException - if any part of the removal fails.org.rhq.core.domain.util.PageList<org.rhq.core.domain.bundle.Bundle> findBundlesByCriteria(org.rhq.core.domain.auth.Subject subject,
org.rhq.core.domain.criteria.BundleCriteria criteria)
Bundles narrowed by the supplied Criteria. The results are implicitly
narrowed to those bundles viewable by the subject.subject - criteria - org.rhq.core.domain.util.PageList<org.rhq.core.domain.bundle.BundleGroup> findBundleGroupsByCriteria(org.rhq.core.domain.auth.Subject subject,
org.rhq.core.domain.criteria.BundleGroupCriteria criteria)
BundleGroups narrowed by the supplied Criteria. The results are implicitly
narrowed to those bundle groups viewable by the subject.subject - criteria - org.rhq.core.domain.util.PageList<org.rhq.core.domain.bundle.BundleDeployment> findBundleDeploymentsByCriteria(org.rhq.core.domain.auth.Subject subject,
org.rhq.core.domain.criteria.BundleDeploymentCriteria criteria)
BundleDeployments narrowed by the supplied Criteria. The results are implicitly
narrowed to those for bundles and destination groups viewable by the subject.subject - criteria - org.rhq.core.domain.util.PageList<org.rhq.core.domain.bundle.BundleDestination> findBundleDestinationsByCriteria(org.rhq.core.domain.auth.Subject subject,
org.rhq.core.domain.criteria.BundleDestinationCriteria criteria)
BundleDestinations narrowed by the supplied Criteria. The results are implicitly
narrowed to those with destination resource groups viewable by the subject.subject - criteria - org.rhq.core.domain.util.PageList<org.rhq.core.domain.bundle.BundleResourceDeployment> findBundleResourceDeploymentsByCriteria(org.rhq.core.domain.auth.Subject subject,
org.rhq.core.domain.criteria.BundleResourceDeploymentCriteria criteria)
subject. If optionally requesting the relevant Resources
via BundleResourceDeploymentCriteria.fetchResources(true) the results will be further narrowed to
the viewable resources.subject - criteria - org.rhq.core.domain.util.PageList<org.rhq.core.domain.bundle.BundleFile> findBundleFilesByCriteria(org.rhq.core.domain.auth.Subject subject,
org.rhq.core.domain.criteria.BundleFileCriteria criteria)
subject - criteria - org.rhq.core.domain.util.PageList<org.rhq.core.domain.bundle.BundleVersion> findBundleVersionsByCriteria(org.rhq.core.domain.auth.Subject subject,
org.rhq.core.domain.criteria.BundleVersionCriteria criteria)
subject - criteria - org.rhq.core.domain.util.PageList<org.rhq.core.domain.bundle.composite.BundleWithLatestVersionComposite> findBundlesWithLatestVersionCompositesByCriteria(org.rhq.core.domain.auth.Subject subject,
org.rhq.core.domain.criteria.BundleCriteria criteria)
subject - criteria - List<org.rhq.core.domain.bundle.BundleType> getAllBundleTypes(org.rhq.core.domain.auth.Subject subject)
subject - org.rhq.core.domain.bundle.BundleType getBundleType(org.rhq.core.domain.auth.Subject subject,
String bundleTypeName)
subject - bundleTypeName - must existSet<String> getBundleVersionFilenames(org.rhq.core.domain.auth.Subject subject, int bundleVersionId, boolean withoutBundleFileOnly) throws Exception
Required Permissions: Either: - Global.CREATE_BUNDLES and Global.VIEW_BUNDLES - Global.CREATE_BUNDLES and BundleGroup.VIEW_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG - BundleGroup.CREATE_BUNDLES_IN_GROUP for bundle group BG and the relevant bundle is assigned to BG
subject - user that must have proper permissionsbundleVersionId - the BundleVersion being queriedwithoutBundleFileOnly - if true omit any filenames that already have a corresponding BundleFile for
the BundleVersion.Exceptionvoid purgeBundleDestination(org.rhq.core.domain.auth.Subject subject,
int bundleDestinationId)
throws Exception
Required Permissions: Either: - Global.DEPLOY_BUNDLES and a view of the relevant bundle and a view of the relevant resource group (may involve multiple roles) - Resource.DEPLOY_BUNDLES_TO_GROUP and a view of the relevant bundle and a view of the relevant resource group (may involve multiple roles)
subject - user that must have proper permissionsbundleDestinationId - the ID of the destination that is to be purged of bundle contentExceptionorg.rhq.core.domain.bundle.BundleDeployment scheduleBundleDeployment(org.rhq.core.domain.auth.Subject subject,
int bundleDeploymentId,
boolean isCleanDeployment)
throws Exception
Required Permissions: Either: - Global.DEPLOY_BUNDLES and a view of the relevant bundle and a view of the relevant resource group (may involve multiple roles) - Resource.DEPLOY_BUNDLES_TO_GROUP and a view of the relevant bundle and a view of the relevant resource group (may involve multiple roles)
subject - user that must have proper permissionsbundleDeploymentId - the BundleDeployment being used to guide the deploymentsisCleanDeployment - if true perform a wipe of the deploy directory prior to the deployment. If false
perform as an upgrade to the existing deployment, if any.Exceptionorg.rhq.core.domain.bundle.BundleDeployment scheduleRevertBundleDeployment(org.rhq.core.domain.auth.Subject subject,
int bundleDestinationId,
String deploymentDescription,
boolean isCleanDeployment)
throws Exception
subject - user that must have proper permissionsbundleDestinationId - the destination on which the revert should be applieddeploymentDescription - an optional longer description describing this deployment. If null defaults
to the description of the previous deployment.isCleanDeployment - if true perform a wipe of the deploy directory prior to the revert deployment. Backed up
files will still be applied. If false perform as an upgrade to the existing deployment.Exceptionvoid unassignBundlesFromBundleGroups(org.rhq.core.domain.auth.Subject subject,
int[] bundleGroupIds,
int[] bundleIds)
Requires VIEW permission for the relevant bundles and one of: - Global.MANAGE_BUNDLE_GROUPS - Global.DELETE_BUNDLE - BundleGroup.UNASSIGN_BUNDLES_FROM_GROUP for the relevant bundle group - BundleGroup.DELETE_BUNDLES_FROM_GROUP for the relevant bundle group
subject - bundleGroupIds - bundleIds - org.rhq.core.domain.bundle.BundleGroup updateBundleGroup(org.rhq.core.domain.auth.Subject subject,
org.rhq.core.domain.bundle.BundleGroup bundleGroup)
throws Exception
Require Permissions: - Global.MANAGE_BUNDLE_GROUPS
subject - user that must have proper permissionsbundleGroup - the updated bundle groupExceptionCopyright © 2008-2014 Red Hat, Inc.. All Rights Reserved.