org.rhq.enterprise.server.configuration
Class ConfigurationManagerBean

java.lang.Object
  org.rhq.enterprise.server.configuration.ConfigurationManagerBean

All Implemented Interfaces:

ConfigurationManagerLocal, ConfigurationManagerRemote

public class ConfigurationManagerBean
extends java.lang.Object
implements ConfigurationManagerLocal, ConfigurationManagerRemote

The manager responsible for working with resource and plugin configurations.

Author:

John Mazzitelli, Ian Springer

Constructor Summary

ConfigurationManagerBean()

Method Summary

void	checkForCompletedGroupResourceConfigurationUpdate(int resourceConfigUpdateId)
void	checkForTimedOutConfigurationUpdateRequests() The purpose of this method is really to clean up requests when we detect they probably will never move out of the in-progress status.
void	completePluginConfigurationUpdate(java.lang.Integer updateId)
void	completePluginConfigurationUpdate(PluginConfigurationUpdate update) Updates the plugin configuration used to connect and communicate with the resource using the information in the passed PluginConfigurationUpdate object.
void	completeResourceConfigurationUpdate(ConfigurationUpdateResponse response) A callback method that is called when an agent has completed updating a resource's configuration.
int	createGroupConfigurationUpdate(AbstractGroupConfigurationUpdate update)
void	deleteConfigurations(java.util.List<java.lang.Integer> configurationIds)
int	deleteGroupPluginConfigurationUpdates(Subject subject, java.lang.Integer resourceGroupId, java.lang.Integer[] groupPluginConfigurationUpdateIds)
int	deleteGroupResourceConfigurationUpdates(Subject subject, java.lang.Integer resourceGroupId, java.lang.Integer[] groupResourceConfigurationUpdateIds)
void	deleteProperties(int[] propertyIds)
ConfigurationUpdateResponse	executePluginConfigurationUpdate(PluginConfigurationUpdate update)
void	executeResourceConfigurationUpdate(int updateId)
PageList<GroupPluginConfigurationUpdate>	findGroupPluginConfigurationUpdates(int groupId, PageControl pc)
PageList<GroupResourceConfigurationUpdate>	findGroupResourceConfigurationUpdates(int groupId, PageControl pc)
PageList<ConfigurationUpdateComposite>	findPluginConfigurationUpdateCompositesByParentId(int configurationUpdateId, PageControl pageControl)
PageList<PluginConfigurationUpdate>	findPluginConfigurationUpdates(Subject subject, int resourceId, java.lang.Long beginDate, java.lang.Long endDate, PageControl pc)
PageList<java.lang.Integer>	findPluginConfigurationUpdatesByParentId(int configurationUpdateId, PageControl pageControl)
RawConfiguration	findRawConfigurationById(int rawConfigId)
java.util.Collection<RawConfiguration>	findRawConfigurationsByConfigurationId(int configId)
PageList<ConfigurationUpdateComposite>	findResourceConfigurationUpdateCompositesByParentId(int configurationUpdateId, PageControl pageControl)
PageList<ResourceConfigurationUpdate>	findResourceConfigurationUpdates(Subject subject, java.lang.Integer resourceId, java.lang.Long beginDate, java.lang.Long endDate, boolean suppressOldest, PageControl pc) Returns the list of all resource configuration updates for the given resource.
PageList<java.lang.Integer>	findResourceConfigurationUpdatesByParentId(int groupConfigurationUpdateId, PageControl pageControl)
Configuration	getConfiguration(Subject subject, int configurationId)
Configuration	getConfigurationById(int id) This is a generic method that any caller can use to obtain any configuration given a configuration ID.
Configuration	getConfigurationFromDefaultTemplate(ConfigurationDefinition definition) This is a convenience method that is equivalent to the following: definition.getDefaultTemplate().getConfiguration() If the definition is already a managed bean, then there is no real reason to call this since EJB3 will traverse the object relationships just fine.
GroupPluginConfigurationUpdate	getGroupPluginConfigurationById(int configurationUpdateId)
GroupPluginConfigurationUpdate	getGroupPluginConfigurationUpdate(Subject subject, int configurationUpdateId)
GroupResourceConfigurationUpdate	getGroupResourceConfigurationById(int configurationUpdateId)
GroupResourceConfigurationUpdate	getGroupResourceConfigurationUpdate(Subject subject, int configurationUpdateId)
PluginConfigurationUpdate	getLatestPluginConfigurationUpdate(Subject subject, int resourceId) Get the latest plugin configuration for the Resource with the given id.
ResourceConfigurationUpdate	getLatestResourceConfigurationUpdate(Subject subject, int resourceId) Get the latest resource configuration for the Resource with the given id, or null if the resource's configuration is not yet initialized and for some reason we can't get its current live configuration (e.g.
Configuration	getLiveResourceConfiguration(Subject subject, int resourceId, boolean pingAgentFirst) Get the currently live resource configuration for the Resource with the given id.
ConfigurationDefinition	getPackageTypeConfigurationDefinition(Subject subject, int packageTypeId) Return the deploy configuration definition for the PackageType with the specified id.
Configuration	getPluginConfiguration(int resourceId) This does not perform permission checks and should be used internally only.
Configuration	getPluginConfiguration(Subject subject, int resourceId) Get the current plugin configuration for the Resource with the given id, or null if the resource's plugin configuration is not yet initialized.
ConfigurationDefinition	getPluginConfigurationDefinitionForResourceType(Subject subject, int resourceTypeId) Return the plugin configuration definition for the ResourceType with the specified id.
java.util.Map<java.lang.Integer,Configuration>	getPluginConfigurationMapForGroupUpdate(java.lang.Integer groupPluginConfigurationUpdateId)
java.util.Map<java.lang.Integer,Configuration>	getPluginConfigurationsForCompatibleGroup(Subject subject, int groupId)
PluginConfigurationUpdate	getPluginConfigurationUpdate(Subject subject, int configurationUpdateId)
long	getPluginConfigurationUpdateCountByParentId(int configurationUpdateId)
Configuration	getResourceConfiguration(int resourceId) This does not perform permission checks and should be used internally only.
Configuration	getResourceConfiguration(Subject subject, int resourceId) Get the current Resource configuration.
ConfigurationDefinition	getResourceConfigurationDefinitionForResourceType(Subject subject, int resourceTypeId) Return the resource configuration definition for the ResourceType with the specified id.
ConfigurationDefinition	getResourceConfigurationDefinitionWithTemplatesForResourceType(Subject subject, int resourceTypeId) Return the resource configuration definition for the ResourceType with the specified id.
java.util.Map<java.lang.Integer,Configuration>	getResourceConfigurationMapForCompatibleGroup(ResourceGroup compatibleGroup)
java.util.Map<java.lang.Integer,Configuration>	getResourceConfigurationMapForGroupUpdate(java.lang.Integer groupResourceConfigurationUpdateId)
java.util.Map<java.lang.Integer,Configuration>	getResourceConfigurationsForCompatibleGroup(Subject subject, int groupId) Returns the current Resource configurations for the members in the specified compatible group.
ResourceConfigurationUpdate	getResourceConfigurationUpdate(Subject subject, int configurationUpdateId) Returns a single resource configuration update
long	getResourceConfigurationUpdateCountByParentId(int groupConfigurationUpdateId)
boolean	hasPluginConfiguration(int resourceTypeId)
boolean	isGroupPluginConfigurationUpdateInProgress(Subject subject, int groupId)
boolean	isGroupResourceConfigurationUpdateInProgress(Subject subject, int groupId)
boolean	isPluginConfigurationUpdateInProgress(Subject subject, int resourceId)
boolean	isResourceConfigurationUpdateInProgress(Subject subject, int resourceId) Get whether the the specified resource is in the process of updating its configuration.
AbstractResourceConfigurationUpdate	mergeConfigurationUpdate(AbstractResourceConfigurationUpdate configurationUpdate) Merge the specified configuration update into the DB.
ResourceConfigurationUpdate	persistNewResourceConfigurationUpdateHistory(Subject subject, int resourceId, Configuration newConfiguration, ConfigurationUpdateStatus newStatus, java.lang.String newSubject, boolean isPartofGroupUpdate) For internal use only - do not call this method.
void	purgePluginConfigurationUpdate(Subject subject, int configurationUpdateId, boolean purgeInProgress)
void	purgeResourceConfigurationUpdate(Subject subject, int configurationUpdateId, boolean purgeInProgress) This deletes the update information belonging to the AbstractResourceConfigurationUpdate object with the given ID.
void	purgeResourceConfigurationUpdates(Subject subject, int[] configurationUpdateIds, boolean purgeInProgress) This deletes one or more configuration updates from the resource's configuration history.
void	rollbackResourceConfiguration(Subject subject, int resourceId, int configHistoryId) This method is called when a user has requested to change the resource configuration for an existing resource to one of its previous values.
int	scheduleGroupPluginConfigurationUpdate(Subject subject, int compatibleGroupId, java.util.Map<java.lang.Integer,Configuration> memberPluginConfigurations)
int	scheduleGroupResourceConfigurationUpdate(Subject subject, int compatibleGroupId, java.util.Map<java.lang.Integer,Configuration> newResourceConfigurationMap)
void	updateGroupConfigurationUpdate(AbstractGroupConfigurationUpdate groupUpdate)
ConfigurationUpdateStatus	updateGroupPluginConfigurationUpdateStatus(int groupConfigurationUpdateId, java.lang.String errorMessages)
PluginConfigurationUpdate	updatePluginConfiguration(Subject subject, int resourceId, Configuration configuration) Updates the plugin configuration used to connect and communicate with the resource.
ResourceConfigurationUpdate	updateResourceConfiguration(Subject subject, int resourceId, Configuration newConfiguration) This method is called when a user has requested to change the resource configuration for an existing resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationManagerBean

public ConfigurationManagerBean()

Method Detail

getPluginConfiguration

@Nullable
public Configuration getPluginConfiguration(Subject subject,
                                                     int resourceId)

Description copied from interface: ConfigurationManagerLocal

Get the current plugin configuration for the Resource with the given id, or null if the resource's plugin configuration is not yet initialized.

Specified by:

getPluginConfiguration in interface ConfigurationManagerLocal

Specified by:

getPluginConfiguration in interface ConfigurationManagerRemote

Parameters:

subject - the user who wants to see the information

resourceId - a Resource id

Returns:

the current plugin configuration for the Resource with the given id, or null if the resource's configuration is not yet initialized

getPluginConfiguration

public Configuration getPluginConfiguration(int resourceId)

Description copied from interface: ConfigurationManagerLocal

This does not perform permission checks and should be used internally only. In general, use ConfigurationManagerLocal.getPluginConfiguration(Subject, int).

Specified by:

getPluginConfiguration in interface ConfigurationManagerLocal

completePluginConfigurationUpdate

public void completePluginConfigurationUpdate(java.lang.Integer updateId)

Specified by:

completePluginConfigurationUpdate in interface ConfigurationManagerLocal

completePluginConfigurationUpdate

public void completePluginConfigurationUpdate(PluginConfigurationUpdate update)

Description copied from interface: ConfigurationManagerLocal

Updates the plugin configuration used to connect and communicate with the resource using the information in the passed PluginConfigurationUpdate object. This update object will be changed to reflect the result of the plugin configuration update attempt. This is an internal method called by ConfigurationManagerLocal.updatePluginConfiguration(Subject, int, Configuration) and GroupPluginConfigurationUpdateJob . It is not intended to be used for general, public consumption.

Specified by:

completePluginConfigurationUpdate in interface ConfigurationManagerLocal

Parameters:

update - a previously server-side persisted update, which has not yet made it to the agent

executePluginConfigurationUpdate

public ConfigurationUpdateResponse executePluginConfigurationUpdate(PluginConfigurationUpdate update)

Specified by:

executePluginConfigurationUpdate in interface ConfigurationManagerLocal

updatePluginConfiguration

public PluginConfigurationUpdate updatePluginConfiguration(Subject subject,
                                                           int resourceId,
                                                           Configuration configuration)
                                                    throws ResourceNotFoundException

Description copied from interface: ConfigurationManagerLocal

Updates the plugin configuration used to connect and communicate with the resource. The given newConfiguration is usually a modified version of a configuration returned by ConfigurationManagerLocal.getPluginConfiguration(Subject, int).

Specified by:

updatePluginConfiguration in interface ConfigurationManagerLocal

Specified by:

updatePluginConfiguration in interface ConfigurationManagerRemote

Parameters:

subject - the user who wants to see the information

resourceId - a Resource id

configuration - the new plugin configuration

Returns:

the plugin configuration update item corresponding to this request

Throws:

ResourceNotFoundException

getResourceConfiguration

public Configuration getResourceConfiguration(Subject subject,
                                              int resourceId)

Description copied from interface: ConfigurationManagerRemote

Get the current Resource configuration.

Specified by:

getResourceConfiguration in interface ConfigurationManagerLocal

Specified by:

getResourceConfiguration in interface ConfigurationManagerRemote

Parameters:

subject - The logged in user's subject.

resourceId - A resource id.

Returns:

The specified configuration.

getResourceConfiguration

public Configuration getResourceConfiguration(int resourceId)

Description copied from interface: ConfigurationManagerLocal

This does not perform permission checks and should be used internally only. In general, use #getCurrentResourceConfiguration.

Specified by:

getResourceConfiguration in interface ConfigurationManagerLocal

getLatestResourceConfigurationUpdate

@Nullable
public ResourceConfigurationUpdate getLatestResourceConfigurationUpdate(Subject subject,
                                                                                 int resourceId)

Description copied from interface: ConfigurationManagerLocal

Get the latest resource configuration for the Resource with the given id, or null if the resource's configuration is not yet initialized and for some reason we can't get its current live configuration (e.g. in the case the agent or resource is down). Returns the configuration as it is known on the server-side in the database. The database will be sync'ed with the live values, if the currently live configuration is actually different than the latest configuration update found in history.

Specified by:

getLatestResourceConfigurationUpdate in interface ConfigurationManagerLocal

Specified by:

getLatestResourceConfigurationUpdate in interface ConfigurationManagerRemote

Parameters:

subject - the user who wants to see the information

resourceId - a Resource id

Returns:

the current configuration (along with additional information about the configuration) for the Resource with the given id, or null if the resource's configuration is not yet initialized and its live configuration could not be determined

getLatestPluginConfigurationUpdate

public PluginConfigurationUpdate getLatestPluginConfigurationUpdate(Subject subject,
                                                                    int resourceId)

Description copied from interface: ConfigurationManagerLocal

Get the latest plugin configuration for the Resource with the given id. Returns the configuration as it is known on the server-side in the database.

Specified by:

getLatestPluginConfigurationUpdate in interface ConfigurationManagerLocal

Specified by:

getLatestPluginConfigurationUpdate in interface ConfigurationManagerRemote

Parameters:

subject - the user who wants to see the information

resourceId - a Resource id

Returns:

the current plugin configuration (along with additional information about the configuration) for the Resource with the given id

isResourceConfigurationUpdateInProgress

public boolean isResourceConfigurationUpdateInProgress(Subject subject,
                                                       int resourceId)

Description copied from interface: ConfigurationManagerRemote

Get whether the the specified resource is in the process of updating its configuration.

Specified by:

isResourceConfigurationUpdateInProgress in interface ConfigurationManagerLocal

Specified by:

isResourceConfigurationUpdateInProgress in interface ConfigurationManagerRemote

Parameters:

subject - The logged in user's subject.

resourceId - A resource id.

Returns:

True if in progress, else False.

isPluginConfigurationUpdateInProgress

public boolean isPluginConfigurationUpdateInProgress(Subject subject,
                                                     int resourceId)

isGroupResourceConfigurationUpdateInProgress

public boolean isGroupResourceConfigurationUpdateInProgress(Subject subject,
                                                            int groupId)

Specified by:

isGroupResourceConfigurationUpdateInProgress in interface ConfigurationManagerLocal

Specified by:

isGroupResourceConfigurationUpdateInProgress in interface ConfigurationManagerRemote

isGroupPluginConfigurationUpdateInProgress

public boolean isGroupPluginConfigurationUpdateInProgress(Subject subject,
                                                          int groupId)

getResourceConfigurationsForCompatibleGroup

public java.util.Map<java.lang.Integer,Configuration> getResourceConfigurationsForCompatibleGroup(Subject subject,
                                                                                                  int groupId)
                                                                                           throws ConfigurationUpdateStillInProgressException,
                                                                                                  java.lang.Exception

Description copied from interface: ConfigurationManagerLocal

Returns the current Resource configurations for the members in the specified compatible group.

Specified by:

getResourceConfigurationsForCompatibleGroup in interface ConfigurationManagerLocal

Parameters:

subject - the current subject

groupId - the id of the compatible group

Returns:

Throws:

java.lang.Exception - if 1) one or more of the group's members are DOWN, or 2) we fail to retrieve one or more member live configs from the corresponding Agents

