org.rhq.enterprise.server.configuration

Interface ConfigurationManagerRemote

All Known Subinterfaces:

ConfigurationManagerLocal

All Known Implementing Classes:

ConfigurationManagerBean

public interface ConfigurationManagerRemote

The configuration manager which allows you to request resource configuration changes, view current resource configuration and previous update history and view/edit plugin configuration.

Author:

John Mazzitelli, Ian Springer

Method Summary

Methods

Modifier and Type	Method and Description
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>	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.configuration.group.GroupPluginConfigurationUpdate	getGroupPluginConfigurationUpdate(org.rhq.core.domain.auth.Subject subject, int configurationUpdateId) Deprecated. use findGroupPluginConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject, org.rhq.core.domain.criteria.GroupPluginConfigurationUpdateCriteria)
org.rhq.core.domain.configuration.group.GroupResourceConfigurationUpdate	getGroupResourceConfigurationUpdate(org.rhq.core.domain.auth.Subject subject, int configurationUpdateId) Deprecated. use findGroupResourceConfigurationUpdatesByCriteria(org.rhq.core.domain.auth.Subject, org.rhq.core.domain.criteria.GroupResourceConfigurationUpdateCriteria)
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.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.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(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.
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.
boolean	isGroupResourceConfigurationUpdateInProgress(org.rhq.core.domain.auth.Subject subject, int resourceGroupId)
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.
int	scheduleGroupPluginConfigurationUpdate(org.rhq.core.domain.auth.Subject subject, int compatibleGroupId, Map<Integer,org.rhq.core.domain.configuration.Configuration> pluginConfigurationUpdate) 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)
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) Deprecated. this feature was never full implemented and will be removed.
org.rhq.core.domain.configuration.PluginConfigurationUpdate	updatePluginConfiguration(org.rhq.core.domain.auth.Subject subject, int resourceId, org.rhq.core.domain.configuration.Configuration newConfiguration) 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 newConfiguration) This method is called when a user has requested to change the resource configuration for an existing resource.

Method Detail

findGroupPluginConfigurationUpdatesByCriteria

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)

Parameters:

subject -

criteria -

Returns:

not null

Since:

4.10

See Also:

#getLatestPluginConfigurationUpdate(Subject, int)}

findGroupResourceConfigurationUpdatesByCriteria

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

Parameters:

subject -

criteria -

Returns:

not null

Since:

4.10

See Also:

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

getGroupPluginConfigurationUpdate

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

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

Parameters:

subject -

configurationUpdateId -

Returns:

object

getGroupResourceConfigurationUpdate

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

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

Parameters:

subject -

configurationUpdateId -

Returns:

object

getPluginConfiguration

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. The "current" configuration is that which has been most recently reported and stored server-side, the agent is not queried.

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

getResourceConfiguration

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. The "current" configuration is that which has been most recently reported and stored server-side, the agent is not queried.

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

getLatestPluginConfigurationUpdate

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. This is the same as getPluginConfiguration(Subject, int) but returns the full update information as opposed to just the configuration.

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

getLatestResourceConfigurationUpdate

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. 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 getLiveResourceConfiguration(Subject, int, boolean) in that it will return the latest stored configuration if the agent can not be queried. This differs from getResourceConfiguration(Subject, int) in that it will attempt to query the agent to capture the "live" configuration.

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

isResourceConfigurationUpdateInProgress

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.

Parameters:

subject - The logged in user's subject.

resourceId - A resource id.

Returns:

True if in progress, else False.

isGroupResourceConfigurationUpdateInProgress

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

Parameters:

subject -

resourceGroupId -

Returns:

True if in progress, else False

scheduleGroupPluginConfigurationUpdate

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

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

Parameters:

subject - logged in user

compatibleGroupId - the compatible group id

pluginConfigurationUpdate - Configuration objects mapped by resource id

Returns:

the GroupPluginConfigurationUpdate id

scheduleGroupResourceConfigurationUpdate

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

Parameters:

subject -

compatibleGroupId -

newResourceConfigurationMap -

Returns:

GroupResourceConfigurationUpdate id

updatePluginConfiguration

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

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

Parameters:

subject - The logged in user's subject.

resourceId - a Resource id

newConfiguration - the new plugin configuration

Returns:

the plugin configuration update item corresponding to this request

Throws:

ResourceNotFoundException

PermissionException - If the caller lacks MODIFY permission on the Resource.

BadArgumentException - If attempting to change a readOnly property value.

updateResourceConfiguration

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

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.

Parameters:

subject - The logged in user's subject.

resourceId - identifies the resource to be updated

newConfiguration - the resource's desired new configuration

Returns:

the resource configuration update item corresponding to this request

Throws:

ResourceNotFoundException

ConfigurationUpdateStillInProgressException

PermissionException - If the caller lacks CONFIGURE_WRITE permission on the Resource.

BadArgumentException - If attempting to change a readOnly property value.

getLiveResourceConfiguration

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

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 getLatestResourceConfigurationUpdate(Subject, int) this method has no affect on the "current" resource configuration stored server-side.

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

getResourceConfigurationDefinitionForResourceType

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.

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

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. The templates will be loaded in the definition returned from this call.

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

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.

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

getPackageTypeConfigurationDefinition

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.

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.

translateResourceConfiguration

@Deprecated
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)
                                                                               throws ResourceNotFoundException

Deprecated. this feature was never full implemented and will be removed.

Parameters:

subject -

resourceId -

configuration -

fromStructured -

Returns:

the translated configuration

Throws:

ResourceNotFoundException