org.rhq.enterprise.server.measurement

Class AvailabilityManagerBean

java.lang.Object

org.rhq.enterprise.server.measurement.AvailabilityManagerBean

All Implemented Interfaces:

AvailabilityManagerLocal, AvailabilityManagerRemote

public class AvailabilityManagerBean
extends Object
implements AvailabilityManagerLocal, AvailabilityManagerRemote

Manager for availability related tasks.

Author:

Heiko W. Rupp, John Mazzitelli

Constructor Summary

Constructors

Constructor and Description
AvailabilityManagerBean()

Method Summary

Methods

Modifier and Type	Method and Description
List<AvailabilityPoint>	findAvailabilitiesForAutoGroup(org.rhq.core.domain.auth.Subject subject, int parentResourceId, int resourceTypeId, long fullRangeBeginTime, long fullRangeEndTime, int numberOfPoints, boolean withCurrentAvailability) Get the individual availability data points for the given auto group.
List<AvailabilityPoint>	findAvailabilitiesForResource(org.rhq.core.domain.auth.Subject subject, int resourceId, long fullRangeBeginTime, long fullRangeEndTime, int numberOfPoints, boolean withCurrentAvailability) Get the individual availability data points for the given resource.
List<AvailabilityPoint>	findAvailabilitiesForResourceGroup(org.rhq.core.domain.auth.Subject subject, int groupId, long fullRangeBeginTime, long fullRangeEndTime, int numberOfPoints, boolean withCurrentAvailability) Get the individual availability data points for the given resource group.
org.rhq.core.domain.util.PageList<org.rhq.core.domain.measurement.Availability>	findAvailabilityByCriteria(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.criteria.AvailabilityCriteria criteria)
org.rhq.core.domain.util.PageList<org.rhq.core.domain.measurement.Availability>	findAvailabilityForResource(org.rhq.core.domain.auth.Subject subject, int resourceId, org.rhq.core.domain.util.PageControl pageControl) Deprecated.
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 groupId, long startTime, long endTime) Get ResourceGroupAvailability records for a resource group covering the desired time span.
org.rhq.core.domain.measurement.Availability	getCurrentAvailabilityForResource(org.rhq.core.domain.auth.Subject subject, int resourceId) Gets the last known Availability for the given resource - which includes whether it is currently up (i.e.
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	handleAvailabilityDurationCheck(javax.ejb.Timer timer)
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 platformAvailType, org.rhq.core.domain.measurement.AvailabilityType childAvailType) 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 class java.lang.Object

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

Constructor Detail

AvailabilityManagerBean

public AvailabilityManagerBean()

Method Detail

getCurrentAvailabilityTypeForResource

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

Description copied from interface: AvailabilityManagerLocal

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

Specified by:

getCurrentAvailabilityTypeForResource in interface AvailabilityManagerLocal

Returns:

the current status of the resource

getCurrentAvailabilityForResource

public org.rhq.core.domain.measurement.Availability getCurrentAvailabilityForResource(org.rhq.core.domain.auth.Subject subject,
                                                                             int resourceId)

Description copied from interface: AvailabilityManagerRemote

Gets the last known Availability for the given resource - which includes whether it is currently up (i.e. available) or down and the last time it was known to have changed to that state.

Specified by:

getCurrentAvailabilityForResource in interface AvailabilityManagerRemote

Parameters:

subject - the subject

resourceId - the resource

Returns:

the full and current status of the resource

getAvailabilitiesForResource

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

Description copied from interface: AvailabilityManagerLocal

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

Specified by:

getAvailabilitiesForResource in interface AvailabilityManagerLocal

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

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

Description copied from interface: AvailabilityManagerLocal

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

Specified by:

getAvailabilitiesForResourceGroup in interface AvailabilityManagerLocal

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

public List<AvailabilityPoint> findAvailabilitiesForResource(org.rhq.core.domain.auth.Subject subject,
                                                    int resourceId,
                                                    long fullRangeBeginTime,
                                                    long fullRangeEndTime,
                                                    int numberOfPoints,
                                                    boolean withCurrentAvailability)

Description copied from interface: AvailabilityManagerLocal

Get the individual availability data points for the given resource.

Specified by:

findAvailabilitiesForResource in interface AvailabilityManagerLocal

resourceId - PK of the resource wanted