ConfigurationUpdateStillInProgressException

getPluginConfigurationsForCompatibleGroup

public java.util.Map<java.lang.Integer,Configuration> getPluginConfigurationsForCompatibleGroup(Subject subject,
                                                                                                int groupId)
                                                                                         throws ConfigurationUpdateStillInProgressException,
                                                                                                java.lang.Exception

Specified by:

getPluginConfigurationsForCompatibleGroup in interface ConfigurationManagerLocal

Throws:

ConfigurationUpdateStillInProgressException

java.lang.Exception

getLiveResourceConfiguration

public Configuration getLiveResourceConfiguration(Subject subject,
                                                  int resourceId,
                                                  boolean pingAgentFirst)
                                           throws java.lang.Exception

Description copied from interface: ConfigurationManagerLocal

Get the currently live resource configuration for the Resource with the given id. This actually asks for the up-to-date configuration directly from the agent. An exception will be thrown if communications with the agent cannot be made.

Specified by:

getLiveResourceConfiguration in interface ConfigurationManagerLocal

Specified by:

getLiveResourceConfiguration in interface ConfigurationManagerRemote

Parameters:

subject - the user who wants to see the information

resourceId - a Resource id

pingAgentFirst - true if the underlying Agent should be pinged successfully before attempting to retrieve the configuration, or false otherwise

