public interface DiscoveryAgentService
| Modifier and Type | Method and Description |
|---|---|
void |
disableServiceScans(int serverResourceId)
Disable periodic scans for new services for the specified server.
|
void |
enableServiceScans(int serverResourceId,
org.rhq.core.domain.configuration.Configuration config)
Enable periodic scans for new services for the specified server, using the specified discovery configuration.
|
org.rhq.core.domain.discovery.AvailabilityReport |
executeAvailabilityScanImmediately(boolean changedOnlyReport)
Checks the availability of all resources and returns a report on their availability statuses.
|
InventoryReport |
executeServerScanImmediately()
Executes an immediate plugin discovery scan for top-level servers.
|
void |
executeServiceScanDeferred()
This method asks that a service scan be performed, but it does not wait for the results of that scan.
|
InventoryReport |
executeServiceScanImmediately()
Executes an immediate plugin discovery scan for services and non-top-level servers.
|
org.rhq.core.domain.discovery.AvailabilityReport |
getCurrentAvailability(org.rhq.core.domain.resource.Resource resource,
boolean changesOnly)
Returns the current availability for the specified resource.
|
org.rhq.core.domain.resource.Resource |
getPlatform()
Access to the current inventory managed by the plugin container.
|
org.rhq.core.domain.discovery.MergeResourceResponse |
manuallyAddResource(org.rhq.core.domain.resource.ResourceType resourceType,
int parentResourceId,
org.rhq.core.domain.configuration.Configuration pluginConfiguration,
int creatorSubjectId)
Manually discover the resource of the specified type using the specified plugin configuration (i.e.
|
void |
requestFullAvailabilityReport()
This call will request that the agent produce a full availability report on its next availability scan.
|
void |
synchronizeInventory(org.rhq.core.domain.discovery.ResourceSyncInfo syncInfo)
Called to inform the agent of a status change for the resource represented by syncInfo.
|
void |
uninventoryResource(int resourceId)
Shuts down and removes a Resource and its descendants from the PC's inventory.
|
void |
updatePluginConfiguration(int resourceId,
org.rhq.core.domain.configuration.Configuration newPluginConfiguration)
This will update the plugin configuration for the resource with the given ID.
|
void updatePluginConfiguration(int resourceId,
org.rhq.core.domain.configuration.Configuration newPluginConfiguration)
throws InvalidPluginConfigurationClientException,
PluginContainerException
resourceId - identifies the resource whose plugin configuration is to be updatednewPluginConfiguration - the new plugin configurationInvalidPluginConfigurationClientException - if failed to update the plugin configuration or failed to
restart the component due to a bad plugin configurationPluginContainerException - if failed for some other reasonvoid synchronizeInventory(org.rhq.core.domain.discovery.ResourceSyncInfo syncInfo)
syncInfo - for the root of the tree to be updated.org.rhq.core.domain.resource.Resource getPlatform()
@NotNull InventoryReport executeServerScanImmediately() throws PluginContainerException
PluginContainerException - if the server scan fails@NotNull InventoryReport executeServiceScanImmediately() throws PluginContainerException
PluginContainerException - if the service scan failsvoid executeServiceScanDeferred()
org.rhq.core.domain.discovery.AvailabilityReport executeAvailabilityScanImmediately(boolean changedOnlyReport)
changedOnlyReport - if true, the report returned will only contain statuses for those
resources that have changed availability status from their last known state. If
false, the report will contain information on all known resources (which will
make the report much larger than had true been passed in).@NotNull
org.rhq.core.domain.discovery.AvailabilityReport getCurrentAvailability(org.rhq.core.domain.resource.Resource resource,
boolean changesOnly)
changesOnly is set to true. If it is false, the report will always contain
the availability of the supplied resource but can also additionally contain the availabilities of some of its
child resources, if they were eligible for availability collection at the time of calling this method.
Also note that the availability types of the resources in the report may have any of the following values from
the AvailabilityType enum - it may happen that the availability of the resource is
AvailabilityType.UNKNOWN if the resource component is not started.
IMPORTANT: The report is NOT sent up to the server as a consequence of calling this method (unlike for
example in the case of executeAvailabilityScanImmediately(boolean)). The caller itself is responsible to
correctly handle the report within the server.resource - the resource to return the availability of.changesOnly - if true, only changes in availability will be reported, if false the report will contain
the availabilities of all resources eligible for collection at the time of the call regardless
of whether their availability changed or not.void requestFullAvailabilityReport()
org.rhq.core.domain.discovery.MergeResourceResponse manuallyAddResource(org.rhq.core.domain.resource.ResourceType resourceType,
int parentResourceId,
org.rhq.core.domain.configuration.Configuration pluginConfiguration,
int creatorSubjectId)
throws InvalidPluginConfigurationClientException,
PluginContainerException
resourceType - the type of resource to be manually addedparentResourceId - the id of the resource that will be the parent of the manually discovered resourcepluginConfiguration - the properties that should be used to connect to the underlying managed resourcecreatorSubjectId - the Subject id of the JON user that requested the
addition of the resourceResourceError that might have occurred during
the activation of the resourceInvalidPluginConfigurationClientException - if connecting to the underlying managed resource failed due to
an invalid plugin configuration.PluginContainerException - if the manual discovery fails for any other reasonvoid uninventoryResource(int resourceId)
resourceId - the id of the Resource to removevoid enableServiceScans(int serverResourceId,
org.rhq.core.domain.configuration.Configuration config)
serverResourceId - resource id of the serverconfig - discovery configuration for the servervoid disableServiceScans(int serverResourceId)
serverResourceId - resource id of the serverCopyright © 2008-2013 Red Hat, Inc.. All Rights Reserved.