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 Object
implements ConfigurationManagerLocal, ConfigurationManagerRemote

The manager responsible for working with Resource and plugin configurations.

Author:

John Mazzitelli, Ian Springer

Constructor Summary

Constructors

Constructor and Description
ConfigurationManagerBean()

Method Summary

Methods

Modifier and Type	Method and Description
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(Integer updateId)
void	completePluginConfigurationUpdate(org.rhq.core.domain.configuration.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(org.rhq.core.domain.configuration.group.AbstractGroupConfigurationUpdate update)
void	deleteConfigurations(List<Integer> configurationIds)
int	deleteGroupPluginConfigurationUpdates(org.rhq.core.domain.auth.Subject subject, Integer resourceGroupId, Integer[] groupPluginConfigurationUpdateIds)
int	deleteGroupResourceConfigurationUpdates(org.rhq.core.domain.auth.Subject subject, Integer resourceGroupId, Integer[] groupResourceConfigurationUpdateIds)
void	deleteProperties(int[] propertyIds)
ConfigurationUpdateResponse	executePluginConfigurationUpdate(org.rhq.core.domain.configuration.PluginConfigurationUpdate update)
void	executeResourceConfigurationUpdate(int updateId)
org.rhq.core.domain.util.PageList<org.rhq.core.domain.configuration.group.GroupPluginConfigurationUpdate>	findGroupPluginConfigurationUpdates(int groupId, org.rhq.core.domain.util.PageControl pc) Deprecated. use findGroupPluginConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject, org.rhq.core.domain.criteria.GroupPluginConfigurationUpdateCriteria)
org.rhq.core.domain.util.PageList<org.rhq.core.domain.configuration.group.GroupPluginConfigurationUpdate>	findGroupPluginConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.criteria.GroupPluginConfigurationUpdateCriteria criteria)
org.rhq.core.domain.util.PageList<org.rhq.core.domain.configuration.group.GroupResourceConfigurationUpdate>	findGroupResourceConfigurationUpdates(org.rhq.core.domain.auth.Subject subject, int groupId, org.rhq.core.domain.util.PageControl pc) Deprecated. use findGroupResourceConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject, org.rhq.core.domain.criteria.GroupResourceConfigurationUpdateCriteria)
org.rhq.core.domain.util.PageList<org.rhq.core.domain.configuration.group.GroupResourceConfigurationUpdate>	findGroupResourceConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.criteria.GroupResourceConfigurationUpdateCriteria criteria) Note that when setting AbstractGroupConfigurationUpdateCriteria.fetchConfigurationUpdates(boolean) to true, the current resource configurations are returned.
org.rhq.core.domain.util.PageList<org.rhq.core.domain.configuration.composite.ConfigurationUpdateComposite>	findPluginConfigurationUpdateCompositesByParentId(int configurationUpdateId, org.rhq.core.domain.util.PageControl pageControl)
org.rhq.core.domain.util.PageList<org.rhq.core.domain.configuration.PluginConfigurationUpdate>	findPluginConfigurationUpdates(org.rhq.core.domain.auth.Subject subject, int resourceId, Long beginDate, Long endDate, org.rhq.core.domain.util.PageControl pc) Deprecated. use findPluginConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject, org.rhq.core.domain.criteria.PluginConfigurationUpdateCriteria)
org.rhq.core.domain.util.PageList<org.rhq.core.domain.configuration.PluginConfigurationUpdate>	findPluginConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.criteria.PluginConfigurationUpdateCriteria criteria)
org.rhq.core.domain.util.PageList<Integer>	findPluginConfigurationUpdatesByParentId(int configurationUpdateId, org.rhq.core.domain.util.PageControl pageControl) Deprecated. use findPluginConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject, org.rhq.core.domain.criteria.PluginConfigurationUpdateCriteria)
org.rhq.core.domain.util.PageList<org.rhq.core.domain.configuration.composite.ConfigurationUpdateComposite>	findResourceConfigurationUpdateCompositesByParentId(org.rhq.core.domain.auth.Subject subject, int configurationUpdateId, org.rhq.core.domain.util.PageControl pageControl)
org.rhq.core.domain.util.PageList<org.rhq.core.domain.configuration.ResourceConfigurationUpdate>	findResourceConfigurationUpdates(org.rhq.core.domain.auth.Subject subject, Integer resourceId, Long beginDate, Long endDate, boolean suppressOldest, org.rhq.core.domain.util.PageControl pc) Deprecated. use findResourceConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject, org.rhq.core.domain.criteria.ResourceConfigurationUpdateCriteria)
org.rhq.core.domain.util.PageList<org.rhq.core.domain.configuration.ResourceConfigurationUpdate>	findResourceConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.criteria.ResourceConfigurationUpdateCriteria criteria)
org.rhq.core.domain.util.PageList<Integer>	findResourceConfigurationUpdatesByParentId(int groupConfigurationUpdateId, org.rhq.core.domain.util.PageControl pageControl) Deprecated. use findResourceConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject, org.rhq.core.domain.criteria.ResourceConfigurationUpdateCriteria)
org.rhq.core.domain.configuration.Configuration	getConfiguration(org.rhq.core.domain.auth.Subject subject, int configurationId)
org.rhq.core.domain.configuration.Configuration	getConfigurationById(int id) This is a generic method that any caller can use to obtain any configuration given a configuration ID.
org.rhq.core.domain.configuration.Configuration	getConfigurationFromDefaultTemplate(org.rhq.core.domain.configuration.definition.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.
org.rhq.core.domain.configuration.group.GroupPluginConfigurationUpdate	getGroupPluginConfigurationById(int configurationUpdateId) Deprecated. use findGroupPluginConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject, org.rhq.core.domain.criteria.GroupPluginConfigurationUpdateCriteria)
org.rhq.core.domain.configuration.group.GroupPluginConfigurationUpdate	getGroupPluginConfigurationUpdate(org.rhq.core.domain.auth.Subject subject, int configurationUpdateId)
org.rhq.core.domain.configuration.group.GroupResourceConfigurationUpdate	getGroupResourceConfigurationById(int configurationUpdateId) Deprecated. use findGroupResourceConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject, org.rhq.core.domain.criteria.GroupResourceConfigurationUpdateCriteria)
org.rhq.core.domain.configuration.group.GroupResourceConfigurationUpdate	getGroupResourceConfigurationUpdate(org.rhq.core.domain.auth.Subject subject, int configurationUpdateId)
org.rhq.core.domain.configuration.PluginConfigurationUpdate	getLatestPluginConfigurationUpdate(org.rhq.core.domain.auth.Subject subject, int resourceId) Get the PluginConfigurationUpdate for the "current" plugin configuration for the Resource with the given id.
org.rhq.core.domain.configuration.ResourceConfigurationUpdate	getLatestResourceConfigurationUpdate(org.rhq.core.domain.auth.Subject subject, int resourceId) Get the most recent attainable resource configuration for the Resource with the given id.
org.rhq.core.domain.configuration.ResourceConfigurationUpdate	getLatestResourceConfigurationUpdate(org.rhq.core.domain.auth.Subject subject, int resourceId, boolean fromStructured)
org.rhq.core.domain.configuration.Configuration	getLiveResourceConfiguration(org.rhq.core.domain.auth.Subject subject, int resourceId, boolean pingAgentFirst) Get the "live" resource configuration for the Resource with the given id.
org.rhq.core.domain.configuration.Configuration	getLiveResourceConfiguration(org.rhq.core.domain.auth.Subject subject, int resourceId, boolean pingAgentFirst, boolean fromStructured)
org.rhq.core.domain.configuration.definition.ConfigurationDefinition	getOptionsForConfigurationDefinition(org.rhq.core.domain.auth.Subject subject, int resourceId, int parentResourceId, org.rhq.core.domain.configuration.definition.ConfigurationDefinition def)
org.rhq.core.domain.configuration.definition.ConfigurationDefinition	getPackageTypeConfigurationDefinition(org.rhq.core.domain.auth.Subject subject, int packageTypeId) Return the deploy configuration definition for the PackageType with the specified id.
org.rhq.core.domain.configuration.Configuration	getPluginConfiguration(int resourceId) This does not perform permission checks and should be used internally only.
org.rhq.core.domain.configuration.Configuration	getPluginConfiguration(org.rhq.core.domain.auth.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.
org.rhq.core.domain.configuration.definition.ConfigurationDefinition	getPluginConfigurationDefinitionForResourceType(org.rhq.core.domain.auth.Subject subject, int resourceTypeId) Return the plugin configuration definition for the ResourceType with the specified id.
Map<Integer,org.rhq.core.domain.configuration.Configuration>	getPluginConfigurationMapForGroupUpdate(org.rhq.core.domain.auth.Subject subject, Integer groupPluginConfigurationUpdateId)
Map<Integer,org.rhq.core.domain.configuration.Configuration>	getPluginConfigurationsForCompatibleGroup(org.rhq.core.domain.auth.Subject subject, int groupId)
org.rhq.core.domain.configuration.PluginConfigurationUpdate	getPluginConfigurationUpdate(org.rhq.core.domain.auth.Subject subject, int configurationUpdateId) Deprecated. use criteria-based API
long	getPluginConfigurationUpdateCountByParentId(int configurationUpdateId)
org.rhq.core.domain.configuration.Configuration	getResourceConfiguration(int resourceId) This does not perform permission checks and should be used internally only.
org.rhq.core.domain.configuration.Configuration	getResourceConfiguration(org.rhq.core.domain.auth.Subject subject, int resourceId) Get the "current" resource configuration for the Resource with the given id, or null if the resource's resource configuration is not yet initialized.
org.rhq.core.domain.configuration.definition.ConfigurationDefinition	getResourceConfigurationDefinitionForResourceType(org.rhq.core.domain.auth.Subject subject, int resourceTypeId) Return the resource configuration definition for the ResourceType with the specified id.
org.rhq.core.domain.configuration.definition.ConfigurationDefinition	getResourceConfigurationDefinitionWithTemplatesForResourceType(org.rhq.core.domain.auth.Subject subject, int resourceTypeId) Return the resource configuration definition for the ResourceType with the specified id.
Map<Integer,org.rhq.core.domain.configuration.Configuration>	getResourceConfigurationMapForGroupUpdate(org.rhq.core.domain.auth.Subject subject, Integer groupResourceConfigurationUpdateId)
Map<Integer,org.rhq.core.domain.configuration.Configuration>	getResourceConfigurationsForCompatibleGroup(org.rhq.core.domain.auth.Subject subject, int groupId) Returns the current Resource configurations for the members in the specified compatible group.
org.rhq.core.domain.configuration.ResourceConfigurationUpdate	getResourceConfigurationUpdate(org.rhq.core.domain.auth.Subject subject, int configurationUpdateId) Deprecated. use criteria-based API
long	getResourceConfigurationUpdateCountByParentId(int groupConfigurationUpdateId)
boolean	isGroupPluginConfigurationUpdateInProgress(org.rhq.core.domain.auth.Subject subject, int groupId)
boolean	isGroupResourceConfigurationUpdateInProgress(org.rhq.core.domain.auth.Subject subject, int groupId)
boolean	isPluginConfigurationUpdateInProgress(org.rhq.core.domain.auth.Subject subject, int resourceId)
boolean	isResourceConfigurationUpdateInProgress(org.rhq.core.domain.auth.Subject subject, int resourceId) Get whether the the specified resource is in the process of updating its configuration.
org.rhq.core.domain.configuration.Configuration	mergeConfiguration(org.rhq.core.domain.configuration.Configuration config)
org.rhq.core.domain.configuration.AbstractResourceConfigurationUpdate	mergeConfigurationUpdate(org.rhq.core.domain.configuration.AbstractResourceConfigurationUpdate configurationUpdate) Merge the specified configuration update into the DB.
org.rhq.core.domain.configuration.ResourceConfigurationUpdate	persistResourceConfigurationUpdateInNewTransaction(org.rhq.core.domain.auth.Subject subject, int resourceId, org.rhq.core.domain.configuration.Configuration newConfiguration, org.rhq.core.domain.configuration.ConfigurationUpdateStatus newStatus, String newSubject, boolean isPartofGroupUpdate) For internal use only - do not call this method.
void	purgePluginConfigurationUpdate(org.rhq.core.domain.auth.Subject subject, int configurationUpdateId, boolean purgeInProgress) This deletes the update information belonging to the AbstractResourceConfigurationUpdate object with the given ID.
void	purgePluginConfigurationUpdates(org.rhq.core.domain.auth.Subject subject, int[] configurationUpdateIds, boolean purgeInProgress) This deletes one or more plugin configuration updates from the resource's plugin config history.
void	purgeResourceConfigurationUpdate(org.rhq.core.domain.auth.Subject subject, int configurationUpdateId, boolean purgeInProgress) This deletes the update information belonging to the AbstractResourceConfigurationUpdate object with the given ID.
void	purgeResourceConfigurationUpdates(org.rhq.core.domain.auth.Subject subject, int[] configurationUpdateIds, boolean purgeInProgress) This deletes one or more configuration updates from the resource's configuration history.
void	rollbackPluginConfiguration(org.rhq.core.domain.auth.Subject subject, int resourceId, int configHistoryId) This method is called when a user has requested to change the plugin configuration for an existing resource to one of its previous values.
void	rollbackResourceConfiguration(org.rhq.core.domain.auth.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(org.rhq.core.domain.auth.Subject subject, int compatibleGroupId, Map<Integer,org.rhq.core.domain.configuration.Configuration> memberPluginConfigurations) Schedules jobs to update the plugin configuration of resources in a compatible group.
int	scheduleGroupResourceConfigurationUpdate(org.rhq.core.domain.auth.Subject subject, int compatibleGroupId, Map<Integer,org.rhq.core.domain.configuration.Configuration> newResourceConfigurationMap)
void	setResourceConfiguration(int resourceId, org.rhq.core.domain.configuration.Configuration configuration) This method is called when the plugin container reports a new Resource configuration after an external change was detected.
org.rhq.core.domain.configuration.Configuration	translateResourceConfiguration(org.rhq.core.domain.auth.Subject subject, int resourceId, org.rhq.core.domain.configuration.Configuration configuration, boolean fromStructured)
void	updateGroupConfigurationUpdate(org.rhq.core.domain.configuration.group.AbstractGroupConfigurationUpdate groupUpdate)
org.rhq.core.domain.configuration.ConfigurationUpdateStatus	updateGroupPluginConfigurationUpdateStatus(int groupPluginConfigurationUpdateId, String errorMessages)
org.rhq.core.domain.configuration.ConfigurationUpdateStatus	updateGroupResourceConfigurationUpdateStatus(int groupResourceConfigurationUpdateId, String errorMessages)
org.rhq.core.domain.configuration.PluginConfigurationUpdate	updatePluginConfiguration(org.rhq.core.domain.auth.Subject subject, int resourceId, org.rhq.core.domain.configuration.Configuration newPluginConfiguration) Updates the plugin configuration used to connect and communicate with the resource.
org.rhq.core.domain.configuration.ResourceConfigurationUpdate	updateResourceConfiguration(org.rhq.core.domain.auth.Subject subject, int resourceId, org.rhq.core.domain.configuration.Configuration newResourceConfiguration) This method is called when a user has requested to change the resource configuration for an existing resource.
org.rhq.core.domain.configuration.ResourceConfigurationUpdate	updateStructuredOrRawConfiguration(org.rhq.core.domain.auth.Subject subject, int resourceId, org.rhq.core.domain.configuration.Configuration newConfiguration, boolean fromStructured)
org.rhq.core.domain.configuration.PluginConfigurationUpdate	upgradePluginConfiguration(org.rhq.core.domain.auth.Subject subject, int resourceId, org.rhq.core.domain.configuration.Configuration newPluginConfiguration) Dedicated method for supporting resource upgrade of plugin configuration.

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 org.rhq.core.domain.configuration.Configuration getPluginConfiguration(org.rhq.core.domain.auth.Subject subject,
                                                                              int resourceId)

Description copied from interface: ConfigurationManagerRemote

Get the "current" plugin configuration for the Resource with the given id, or null if the resource's plugin configuration is not yet initialized. The "current" configuration is that which has been most recently reported and stored server-side, the agent is not queried.

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 plugin configuration is not yet initialized

See Also:

#getLatestPluginConfigurationUpdate(Subject, int)}

getPluginConfiguration

public org.rhq.core.domain.configuration.Configuration getPluginConfiguration(int resourceId)

Description copied from interface: ConfigurationManagerLocal

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

Specified by:

getPluginConfiguration in interface ConfigurationManagerLocal

completePluginConfigurationUpdate

public void completePluginConfigurationUpdate(Integer updateId)

Specified by:

completePluginConfigurationUpdate in interface ConfigurationManagerLocal

completePluginConfigurationUpdate

public void completePluginConfigurationUpdate(org.rhq.core.domain.configuration.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 ConfigurationManagerRemote.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(org.rhq.core.domain.configuration.PluginConfigurationUpdate update)

Specified by:

executePluginConfigurationUpdate in interface ConfigurationManagerLocal

updatePluginConfiguration

public org.rhq.core.domain.configuration.PluginConfigurationUpdate updatePluginConfiguration(org.rhq.core.domain.auth.Subject subject,
                                                                                    int resourceId,
                                                                                    org.rhq.core.domain.configuration.Configuration newPluginConfiguration)
                                                                                      throws ResourceNotFoundException

Description copied from interface: ConfigurationManagerRemote

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 ConfigurationManagerRemote.getPluginConfiguration(Subject, int).

Specified by:

updatePluginConfiguration in interface ConfigurationManagerRemote

Parameters:

subject - The logged in user's subject.

resourceId - a Resource id

newPluginConfiguration - the new plugin configuration

Returns:

the plugin configuration update item corresponding to this request

Throws:

ResourceNotFoundException

upgradePluginConfiguration

public org.rhq.core.domain.configuration.PluginConfigurationUpdate upgradePluginConfiguration(org.rhq.core.domain.auth.Subject subject,
                                                                                     int resourceId,
                                                                                     org.rhq.core.domain.configuration.Configuration newPluginConfiguration)
                                                                                       throws ResourceNotFoundException

Description copied from interface: ConfigurationManagerLocal

Dedicated method for supporting resource upgrade of plugin configuration. Similar to ConfigurationManagerRemote.updatePluginConfiguration(Subject, int, Configuration) but does not inform the agent for two reasons: first, the agent is already updated (it initiates the update and two, callingback into the agent would lock the plugin container, as this is during PC initialization. Also, it does not validate the newConfiguration because the agent is allowed to update read-only properties during an upgrade.

Specified by:

upgradePluginConfiguration in interface ConfigurationManagerLocal

Parameters:

subject - The logged in user's subject.

resourceId - a Resource id

newPluginConfiguration - the new plugin configuration

Returns:

the plugin configuration update item corresponding to this request

Throws:

ResourceNotFoundException

getResourceConfiguration

public org.rhq.core.domain.configuration.Configuration getResourceConfiguration(org.rhq.core.domain.auth.Subject subject,
                                                                       int resourceId)

Description copied from interface: ConfigurationManagerRemote

Get the "current" resource configuration for the Resource with the given id, or null if the resource's resource configuration is not yet initialized. The "current" configuration is that which has been most recently reported and stored server-side, the agent is not queried.

Specified by:

getResourceConfiguration in interface ConfigurationManagerRemote

Parameters:

subject - the user who wants to see the information

resourceId - a Resource id

Returns:

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

See Also:

#getLatestResourceConfigurationUpdate(Subject, int)}, #getLiveResourceConfiguration(Subject, int, boolean)}

setResourceConfiguration

public void setResourceConfiguration(int resourceId,
                            org.rhq.core.domain.configuration.Configuration configuration)

Description copied from interface: ConfigurationManagerLocal

This method is called when the plugin container reports a new Resource configuration after an external change was detected.

Specified by:

setResourceConfiguration in interface ConfigurationManagerLocal

Parameters:

resourceId - the Resource's id

configuration - the updated configuration

getResourceConfiguration

public org.rhq.core.domain.configuration.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

public org.rhq.core.domain.configuration.ResourceConfigurationUpdate getLatestResourceConfigurationUpdate(org.rhq.core.domain.auth.Subject subject,
                                                                                                 int resourceId,
                                                                                                 boolean fromStructured)

Specified by:

getLatestResourceConfigurationUpdate in interface ConfigurationManagerLocal

getLatestResourceConfigurationUpdate

@Nullable
public org.rhq.core.domain.configuration.ResourceConfigurationUpdate getLatestResourceConfigurationUpdate(org.rhq.core.domain.auth.Subject subject,
                                                                                                          int resourceId)

Description copied from interface: ConfigurationManagerRemote

Get the most recent attainable resource configuration for the Resource with the given id. Retrieves and returns live resource configuration from the Agent, if possible. Otherwise returns the most recent server-side configuration (from the database). If the live availability differs from the server-side the database will be updated to match the live configuration. This can return null if an initial resource configuration has yet to be stored in the database and a live configuration can not be retrieved (e.g. in the case the agent or resource is down).

This differs from ConfigurationManagerRemote.getLiveResourceConfiguration(Subject, int, boolean) in that it will return the latest stored configuration if the agent can not be queried. This differs from ConfigurationManagerRemote.getResourceConfiguration(Subject, int) in that it will attempt to query the agent to capture the "live" configuration.

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. The configuration can be accessed via AbstractConfigurationUpdate.getConfiguration().

See Also:

#getLiveResourceConfiguration(Subject, int, boolean)}, #getResourceConfiguration(Subject, int)}

getLatestPluginConfigurationUpdate

public org.rhq.core.domain.configuration.PluginConfigurationUpdate getLatestPluginConfigurationUpdate(org.rhq.core.domain.auth.Subject subject,
                                                                                             int resourceId)

Description copied from interface: ConfigurationManagerRemote

Get the PluginConfigurationUpdate for the "current" plugin configuration for the Resource with the given id. This is the same as ConfigurationManagerRemote.getPluginConfiguration(Subject, int) but returns the full update information as opposed to just the configuration.

Specified by:

getLatestPluginConfigurationUpdate in interface ConfigurationManagerRemote

Parameters:

subject - the user who wants to see the information

resourceId - a Resource id

Returns:

the PluginConfigurationUpdate for the "current" plugin configuration

See Also:

#getPluginConfiguration(Subject, int)}

isResourceConfigurationUpdateInProgress

public boolean isResourceConfigurationUpdateInProgress(org.rhq.core.domain.auth.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 ConfigurationManagerRemote

Parameters:

subject - The logged in user's subject.

resourceId - A resource id.

Returns:

True if in progress, else False.

isPluginConfigurationUpdateInProgress

public boolean isPluginConfigurationUpdateInProgress(org.rhq.core.domain.auth.Subject subject,
                                            int resourceId)

Specified by:

isPluginConfigurationUpdateInProgress in interface ConfigurationManagerLocal

isGroupResourceConfigurationUpdateInProgress

public boolean isGroupResourceConfigurationUpdateInProgress(org.rhq.core.domain.auth.Subject subject,
                                                   int groupId)

Specified by:

isGroupResourceConfigurationUpdateInProgress in interface ConfigurationManagerRemote

Returns:

True if in progress, else False

isGroupPluginConfigurationUpdateInProgress

public boolean isGroupPluginConfigurationUpdateInProgress(org.rhq.core.domain.auth.Subject subject,
                                                 int groupId)

Specified by:

isGroupPluginConfigurationUpdateInProgress in interface ConfigurationManagerLocal

getResourceConfigurationsForCompatibleGroup

public Map<Integer,org.rhq.core.domain.configuration.Configuration> getResourceConfigurationsForCompatibleGroup(org.rhq.core.domain.auth.Subject subject,
                                                                                                       int groupId)
                                                                                                         throws ConfigurationUpdateStillInProgressException,
                                                                                                                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:

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 Map<Integer,org.rhq.core.domain.configuration.Configuration> getPluginConfigurationsForCompatibleGroup(org.rhq.core.domain.auth.Subject subject,
                                                                                                     int groupId)
                                                                                                       throws ConfigurationUpdateStillInProgressException,
                                                                                                              Exception

Specified by:

getPluginConfigurationsForCompatibleGroup in interface ConfigurationManagerLocal

Throws:

ConfigurationUpdateStillInProgressException

Exception

getLiveResourceConfiguration

public org.rhq.core.domain.configuration.Configuration getLiveResourceConfiguration(org.rhq.core.domain.auth.Subject subject,
                                                                           int resourceId,
                                                                           boolean pingAgentFirst)
                                                                             throws Exception

Description copied from interface: ConfigurationManagerRemote

Get the "live" resource configuration for the Resource with the given id. The live configuration is that of the resource at the time this call is made. The agent is queried and will collect the configuration by inspecting the resource.

Unlike ConfigurationManagerRemote.getLatestResourceConfigurationUpdate(Subject, int) this method has no affect on the "current" resource configuration stored server-side.

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" resource configuration, or null if the "live" configuration can not be determined due to agent or resource being unavailable.

Throws:

Exception

See Also:

#getLatestResourceConfigurationUpdate(Subject, int)}, #getLiveResourceConfiguration(Subject, int, boolean)}

getLiveResourceConfiguration

public org.rhq.core.domain.configuration.Configuration getLiveResourceConfiguration(org.rhq.core.domain.auth.Subject subject,
                                                                           int resourceId,
                                                                           boolean pingAgentFirst,
                                                                           boolean fromStructured)
                                                                             throws Exception

Specified by:

getLiveResourceConfiguration in interface ConfigurationManagerLocal

Throws:

Exception

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

@Deprecated
public org.rhq.core.domain.util.PageList<org.rhq.core.domain.configuration.PluginConfigurationUpdate> findPluginConfigurationUpdates(org.rhq.core.domain.auth.Subject subject,
                                                                                                                                       int resourceId,
                                                                                                                                       Long beginDate,
                                                                                                                                       Long endDate,
                                                                                                                                       org.rhq.core.domain.util.PageControl pc)

Deprecated. use findPluginConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject, org.rhq.core.domain.criteria.PluginConfigurationUpdateCriteria)

Specified by:

findPluginConfigurationUpdates in interface ConfigurationManagerLocal

findResourceConfigurationUpdates

@Deprecated
public org.rhq.core.domain.util.PageList<org.rhq.core.domain.configuration.ResourceConfigurationUpdate> findResourceConfigurationUpdates(org.rhq.core.domain.auth.Subject subject,
                                                                                                                                           Integer resourceId,
                                                                                                                                           Long beginDate,
                                                                                                                                           Long endDate,
                                                                                                                                           boolean suppressOldest,
                                                                                                                                           org.rhq.core.domain.util.PageControl pc)

Deprecated. use findResourceConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject, org.rhq.core.domain.criteria.ResourceConfigurationUpdateCriteria)

Description copied from interface: ConfigurationManagerLocal

Returns the list of all Resource configuration updates for the given Resource, in reverse of the order in which they were created (i.e. most recent update will be the first item in the list). This will show you an audit trail of the update history for the Resource (who updated it, when and what did they change). You can pick one configuration version to later rollback to that version via ConfigurationManagerRemote.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

@Deprecated
public org.rhq.core.domain.configuration.PluginConfigurationUpdate getPluginConfigurationUpdate(org.rhq.core.domain.auth.Subject subject,
                                                                                                  int configurationUpdateId)

Deprecated. use criteria-based API

Description copied from interface: ConfigurationManagerLocal

Returns a single plugin configuration update.

Specified by:

getPluginConfigurationUpdate 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 plugin configuration update

getResourceConfigurationUpdate

@Deprecated
public org.rhq.core.domain.configuration.ResourceConfigurationUpdate getResourceConfigurationUpdate(org.rhq.core.domain.auth.Subject subject,
                                                                                                      int configurationUpdateId)

Deprecated. use criteria-based API

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(org.rhq.core.domain.auth.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:

purgePluginConfigurationUpdate 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

purgePluginConfigurationUpdates

public void purgePluginConfigurationUpdates(org.rhq.core.domain.auth.Subject subject,
                                   int[] configurationUpdateIds,
                                   boolean purgeInProgress)

Description copied from interface: ConfigurationManagerLocal

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

Specified by:

purgePluginConfigurationUpdates 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

purgeResourceConfigurationUpdate

public void purgeResourceConfigurationUpdate(org.rhq.core.domain.auth.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(org.rhq.core.domain.auth.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

updateStructuredOrRawConfiguration

public org.rhq.core.domain.configuration.ResourceConfigurationUpdate updateStructuredOrRawConfiguration(org.rhq.core.domain.auth.Subject subject,
                                                                                               int resourceId,
                                                                                               org.rhq.core.domain.configuration.Configuration newConfiguration,
                                                                                               boolean fromStructured)
                                                                                                 throws ResourceNotFoundException,
                                                                                                        ConfigurationUpdateStillInProgressException

Specified by:

updateStructuredOrRawConfiguration in interface ConfigurationManagerLocal

Throws:

ResourceNotFoundException

ConfigurationUpdateStillInProgressException

updateResourceConfiguration

@Nullable
public org.rhq.core.domain.configuration.ResourceConfigurationUpdate updateResourceConfiguration(org.rhq.core.domain.auth.Subject subject,
                                                                                                 int resourceId,
                                                                                                 org.rhq.core.domain.configuration.Configuration newResourceConfiguration)
                                                                                          throws ResourceNotFoundException

Description copied from interface: ConfigurationManagerRemote

This method is called when a user has requested to change the resource configuration for an existing resource.

This will not wait for the agent to finish the configuration update. This will return after the request is sent.

Specified by:

updateResourceConfiguration in interface ConfigurationManagerRemote

Parameters:

subject - The logged in user's subject.

resourceId - identifies the resource to be updated

newResourceConfiguration - the resource's desired new configuration

Returns:

the resource configuration update item corresponding to this request

Throws:

ResourceNotFoundException

executeResourceConfigurationUpdate

public void executeResourceConfigurationUpdate(int updateId)

Specified by:

executeResourceConfigurationUpdate in interface ConfigurationManagerLocal

rollbackResourceConfiguration

public void rollbackResourceConfiguration(org.rhq.core.domain.auth.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

rollbackPluginConfiguration

public void rollbackPluginConfiguration(org.rhq.core.domain.auth.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 plugin 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 plugin 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.completePluginConfigurationUpdate(org.rhq.core.domain.configuration.PluginConfigurationUpdate).

Specified by:

rollbackPluginConfiguration 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

persistResourceConfigurationUpdateInNewTransaction

public org.rhq.core.domain.configuration.ResourceConfigurationUpdate persistResourceConfigurationUpdateInNewTransaction(org.rhq.core.domain.auth.Subject subject,
                                                                                                               int resourceId,
                                                                                                               org.rhq.core.domain.configuration.Configuration newConfiguration,
                                                                                                               org.rhq.core.domain.configuration.ConfigurationUpdateStatus newStatus,
                                                                                                               String newSubject,
                                                                                                               boolean isPartofGroupUpdate)
                                                                                                                 throws ResourceNotFoundException,
                                                                                                                        ConfigurationUpdateStillInProgressException

Description copied from interface: ConfigurationManagerLocal

For internal use only - do not call this method. This is for ConfigurationManagerRemote.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 ConfigurationManagerRemote.getLatestResourceConfigurationUpdate(Subject, int) and ConfigurationManagerRemote.scheduleGroupResourceConfigurationUpdate(org.rhq.core.domain.auth.Subject, int, java.util.Map<java.lang.Integer, org.rhq.core.domain.configuration.Configuration>).

Specified by:

persistResourceConfigurationUpdateInNewTransaction in interface ConfigurationManagerLocal

Parameters:

subject - ASSUMES CONFIGURE_WRITE perm for resource in question, no authz checks in this method.

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. Note, on success the normally lazy-loaded ResourceConfigurationUpdate.resource.agent will be provided.

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 org.rhq.core.domain.configuration.definition.ConfigurationDefinition getPackageTypeConfigurationDefinition(org.rhq.core.domain.auth.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 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.

getResourceConfigurationDefinitionForResourceType

public org.rhq.core.domain.configuration.definition.ConfigurationDefinition getResourceConfigurationDefinitionForResourceType(org.rhq.core.domain.auth.Subject subject,
                                                                                                                     int resourceTypeId)

Description copied from interface: ConfigurationManagerRemote

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

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 org.rhq.core.domain.configuration.definition.ConfigurationDefinition getResourceConfigurationDefinitionWithTemplatesForResourceType(org.rhq.core.domain.auth.Subject subject,
                                                                                                                                           int resourceTypeId)

Description copied from interface: ConfigurationManagerRemote

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 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

getPluginConfigurationDefinitionForResourceType

public org.rhq.core.domain.configuration.definition.ConfigurationDefinition getPluginConfigurationDefinitionForResourceType(org.rhq.core.domain.auth.Subject subject,
                                                                                                                   int resourceTypeId)

Description copied from interface: ConfigurationManagerRemote

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

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 org.rhq.core.domain.configuration.AbstractResourceConfigurationUpdate mergeConfigurationUpdate(org.rhq.core.domain.configuration.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 org.rhq.core.domain.configuration.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 org.rhq.core.domain.configuration.Configuration getConfiguration(org.rhq.core.domain.auth.Subject subject,
                                                               int configurationId)

Specified by:

getConfiguration in interface ConfigurationManagerLocal

getConfigurationFromDefaultTemplate

public org.rhq.core.domain.configuration.Configuration getConfigurationFromDefaultTemplate(org.rhq.core.domain.configuration.definition.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(org.rhq.core.domain.configuration.group.AbstractGroupConfigurationUpdate update)
                                   throws org.quartz.SchedulerException

Specified by:

createGroupConfigurationUpdate in interface ConfigurationManagerLocal

Throws:

org.quartz.SchedulerException

scheduleGroupPluginConfigurationUpdate

public int scheduleGroupPluginConfigurationUpdate(org.rhq.core.domain.auth.Subject subject,
                                         int compatibleGroupId,
                                         Map<Integer,org.rhq.core.domain.configuration.Configuration> memberPluginConfigurations)

Description copied from interface: ConfigurationManagerRemote

Schedules jobs to update the plugin configuration of resources in a compatible group.

Specified by:

scheduleGroupPluginConfigurationUpdate in interface ConfigurationManagerRemote

Parameters:

subject - logged in user

compatibleGroupId - the compatible group id

memberPluginConfigurations - Configuration objects mapped by resource id

Returns:

the GroupPluginConfigurationUpdate id

scheduleGroupResourceConfigurationUpdate

public int scheduleGroupResourceConfigurationUpdate(org.rhq.core.domain.auth.Subject subject,
                                           int compatibleGroupId,
                                           Map<Integer,org.rhq.core.domain.configuration.Configuration> newResourceConfigurationMap)

Specified by:

scheduleGroupResourceConfigurationUpdate in interface ConfigurationManagerRemote

Returns:

GroupResourceConfigurationUpdate id

getGroupPluginConfigurationById

@Deprecated
public org.rhq.core.domain.configuration.group.GroupPluginConfigurationUpdate getGroupPluginConfigurationById(int configurationUpdateId)

Deprecated. use findGroupPluginConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject, org.rhq.core.domain.criteria.GroupPluginConfigurationUpdateCriteria)

Specified by:

getGroupPluginConfigurationById in interface ConfigurationManagerLocal

getGroupResourceConfigurationById

@Deprecated
public org.rhq.core.domain.configuration.group.GroupResourceConfigurationUpdate getGroupResourceConfigurationById(int configurationUpdateId)

Deprecated. use findGroupResourceConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject, org.rhq.core.domain.criteria.GroupResourceConfigurationUpdateCriteria)

Specified by:

getGroupResourceConfigurationById in interface ConfigurationManagerLocal

findPluginConfigurationUpdateCompositesByParentId

public org.rhq.core.domain.util.PageList<org.rhq.core.domain.configuration.composite.ConfigurationUpdateComposite> findPluginConfigurationUpdateCompositesByParentId(int configurationUpdateId,
                                                                                                                                                            org.rhq.core.domain.util.PageControl pageControl)

Specified by:

findPluginConfigurationUpdateCompositesByParentId in interface ConfigurationManagerLocal

findResourceConfigurationUpdateCompositesByParentId

public org.rhq.core.domain.util.PageList<org.rhq.core.domain.configuration.composite.ConfigurationUpdateComposite> findResourceConfigurationUpdateCompositesByParentId(org.rhq.core.domain.auth.Subject subject,
                                                                                                                                                              int configurationUpdateId,
                                                                                                                                                              org.rhq.core.domain.util.PageControl pageControl)

Specified by:

findResourceConfigurationUpdateCompositesByParentId in interface ConfigurationManagerLocal

findPluginConfigurationUpdatesByParentId

@Deprecated
public org.rhq.core.domain.util.PageList<Integer> findPluginConfigurationUpdatesByParentId(int configurationUpdateId,
                                                                                             org.rhq.core.domain.util.PageControl pageControl)

Deprecated. use findPluginConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject, org.rhq.core.domain.criteria.PluginConfigurationUpdateCriteria)

Specified by:

findPluginConfigurationUpdatesByParentId in interface ConfigurationManagerLocal

getPluginConfigurationUpdateCountByParentId

public long getPluginConfigurationUpdateCountByParentId(int configurationUpdateId)

Specified by:

getPluginConfigurationUpdateCountByParentId in interface ConfigurationManagerLocal

findResourceConfigurationUpdatesByParentId

@Deprecated
public org.rhq.core.domain.util.PageList<Integer> findResourceConfigurationUpdatesByParentId(int groupConfigurationUpdateId,
                                                                                               org.rhq.core.domain.util.PageControl pageControl)

Deprecated. use findResourceConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject, org.rhq.core.domain.criteria.ResourceConfigurationUpdateCriteria)

Specified by:

findResourceConfigurationUpdatesByParentId in interface ConfigurationManagerLocal

getResourceConfigurationUpdateCountByParentId

public long getResourceConfigurationUpdateCountByParentId(int groupConfigurationUpdateId)

Specified by:

getResourceConfigurationUpdateCountByParentId in interface ConfigurationManagerLocal

getResourceConfigurationMapForGroupUpdate

public Map<Integer,org.rhq.core.domain.configuration.Configuration> getResourceConfigurationMapForGroupUpdate(org.rhq.core.domain.auth.Subject subject,
                                                                                                     Integer groupResourceConfigurationUpdateId)

Specified by:

getResourceConfigurationMapForGroupUpdate in interface ConfigurationManagerLocal

getPluginConfigurationMapForGroupUpdate

public Map<Integer,org.rhq.core.domain.configuration.Configuration> getPluginConfigurationMapForGroupUpdate(org.rhq.core.domain.auth.Subject subject,
                                                                                                   Integer groupPluginConfigurationUpdateId)

Specified by:

getPluginConfigurationMapForGroupUpdate in interface ConfigurationManagerLocal

findGroupPluginConfigurationUpdates

@Deprecated
public org.rhq.core.domain.util.PageList<org.rhq.core.domain.configuration.group.GroupPluginConfigurationUpdate> findGroupPluginConfigurationUpdates(int groupId,
                                                                                                                                                       org.rhq.core.domain.util.PageControl pc)

Deprecated. use findGroupPluginConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject, org.rhq.core.domain.criteria.GroupPluginConfigurationUpdateCriteria)

Specified by:

findGroupPluginConfigurationUpdates in interface ConfigurationManagerLocal

findGroupResourceConfigurationUpdates

@Deprecated
public org.rhq.core.domain.util.PageList<org.rhq.core.domain.configuration.group.GroupResourceConfigurationUpdate> findGroupResourceConfigurationUpdates(org.rhq.core.domain.auth.Subject subject,
                                                                                                                                                           int groupId,
                                                                                                                                                           org.rhq.core.domain.util.PageControl pc)

Deprecated. use findGroupResourceConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject, org.rhq.core.domain.criteria.GroupResourceConfigurationUpdateCriteria)

Specified by:

findGroupResourceConfigurationUpdates in interface ConfigurationManagerLocal

updateGroupResourceConfigurationUpdateStatus

public org.rhq.core.domain.configuration.ConfigurationUpdateStatus updateGroupResourceConfigurationUpdateStatus(int groupResourceConfigurationUpdateId,
                                                                                                       String errorMessages)

Specified by:

updateGroupResourceConfigurationUpdateStatus in interface ConfigurationManagerLocal

updateGroupPluginConfigurationUpdateStatus

public org.rhq.core.domain.configuration.ConfigurationUpdateStatus updateGroupPluginConfigurationUpdateStatus(int groupPluginConfigurationUpdateId,
                                                                                                     String errorMessages)

Specified by:

updateGroupPluginConfigurationUpdateStatus in interface ConfigurationManagerLocal

deleteGroupPluginConfigurationUpdates

public int deleteGroupPluginConfigurationUpdates(org.rhq.core.domain.auth.Subject subject,
                                        Integer resourceGroupId,
                                        Integer[] groupPluginConfigurationUpdateIds)

Specified by:

deleteGroupPluginConfigurationUpdates in interface ConfigurationManagerLocal

deleteGroupResourceConfigurationUpdates

public int deleteGroupResourceConfigurationUpdates(org.rhq.core.domain.auth.Subject subject,
                                          Integer resourceGroupId,
                                          Integer[] groupResourceConfigurationUpdateIds)

Specified by:

deleteGroupResourceConfigurationUpdates in interface ConfigurationManagerLocal

updateGroupConfigurationUpdate

public void updateGroupConfigurationUpdate(org.rhq.core.domain.configuration.group.AbstractGroupConfigurationUpdate groupUpdate)

Specified by:

updateGroupConfigurationUpdate in interface ConfigurationManagerLocal

deleteConfigurations

public void deleteConfigurations(List<Integer> configurationIds)

Specified by:

deleteConfigurations in interface ConfigurationManagerLocal

deleteProperties

public void deleteProperties(int[] propertyIds)

Specified by:

deleteProperties in interface ConfigurationManagerLocal

getGroupPluginConfigurationUpdate

public org.rhq.core.domain.configuration.group.GroupPluginConfigurationUpdate getGroupPluginConfigurationUpdate(org.rhq.core.domain.auth.Subject subject,
                                                                                                       int configurationUpdateId)

Specified by:

getGroupPluginConfigurationUpdate in interface ConfigurationManagerRemote

Returns:

object

getGroupResourceConfigurationUpdate

public org.rhq.core.domain.configuration.group.GroupResourceConfigurationUpdate getGroupResourceConfigurationUpdate(org.rhq.core.domain.auth.Subject subject,
                                                                                                           int configurationUpdateId)

Specified by:

getGroupResourceConfigurationUpdate in interface ConfigurationManagerRemote

Returns:

object

translateResourceConfiguration

public org.rhq.core.domain.configuration.Configuration translateResourceConfiguration(org.rhq.core.domain.auth.Subject subject,
                                                                             int resourceId,
                                                                             org.rhq.core.domain.configuration.Configuration configuration,
                                                                             boolean fromStructured)

Specified by:

translateResourceConfiguration in interface ConfigurationManagerRemote

Returns:

the translated configuration

mergeConfiguration

public org.rhq.core.domain.configuration.Configuration mergeConfiguration(org.rhq.core.domain.configuration.Configuration config)

Specified by:

mergeConfiguration in interface ConfigurationManagerLocal

findResourceConfigurationUpdatesByCriteria

public org.rhq.core.domain.util.PageList<org.rhq.core.domain.configuration.ResourceConfigurationUpdate> findResourceConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject subject,
                                                                                                                                          org.rhq.core.domain.criteria.ResourceConfigurationUpdateCriteria criteria)

Specified by:

findResourceConfigurationUpdatesByCriteria in interface ConfigurationManagerLocal

findPluginConfigurationUpdatesByCriteria

public org.rhq.core.domain.util.PageList<org.rhq.core.domain.configuration.PluginConfigurationUpdate> findPluginConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject subject,
                                                                                                                                      org.rhq.core.domain.criteria.PluginConfigurationUpdateCriteria criteria)

Specified by:

findPluginConfigurationUpdatesByCriteria in interface ConfigurationManagerLocal

findGroupResourceConfigurationUpdatesByCriteria

public org.rhq.core.domain.util.PageList<org.rhq.core.domain.configuration.group.GroupResourceConfigurationUpdate> findGroupResourceConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject subject,
                                                                                                                                                          org.rhq.core.domain.criteria.GroupResourceConfigurationUpdateCriteria criteria)

Description copied from interface: ConfigurationManagerRemote

Note that when setting AbstractGroupConfigurationUpdateCriteria.fetchConfigurationUpdates(boolean) to true, the current resource configurations are returned. The "current" configuration is the one most recently reported and stored server-side, the agent is not queried. Recent, unreported changes in the "live" configuration will not be reported. Querying the agent is slower and not typically necessary, as configuration changes infrequently.

Specified by:

findGroupResourceConfigurationUpdatesByCriteria in interface ConfigurationManagerRemote

Returns:

not null

See Also:

#getLatestResourceConfigurationUpdate(Subject, int)}, #getLiveResourceConfiguration(Subject, int, boolean)}

findGroupPluginConfigurationUpdatesByCriteria

public org.rhq.core.domain.util.PageList<org.rhq.core.domain.configuration.group.GroupPluginConfigurationUpdate> findGroupPluginConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject subject,
                                                                                                                                                      org.rhq.core.domain.criteria.GroupPluginConfigurationUpdateCriteria criteria)

Specified by:

findGroupPluginConfigurationUpdatesByCriteria in interface ConfigurationManagerRemote

Returns:

not null

See Also:

#getLatestPluginConfigurationUpdate(Subject, int)}

getOptionsForConfigurationDefinition

public org.rhq.core.domain.configuration.definition.ConfigurationDefinition getOptionsForConfigurationDefinition(org.rhq.core.domain.auth.Subject subject,
                                                                                                        int resourceId,
                                                                                                        int parentResourceId,
                                                                                                        org.rhq.core.domain.configuration.definition.ConfigurationDefinition def)

Specified by:

getOptionsForConfigurationDefinition in interface ConfigurationManagerLocal