Returns:

the live configuration

Throws:

java.lang.Exception - if failed to get the configuration from the agent

checkForTimedOutConfigurationUpdateRequests

public void checkForTimedOutConfigurationUpdateRequests()

Description copied from interface: ConfigurationManagerLocal

The purpose of this method is really to clean up requests when we detect they probably will never move out of the in-progress status. This will occur if the Agent dies before it has a chance to report success/failure. In that case, we'll never get an Agent completion message and the update request will remain in progress status forever. This method just tries to detect this scenario - if it finds an update request that has been in progress for a very long time, we assume we'll never hear from the Agent and time out that request (that is, set its status to FAILURE and set an error string that says the request timed out).

Specified by:

checkForTimedOutConfigurationUpdateRequests in interface ConfigurationManagerLocal

findPluginConfigurationUpdates

public PageList<PluginConfigurationUpdate> findPluginConfigurationUpdates(Subject subject,
                                                                          int resourceId,
                                                                          java.lang.Long beginDate,
                                                                          java.lang.Long endDate,
                                                                          PageControl pc)

Specified by:

findPluginConfigurationUpdates in interface ConfigurationManagerLocal

findResourceConfigurationUpdates

public PageList<ResourceConfigurationUpdate> findResourceConfigurationUpdates(Subject subject,
                                                                              java.lang.Integer resourceId,
                                                                              java.lang.Long beginDate,
                                                                              java.lang.Long endDate,
                                                                              boolean suppressOldest,
                                                                              PageControl pc)