fullRangeBeginTime - start time for data we are interested in

fullRangeEndTime - end time for data we are interested in

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

public List<AvailabilityPoint> findAvailabilitiesForResourceGroup(org.rhq.core.domain.auth.Subject subject,
                                                         int groupId,
                                                         long fullRangeBeginTime,
                                                         long fullRangeEndTime,
                                                         int numberOfPoints,
                                                         boolean withCurrentAvailability)

Description copied from interface: AvailabilityManagerLocal

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

Specified by:

findAvailabilitiesForResourceGroup in interface AvailabilityManagerLocal

groupId - PK of the resource group wanted

fullRangeBeginTime - start time for data we are interested in

fullRangeEndTime - end time for data we are interested in

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

public List<AvailabilityPoint> findAvailabilitiesForAutoGroup(org.rhq.core.domain.auth.Subject subject,
                                                     int parentResourceId,
                                                     int resourceTypeId,
                                                     long fullRangeBeginTime,
                                                     long fullRangeEndTime,
                                                     int numberOfPoints,
                                                     boolean withCurrentAvailability)

Description copied from interface: AvailabilityManagerLocal

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

Specified by:

findAvailabilitiesForAutoGroup in interface AvailabilityManagerLocal

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

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

fullRangeBeginTime - start time for data we are interested in

fullRangeEndTime - end time for data we are interested in

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

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

Description copied from interface: AvailabilityManagerLocal

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.

Specified by:

setResourceAvailabilities in interface AvailabilityManagerLocal

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

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

Description copied from interface: AvailabilityManagerLocal

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

Specified by:

mergeAvailabilityReport in interface AvailabilityManagerLocal

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

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

Description copied from interface: AvailabilityManagerLocal

Internal use only. Used only for transactional processing purposes.

Specified by:

mergeAvailabilitiesInNewTransaction in interface AvailabilityManagerLocal

updateLastAvailabilityReportInNewTransaction

public void updateLastAvailabilityReportInNewTransaction(int agentId)

Description copied from interface: AvailabilityManagerLocal

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.

Specified by:

updateLastAvailabilityReportInNewTransaction in interface AvailabilityManagerLocal

Parameters:

agentId - the id of the agent

updateAgentResourceAvailabilities

public void updateAgentResourceAvailabilities(int agentId,
                                     org.rhq.core.domain.measurement.AvailabilityType platformAvailType,
                                     org.rhq.core.domain.measurement.AvailabilityType childAvailType)

Description copied from interface: AvailabilityManagerLocal

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

Specified by:

updateAgentResourceAvailabilities in interface AvailabilityManagerLocal

Parameters:

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

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

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

findAvailabilityWithinInterval

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

Deprecated.

Find all availability records for a given Resource that match the given interval [startDate, endDate]. The returned objects will probably cover a larger interval than the required one.

Specified by:

findAvailabilityWithinInterval in interface AvailabilityManagerLocal

Parameters:

resourceId - identifies the resource for which we want the values

startDate - start date of the desired interval

endDate - end date of the desired interval

Returns:

A list of availabilities that cover at least the given date range

findAvailabilityByCriteria

public org.rhq.core.domain.util.PageList<org.rhq.core.domain.measurement.Availability> findAvailabilityByCriteria(org.rhq.core.domain.auth.Subject subject,
                                                                                                         org.rhq.core.domain.criteria.AvailabilityCriteria criteria)

Specified by:

findAvailabilityByCriteria in interface AvailabilityManagerRemote

Returns:

not null

findAvailabilityForResource

@Deprecated
public org.rhq.core.domain.util.PageList<org.rhq.core.domain.measurement.Availability> findAvailabilityForResource(org.rhq.core.domain.auth.Subject subject,
                                                                                                                     int resourceId,
                                                                                                                     org.rhq.core.domain.util.PageControl pageControl)

Deprecated.

Specified by:

findAvailabilityForResource in interface AvailabilityManagerRemote

Parameters:

subject - the subject

resourceId - the resource

pageControl - page control

Returns:

not null

scheduleAvailabilityDurationCheck

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

Description copied from interface: AvailabilityManagerLocal

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

Specified by:

scheduleAvailabilityDurationCheck in interface AvailabilityManagerLocal

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

handleAvailabilityDurationCheck

public void handleAvailabilityDurationCheck(javax.ejb.Timer timer)