org.rhq.enterprise.server.measurement

Interface AvailabilityManagerLocal

All Superinterfaces:

AvailabilityManagerRemote

All Known Implementing Classes:

AvailabilityManagerBean

public interface AvailabilityManagerLocal
extends AvailabilityManagerRemote

Manager that is used to determine a resource's availability over a span of time.

Author:

Heiko W. Rupp, John Mazzitelli

Method Summary

Methods

Modifier and Type	Method and Description
List<AvailabilityPoint>	findAvailabilitiesForAutoGroup(org.rhq.core.domain.auth.Subject subject, int parentResourceId, int resourceTypeId, long begin, long end, int points, boolean withCurrentAvailability) Deprecated. going away with portal war removal
List<AvailabilityPoint>	findAvailabilitiesForResource(org.rhq.core.domain.auth.Subject subject, int resourceId, long begin, long end, int points, boolean withCurrentAvailability) Deprecated. going away with portal war removal
List<AvailabilityPoint>	findAvailabilitiesForResourceGroup(org.rhq.core.domain.auth.Subject subject, int groupId, long begin, long end, int points, boolean withCurrentAvailability) Deprecated. going away with portal war removal
List<org.rhq.core.domain.measurement.Availability>	findAvailabilityWithinInterval(int resourceId, Date startDate, Date endDate) Deprecated.
List<org.rhq.core.domain.measurement.Availability>	getAvailabilitiesForResource(org.rhq.core.domain.auth.Subject subject, int resourceId, long startTime, long endTime) Get Availability records for a resource covering the desired time span.
List<org.rhq.core.domain.resource.group.composite.ResourceGroupAvailability>	getAvailabilitiesForResourceGroup(org.rhq.core.domain.auth.Subject subject, int resourceGroupId, long startTime, long endTime) Get ResourceGroupAvailability records for a resource group covering the desired time span.
org.rhq.core.domain.measurement.AvailabilityType	getCurrentAvailabilityTypeForResource(org.rhq.core.domain.auth.Subject subject, int resourceId) Indicates if the given resource is currently up (i.e.
void	mergeAvailabilitiesInNewTransaction(List<org.rhq.core.domain.measurement.Availability> availabilities, org.rhq.enterprise.server.measurement.AvailabilityManagerBean.MergeInfo mergeInfo) Internal use only.
boolean	mergeAvailabilityReport(org.rhq.core.domain.discovery.AvailabilityReport report) Merge an AvailabilityReport that has been received from an agent.
void	scheduleAvailabilityDurationCheck(AvailabilityDurationCacheElement cacheElement, org.rhq.core.domain.resource.Resource resource, long startTime) Create the EJB Timer to schedule a check for a single availability duration condition match.
void	setResourceAvailabilities(Map<org.rhq.core.domain.resource.Agent,int[]> map, org.rhq.core.domain.measurement.AvailabilityType avail) Allows for resources to have their availabilities explicit set to the given avail type.
void	updateAgentResourceAvailabilities(int agentId, org.rhq.core.domain.measurement.AvailabilityType platformAvailabilityType, org.rhq.core.domain.measurement.AvailabilityType childAvailabilityType) Update availabilities for all resources managed by the given agent to the given availability type (which may be null to indicate unknown).
void	updateLastAvailabilityReportInNewTransaction(int agentId) Executing this method will update the given agent's lastAvailabilityReport time in a new transaction.

Methods inherited from interface org.rhq.enterprise.server.measurement.AvailabilityManagerRemote

findAvailabilityByCriteria, findAvailabilityForResource, getCurrentAvailabilityForResource

Method Detail

getCurrentAvailabilityTypeForResource

org.rhq.core.domain.measurement.AvailabilityType getCurrentAvailabilityTypeForResource(org.rhq.core.domain.auth.Subject subject,
                                                                                     int resourceId)

Indicates if the given resource is currently up (i.e. available) or down.

Parameters:

subject -

resourceId -

Returns:

the current status of the resource

getAvailabilitiesForResource

List<org.rhq.core.domain.measurement.Availability> getAvailabilitiesForResource(org.rhq.core.domain.auth.Subject subject,
                                                                              int resourceId,
                                                                              long startTime,
                                                                              long endTime)

Get Availability records for a resource covering the desired time span.

Parameters:

subject -

resourceId - The relevant resource

startTime - If start time precedes recorded availability UNKNOWN will be used to fill the gap

endTime - If end time is in the future the current Availability will be extended to fill the gap

Returns:

the availabilities over the given time span, in increasing time order

getAvailabilitiesForResourceGroup

List<org.rhq.core.domain.resource.group.composite.ResourceGroupAvailability> getAvailabilitiesForResourceGroup(org.rhq.core.domain.auth.Subject subject,
                                                                                                             int resourceGroupId,
                                                                                                             long startTime,
                                                                                                             long endTime)

Get ResourceGroupAvailability records for a resource group covering the desired time span. See ResourceGroupAvailability for more on how group availability is calculated.

Parameters:

subject -

resourceGroupId - The relevant resource group

startTime - If start time precedes recorded availability UNKNOWN will be used to fill the gap

endTime - If end time is in the future the current Availability will be extended to fill the gap

Returns:

the resource group availabilities over the given time span, in increasing time order

findAvailabilitiesForResource

@Deprecated
List<AvailabilityPoint> findAvailabilitiesForResource(org.rhq.core.domain.auth.Subject subject,
                                                               int resourceId,
                                                               long begin,
                                                               long end,
                                                               int points,
                                                               boolean withCurrentAvailability)

Deprecated. going away with portal war removal

Get the individual availability data points for the given resource.

Parameters:

subject -

resourceId - PK of the resource wanted

begin - start time for data we are interested in

end - end time for data we are interested in

points - number of data points to return

withCurrentAvailability - if true, the last data point in the range will match the resource's current availability no matter what

Returns:

the availabilities over the given time span in a list

findAvailabilitiesForResourceGroup

@Deprecated
List<AvailabilityPoint> findAvailabilitiesForResourceGroup(org.rhq.core.domain.auth.Subject subject,
                                                                    int groupId,
                                                                    long begin,
                                                                    long end,
                                                                    int points,
                                                                    boolean withCurrentAvailability)

Deprecated. going away with portal war removal

Get the individual availability data points for the given resource group.

Parameters:

subject -

groupId - PK of the resource group wanted

begin - start time for data we are interested in

end - end time for data we are interested in

points - number of data points to return

withCurrentAvailability - if true, the last data point in the range will match the resource group's current availability no matter what

Returns:

the availabilities over the given time span in a list

findAvailabilitiesForAutoGroup

@Deprecated
List<AvailabilityPoint> findAvailabilitiesForAutoGroup(org.rhq.core.domain.auth.Subject subject,
                                                                int parentResourceId,
                                                                int resourceTypeId,
                                                                long begin,
                                                                long end,
                                                                int points,
                                                                boolean withCurrentAvailability)

Deprecated. going away with portal war removal

Get the individual availability data points for the given auto group.

Parameters:

subject -

parentResourceId - PK of the parent resource of the auto group wanted

resourceTypeId - PK of the resource type of the auto group wanted

begin - start time for data we are interested in

end - end time for data we are interested in

points - number of data points to return

withCurrentAvailability - if true, the last data point in the range will match the autogroup's current availability no matter what

Returns:

the availabilities over the given time span in a list

setResourceAvailabilities

void setResourceAvailabilities(Map<org.rhq.core.domain.resource.Agent,int[]> map,
                             org.rhq.core.domain.measurement.AvailabilityType avail)

Allows for resources to have their availabilities explicit set to the given avail type. This circumvents the last availability the resource's agents reported for them.

Parameters:

map - map of Agents to the resources for that agent that need to be updated with the provided avail

avail - the new availability for the resources

mergeAvailabilityReport

boolean mergeAvailabilityReport(org.rhq.core.domain.discovery.AvailabilityReport report)

Merge an AvailabilityReport that has been received from an agent. A report will only contain those availabilities that have changed since the agent's last sent report. Note that if an agent has been restarted, it will always send a full report as its first. An agent is obliged to sent at least one availability record in the report in order for the server to determine which agent is sending the report (since a record has a Resource in it and from any Resource we can determine the Agent).

Parameters:

report - the report containing 1 or more availabilities for 1 or more resources.

Returns:

If true, this indicates everything seems OK - the server merged everything successfully and the server and agent seem to be in sync with each. If false, the server thinks something isn't right and it may be out of sync with the agent. When false is returned, the caller should send in a full availability report the next time in order to ensure the server and agent are in sync. true should always be returned if the given availability report is already a full report.

mergeAvailabilitiesInNewTransaction

void mergeAvailabilitiesInNewTransaction(List<org.rhq.core.domain.measurement.Availability> availabilities,
                                       org.rhq.enterprise.server.measurement.AvailabilityManagerBean.MergeInfo mergeInfo)

Internal use only. Used only for transactional processing purposes.

Parameters:

availabilities -

mergeInfo -

updateLastAvailabilityReportInNewTransaction

void updateLastAvailabilityReportInNewTransaction(int agentId)

Executing this method will update the given agent's lastAvailabilityReport time in a new transaction.

SIDE-EFFECT: will unset the backfill flag if currently set on the agent.

Parameters:

agentId - the id of the agent

updateAgentResourceAvailabilities

void updateAgentResourceAvailabilities(int agentId,
                                     org.rhq.core.domain.measurement.AvailabilityType platformAvailabilityType,
                                     org.rhq.core.domain.measurement.AvailabilityType childAvailabilityType)

Update availabilities for all resources managed by the given agent to the given availability type (which may be null to indicate unknown). NOTE: This does not include the top-level platform resource for the agent. To update a single resource avail see #updateResourceAvailability(Subject, Availability).

Parameters:

agentId - all resources managed by this agent will have their availabilities changed

platformAvailabilityType - the type that the agent's top level platform resource will have

childAvailabilityType - the type that the agent's child resources will have

findAvailabilityWithinInterval

@Deprecated
List<org.rhq.core.domain.measurement.Availability> findAvailabilityWithinInterval(int resourceId,
                                                                                           Date startDate,
                                                                                           Date endDate)

Deprecated.

scheduleAvailabilityDurationCheck

void scheduleAvailabilityDurationCheck(AvailabilityDurationCacheElement cacheElement,
                                     org.rhq.core.domain.resource.Resource resource,
                                     long startTime)

Create the EJB Timer to schedule a check for a single availability duration condition match.

Parameters:

cacheElement -

resource -

startTime - the start time (the Availability startTime (an agent time)) of the duration check