Description copied from interface: ConfigurationManagerLocal

Returns the list of all resource configuration updates for the given resource. This will show you an audit trail of the update history for the resource (who updated it, when and what did they do). You can pick one configuration version to later rollback to that version via ConfigurationManagerLocal.updateResourceConfiguration(Subject, int, Configuration).

Specified by:

findResourceConfigurationUpdates in interface ConfigurationManagerLocal

Parameters:

subject - the user who wants to see the information

resourceId - the resource whose update requests are to be returned, if null will not filter by resourceId

beginDate - filter used to show only results occurring after this epoch millis parameter, nullable

endDate - filter used to show only results occurring before this epoch millis parameter, nullable

suppressOldest - if true, will not include the oldest element in the history (usually the initial update)

pc - the pagination controls

Returns:

the resource's complete list of updates (will be empty (not null) if none)

getPluginConfigurationUpdate

public PluginConfigurationUpdate getPluginConfigurationUpdate(Subject subject,
                                                              int configurationUpdateId)

Specified by:

getPluginConfigurationUpdate in interface ConfigurationManagerLocal

getResourceConfigurationUpdate

public ResourceConfigurationUpdate getResourceConfigurationUpdate(Subject subject,
                                                                  int configurationUpdateId)

Description copied from interface: ConfigurationManagerLocal

Returns a single resource configuration update

Specified by:

getResourceConfigurationUpdate in interface ConfigurationManagerLocal

Parameters:

subject - the user who wants to see the information

configurationUpdateId - the ID of the configuration update entity to return

Returns:

the resource configuration update

purgePluginConfigurationUpdate

public void purgePluginConfigurationUpdate(Subject subject,
                                           int configurationUpdateId,
                                           boolean purgeInProgress)

Specified by:

purgePluginConfigurationUpdate in interface ConfigurationManagerLocal

purgeResourceConfigurationUpdate

public void purgeResourceConfigurationUpdate(Subject subject,
                                             int configurationUpdateId,
                                             boolean purgeInProgress)

Description copied from interface: ConfigurationManagerLocal

This deletes the update information belonging to the AbstractResourceConfigurationUpdate object with the given ID. Once this returns, the complete audit trail for that update will be gone and you will not be able to rollback to that configuration.

Under normal circumstances, you will not want to purge an update that is currently in progress. However, there may be conditions in which an update request "gets stuck" in the in-progress state, even though you know the agent will never report the completed request (typically caused by an unusual crash of the agent). In this case, you should pass true in for the purgeInProgress parameter to tell this method to delete the request even if it says it is in-progress.

Specified by:

purgeResourceConfigurationUpdate in interface ConfigurationManagerLocal

Parameters:

subject - the user who is requesting the purge

configurationUpdateId - identifies the update record to be deleted

purgeInProgress - if true, delete it even if its in progress

purgeResourceConfigurationUpdates

public void purgeResourceConfigurationUpdates(Subject subject,
                                              int[] configurationUpdateIds,
                                              boolean purgeInProgress)

Description copied from interface: ConfigurationManagerLocal

This deletes one or more configuration updates from the resource's configuration history.

Specified by:

purgeResourceConfigurationUpdates in interface ConfigurationManagerLocal

Parameters:

subject - the user who is requesting the purge

configurationUpdateIds - identifies the update records to be deleted

purgeInProgress - if true, delete those even if in progress

updateResourceConfiguration

@Nullable
public ResourceConfigurationUpdate updateResourceConfiguration(Subject subject,
                                                                        int resourceId,
                                                                        Configuration newConfiguration)
                                                        throws ResourceNotFoundException

Description copied from interface: ConfigurationManagerLocal

This method is called when a user has requested to change the resource configuration for an existing resource. If the user does not have the proper permissions to change the resource's configuration, an exception is thrown.

This will not wait for the agent to finish the configuration update. This will return after the request is sent. Once the agent finishes with the request, it will send the completed request information to ConfigurationManagerLocal.completeResourceConfigurationUpdate(org.rhq.core.clientapi.server.configuration.ConfigurationUpdateResponse).

Specified by:

updateResourceConfiguration in interface ConfigurationManagerLocal

Specified by:

updateResourceConfiguration in interface ConfigurationManagerRemote

Parameters:

subject - the user who is requesting the update

resourceId - identifies the resource to be updated

newConfiguration - the resource's desired new configuration

Returns:

the resource configuration update item corresponding to this request. null if newConfiguration is equal to the existing configuration.

Throws:

ResourceNotFoundException

executeResourceConfigurationUpdate

public void executeResourceConfigurationUpdate(int updateId)

Specified by:

executeResourceConfigurationUpdate in interface ConfigurationManagerLocal

rollbackResourceConfiguration

public void rollbackResourceConfiguration(Subject subject,
                                          int resourceId,
                                          int configHistoryId)
                                   throws ConfigurationUpdateException

Description copied from interface: ConfigurationManagerLocal

This method is called when a user has requested to change the resource configuration for an existing resource to one of its previous values. If the user does not have the proper permissions to change the resource's configuration, an exception is thrown.

This will not wait for the agent to finish the configuration update. This will return after the request is sent. Once the agent finishes with the request, it will send the completed request information to ConfigurationManagerLocal.completeResourceConfigurationUpdate(org.rhq.core.clientapi.server.configuration.ConfigurationUpdateResponse).

Specified by:

rollbackResourceConfiguration in interface ConfigurationManagerLocal

Parameters:

subject - the user who is requesting the update

resourceId - identifies the resource to be updated

configHistoryId - the id of the resource's previous configuration to rollback to

Throws:

ConfigurationUpdateException - if the configHistoryId does not exist

persistNewResourceConfigurationUpdateHistory

public ResourceConfigurationUpdate persistNewResourceConfigurationUpdateHistory(Subject subject,
                                                                                int resourceId,
                                                                                Configuration newConfiguration,
                                                                                ConfigurationUpdateStatus newStatus,
                                                                                java.lang.String newSubject,
                                                                                boolean isPartofGroupUpdate)
                                                                         throws ResourceNotFoundException,
                                                                                ConfigurationUpdateStillInProgressException

Description copied from interface: ConfigurationManagerLocal

For internal use only - do not call this method. This is for ConfigurationManagerLocal.updateResourceConfiguration(Subject, int, Configuration) to call with REQUIRES_NEW transaction scope so it can force the new request to be committed to the DB. Also used by ConfigurationManagerLocal.getLatestResourceConfigurationUpdate(Subject, int) and ConfigurationManagerLocal.scheduleGroupResourceConfigurationUpdate(org.rhq.core.domain.auth.Subject, int, java.util.Map).

Specified by:

persistNewResourceConfigurationUpdateHistory in interface ConfigurationManagerLocal

newSubject - user to associate with this update change (may be null)

Returns:

the persisted Resource Configuration update, or null if the specified Configuration is identical to the currently persisted Configuration

Throws:

ResourceNotFoundException

ConfigurationUpdateStillInProgressException

completeResourceConfigurationUpdate

public void completeResourceConfigurationUpdate(ConfigurationUpdateResponse response)

Description copied from interface: ConfigurationManagerLocal

A callback method that is called when an agent has completed updating a resource's configuration.

Specified by:

completeResourceConfigurationUpdate in interface ConfigurationManagerLocal

Parameters:

response - information that contains the status of the update (i.e. was it successfully updated or did it fail?) as well as the configuration if it failed (with the properties containing error messages to describe what failed). If the update was a success, the completed request's configuration will be null to indicate that the configuration that was sent to the agent was used as-is.

checkForCompletedGroupResourceConfigurationUpdate

public void checkForCompletedGroupResourceConfigurationUpdate(int resourceConfigUpdateId)

Specified by:

checkForCompletedGroupResourceConfigurationUpdate in interface ConfigurationManagerLocal

getPackageTypeConfigurationDefinition

public ConfigurationDefinition getPackageTypeConfigurationDefinition(Subject subject,
                                                                     int packageTypeId)

Description copied from interface: ConfigurationManagerRemote

Return the deploy configuration definition for the PackageType with the specified id.

Specified by:

getPackageTypeConfigurationDefinition in interface ConfigurationManagerLocal

Specified by:

getPackageTypeConfigurationDefinition in interface ConfigurationManagerRemote

Parameters:

subject - the user who is requesting the plugin configuration definition

packageTypeId - identifies the package type whose configuration definition is being requested

Returns:

the the deploy configuration definition for the PackageType with the specified id.

See Also:

ConfigurationManagerRemote.getPackageTypeConfigurationDefinition(Subject,int)

getResourceConfigurationDefinitionForResourceType

@Nullable
public ConfigurationDefinition getResourceConfigurationDefinitionForResourceType(Subject subject,
                                                                                          int resourceTypeId)

Description copied from interface: ConfigurationManagerLocal

Return the resource configuration definition for the ResourceType with the specified id.

Specified by:

getResourceConfigurationDefinitionForResourceType in interface ConfigurationManagerLocal

Specified by:

getResourceConfigurationDefinitionForResourceType in interface ConfigurationManagerRemote

Parameters:

subject - the user who is requesting the resource configuration definition

resourceTypeId - identifies the resource type whose resource configuration definition is being requested

Returns:

the resource configuration definition for the ResourceType with the specified id, or null if the ResourceType does not define a resource configuration

getResourceConfigurationDefinitionWithTemplatesForResourceType

@Nullable
public ConfigurationDefinition getResourceConfigurationDefinitionWithTemplatesForResourceType(Subject subject,
                                                                                                       int resourceTypeId)

Description copied from interface: ConfigurationManagerLocal

Return the resource configuration definition for the ResourceType with the specified id. The templates will be loaded in the definition returned from this call.

Specified by:

getResourceConfigurationDefinitionWithTemplatesForResourceType in interface ConfigurationManagerLocal

Specified by:

getResourceConfigurationDefinitionWithTemplatesForResourceType in interface ConfigurationManagerRemote

Parameters:

subject - the user who is requesting the resource configuration definition

resourceTypeId - identifies the resource type whose resource configuration definition is being requested

Returns:

the resource configuration definition for the ResourceType with the specified id, or null if the ResourceType does not define a resource configuration

hasPluginConfiguration

public boolean hasPluginConfiguration(int resourceTypeId)

getPluginConfigurationDefinitionForResourceType

@Nullable
public ConfigurationDefinition getPluginConfigurationDefinitionForResourceType(Subject subject,
                                                                                        int resourceTypeId)

Description copied from interface: ConfigurationManagerLocal

Return the plugin configuration definition for the ResourceType with the specified id.

Specified by:

getPluginConfigurationDefinitionForResourceType in interface ConfigurationManagerLocal

Specified by:

getPluginConfigurationDefinitionForResourceType in interface ConfigurationManagerRemote

Parameters:

subject - the user who is requesting the plugin configuration definition

resourceTypeId - identifies the resource type whose plugin configuration definition is being requested

Returns:

the plugin configuration definition for the ResourceType with the specified id, or null if the ResourceType does not define a plugin configuration

mergeConfigurationUpdate

public AbstractResourceConfigurationUpdate mergeConfigurationUpdate(AbstractResourceConfigurationUpdate configurationUpdate)

Description copied from interface: ConfigurationManagerLocal

Merge the specified configuration update into the DB.

Specified by:

mergeConfigurationUpdate in interface ConfigurationManagerLocal

Parameters:

configurationUpdate - a configuration update

Returns:

an attached copy of the configuration update

getConfigurationById

public Configuration getConfigurationById(int id)

Description copied from interface: ConfigurationManagerLocal

This is a generic method that any caller can use to obtain any configuration given a configuration ID. This can be used to obtain any configuration, which includes such things as an operation's parameters or an operations results.

Specified by:

getConfigurationById in interface ConfigurationManagerLocal

Parameters:

id - identifies the configuration to return

Returns:

the configuration with the given ID, or null if there is no configuration with that ID

getConfiguration

public Configuration getConfiguration(Subject subject,
                                      int configurationId)

Specified by:

getConfiguration in interface ConfigurationManagerLocal

Specified by:

getConfiguration in interface ConfigurationManagerRemote

getConfigurationFromDefaultTemplate

public Configuration getConfigurationFromDefaultTemplate(ConfigurationDefinition definition)

Description copied from interface: ConfigurationManagerLocal

This is a convenience method that is equivalent to the following: definition.getDefaultTemplate().getConfiguration() If the definition is already a managed bean, then there is no real reason to call this since EJB3 will traverse the object relationships just fine. However, if the definition is detached from the managed context, and because of the lazy-loading semantics of the entities involved in the call chain above, then you can use this method since it will re-attach it and get the configuration from the default template as shown above.

Specified by:

getConfigurationFromDefaultTemplate in interface ConfigurationManagerLocal

Parameters:

definition - a configuration definition

Returns:

the Configuration from the default ConfigurationTemplate of the passed definition

createGroupConfigurationUpdate

public int createGroupConfigurationUpdate(AbstractGroupConfigurationUpdate update)
                                   throws org.quartz.SchedulerException

Specified by:

createGroupConfigurationUpdate in interface ConfigurationManagerLocal

Throws:

org.quartz.SchedulerException

scheduleGroupPluginConfigurationUpdate

public int scheduleGroupPluginConfigurationUpdate(Subject subject,
                                                  int compatibleGroupId,
                                                  java.util.Map<java.lang.Integer,Configuration> memberPluginConfigurations)
                                           throws org.quartz.SchedulerException

Specified by:

scheduleGroupPluginConfigurationUpdate in interface ConfigurationManagerLocal

Throws:

org.quartz.SchedulerException

scheduleGroupResourceConfigurationUpdate

public int scheduleGroupResourceConfigurationUpdate(Subject subject,
                                                    int compatibleGroupId,
                                                    java.util.Map<java.lang.Integer,Configuration> newResourceConfigurationMap)

Specified by:

scheduleGroupResourceConfigurationUpdate in interface ConfigurationManagerLocal

Specified by:

scheduleGroupResourceConfigurationUpdate in interface ConfigurationManagerRemote

getGroupPluginConfigurationById

public GroupPluginConfigurationUpdate getGroupPluginConfigurationById(int configurationUpdateId)

Specified by:

getGroupPluginConfigurationById in interface ConfigurationManagerLocal

getGroupResourceConfigurationById

public GroupResourceConfigurationUpdate getGroupResourceConfigurationById(int configurationUpdateId)

Specified by:

getGroupResourceConfigurationById in interface ConfigurationManagerLocal

findPluginConfigurationUpdateCompositesByParentId

public PageList<ConfigurationUpdateComposite> findPluginConfigurationUpdateCompositesByParentId(int configurationUpdateId,
                                                                                                PageControl pageControl)

Specified by:

findPluginConfigurationUpdateCompositesByParentId in interface ConfigurationManagerLocal

findResourceConfigurationUpdateCompositesByParentId

public PageList<ConfigurationUpdateComposite> findResourceConfigurationUpdateCompositesByParentId(int configurationUpdateId,
                                                                                                  PageControl pageControl)

Specified by:

findResourceConfigurationUpdateCompositesByParentId in interface ConfigurationManagerLocal

findPluginConfigurationUpdatesByParentId

public PageList<java.lang.Integer> findPluginConfigurationUpdatesByParentId(int configurationUpdateId,
                                                                            PageControl pageControl)

Specified by:

findPluginConfigurationUpdatesByParentId in interface ConfigurationManagerLocal

getPluginConfigurationUpdateCountByParentId

public long getPluginConfigurationUpdateCountByParentId(int configurationUpdateId)

Specified by:

getPluginConfigurationUpdateCountByParentId in interface ConfigurationManagerLocal

findResourceConfigurationUpdatesByParentId

public PageList<java.lang.Integer> findResourceConfigurationUpdatesByParentId(int groupConfigurationUpdateId,
                                                                              PageControl pageControl)

Specified by:

findResourceConfigurationUpdatesByParentId in interface ConfigurationManagerLocal

getResourceConfigurationUpdateCountByParentId

public long getResourceConfigurationUpdateCountByParentId(int groupConfigurationUpdateId)

Specified by:

getResourceConfigurationUpdateCountByParentId in interface ConfigurationManagerLocal

getResourceConfigurationMapForGroupUpdate

public java.util.Map<java.lang.Integer,Configuration> getResourceConfigurationMapForGroupUpdate(java.lang.Integer groupResourceConfigurationUpdateId)

Specified by:

getResourceConfigurationMapForGroupUpdate in interface ConfigurationManagerLocal

getPluginConfigurationMapForGroupUpdate

public java.util.Map<java.lang.Integer,Configuration> getPluginConfigurationMapForGroupUpdate(java.lang.Integer groupPluginConfigurationUpdateId)

Specified by:

getPluginConfigurationMapForGroupUpdate in interface ConfigurationManagerLocal

getResourceConfigurationMapForCompatibleGroup

public java.util.Map<java.lang.Integer,Configuration> getResourceConfigurationMapForCompatibleGroup(ResourceGroup compatibleGroup)

Specified by:

getResourceConfigurationMapForCompatibleGroup in interface ConfigurationManagerLocal

findGroupPluginConfigurationUpdates

public PageList<GroupPluginConfigurationUpdate> findGroupPluginConfigurationUpdates(int groupId,
                                                                                    PageControl pc)

Specified by:

findGroupPluginConfigurationUpdates in interface ConfigurationManagerLocal

findGroupResourceConfigurationUpdates

public PageList<GroupResourceConfigurationUpdate> findGroupResourceConfigurationUpdates(int groupId,
                                                                                        PageControl pc)

Specified by:

findGroupResourceConfigurationUpdates in interface ConfigurationManagerLocal

updateGroupPluginConfigurationUpdateStatus

public ConfigurationUpdateStatus updateGroupPluginConfigurationUpdateStatus(int groupConfigurationUpdateId,
                                                                            java.lang.String errorMessages)

Specified by:

updateGroupPluginConfigurationUpdateStatus in interface ConfigurationManagerLocal

deleteGroupPluginConfigurationUpdates

public int deleteGroupPluginConfigurationUpdates(Subject subject,
                                                 java.lang.Integer resourceGroupId,
                                                 java.lang.Integer[] groupPluginConfigurationUpdateIds)

Specified by:

deleteGroupPluginConfigurationUpdates in interface ConfigurationManagerLocal

deleteGroupResourceConfigurationUpdates

public int deleteGroupResourceConfigurationUpdates(Subject subject,
                                                   java.lang.Integer resourceGroupId,
                                                   java.lang.Integer[] groupResourceConfigurationUpdateIds)

Specified by:

deleteGroupResourceConfigurationUpdates in interface ConfigurationManagerLocal

updateGroupConfigurationUpdate

public void updateGroupConfigurationUpdate(AbstractGroupConfigurationUpdate groupUpdate)

Specified by:

updateGroupConfigurationUpdate in interface ConfigurationManagerLocal

deleteConfigurations

public void deleteConfigurations(java.util.List<java.lang.Integer> configurationIds)

Specified by:

deleteConfigurations in interface ConfigurationManagerLocal

deleteProperties

public void deleteProperties(int[] propertyIds)

Specified by:

deleteProperties in interface ConfigurationManagerLocal

getGroupPluginConfigurationUpdate

public GroupPluginConfigurationUpdate getGroupPluginConfigurationUpdate(Subject subject,
                                                                        int configurationUpdateId)

Specified by:

getGroupPluginConfigurationUpdate in interface ConfigurationManagerLocal

Specified by:

getGroupPluginConfigurationUpdate in interface ConfigurationManagerRemote

getGroupResourceConfigurationUpdate

public GroupResourceConfigurationUpdate getGroupResourceConfigurationUpdate(Subject subject,
                                                                            int configurationUpdateId)

Specified by:

getGroupResourceConfigurationUpdate in interface ConfigurationManagerLocal

Specified by:

getGroupResourceConfigurationUpdate in interface ConfigurationManagerRemote

findRawConfigurationsByConfigurationId

public java.util.Collection<RawConfiguration> findRawConfigurationsByConfigurationId(int configId)

Specified by:

findRawConfigurationsByConfigurationId in interface ConfigurationManagerLocal

findRawConfigurationById

public RawConfiguration findRawConfigurationById(int rawConfigId)

Specified by:

findRawConfigurationById in interface ConfigurationManagerLocal