org.apache.ambari.server.state.alert

Class AlertDefinitionFactory

java.lang.Object

org.apache.ambari.server.state.alert.AlertDefinitionFactory

public class AlertDefinitionFactory
extends Object

The AlertDefinitionFactory class is used to construct AlertDefinition instances from a variety of sources.

Constructor Summary

Constructors

Constructor and Description
AlertDefinitionFactory() Constructor.

Method Summary

Modifier and Type	Method and Description
AlertDefinition	coerce(AlertDefinitionEntity entity) Gets an AlertDefinition constructed from the specified AlertDefinitionEntity.
AlertDefinitionEntity	coerce(long clusterId, AlertDefinition definition) Gets an AlertDefinitionEntity constructed from the specified AlertDefinition.
Set<AlertDefinition>	getAlertDefinitions(File alertDefinitionFile, String serviceName) Gets a list of all of the alert definitions defined in the specified JSON File for the given service.
Set<AlertDefinition>	getAlertDefinitions(Reader reader, String serviceName) Gets a list of all of the alert definitions defined in the resource pointed to by the specified reader for the given service.
com.google.gson.Gson	getGson() Gets an instance of Gson that can correctly serialize and deserialize an AlertDefinition.
AlertDefinitionEntity	merge(AlertDefinition definition, AlertDefinitionEntity entity) Merges the specified AlertDefinition into the AlertDefinitionEntity, leaving any fields not merged intact.
AlertDefinitionEntity	mergeSource(Source source, AlertDefinitionEntity entity) Updates source and source type of entity from source.

Methods inherited from class java.lang.Object

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

Constructor Detail

AlertDefinitionFactory

public AlertDefinitionFactory()

Constructor.

Method Detail

getAlertDefinitions

public Set<AlertDefinition> getAlertDefinitions(File alertDefinitionFile,
                                                String serviceName)
                                         throws org.apache.ambari.server.AmbariException

Gets a list of all of the alert definitions defined in the specified JSON File for the given service. Each of the JSON files should have a mapping between the service and the alerts defined for that service. This is necessary since some services are combined in a single metainfo.xml and only have a single directory on the stack.

Parameters:

alertDefinitionFile - the JSON file from the stack to read (not null).

serviceName - the name of the service to extract definitions for (not null).

Returns:

the definitions for the specified service, or an empty set.

Throws:

org.apache.ambari.server.AmbariException - if there was a problem reading the file or parsing the JSON.

getAlertDefinitions

public Set<AlertDefinition> getAlertDefinitions(Reader reader,
                                                String serviceName)
                                         throws org.apache.ambari.server.AmbariException

Gets a list of all of the alert definitions defined in the resource pointed to by the specified reader for the given service. There should have a mapping between the service and the alerts defined for that service. This is necessary since some services are combined in a single metainfo.xml and only have a single directory on the stack.

The supplied reader is closed when this method completes.

Parameters:

reader - the reader to read from (not null). This will be closed after reading is done.

serviceName - the name of the service to extract definitions for (not null).

Returns:

the definitions for the specified service, or an empty set.

Throws:

org.apache.ambari.server.AmbariException - if there was a problem reading or parsing the JSON.

coerce

public AlertDefinition coerce(AlertDefinitionEntity entity)

Gets an AlertDefinition constructed from the specified AlertDefinitionEntity.

Parameters:

entity - the entity to use to construct the AlertDefinition (not null).

Returns:

the definiion or null if it could not be coerced.

coerce

public AlertDefinitionEntity coerce(long clusterId,
                                    AlertDefinition definition)

Gets an AlertDefinitionEntity constructed from the specified AlertDefinition.

The new entity will have a UUID already set.

Parameters:

clusterId - the ID of the cluster.

definition - the definition to use to construct the AlertDefinitionEntity (not null).

Returns:

the definiion or null if it could not be coerced.

merge

public AlertDefinitionEntity merge(AlertDefinition definition,
                                   AlertDefinitionEntity entity)

Merges the specified AlertDefinition into the AlertDefinitionEntity, leaving any fields not merged intact.

The merged entity will have a new UUID.

Parameters:

definition - the definition to merge into the entity (not null).

entity - the entity to merge into (not null).

Returns:

a merged, but not yes persisted entity, or null if the merge could not be done.

mergeSource

public AlertDefinitionEntity mergeSource(Source source,
                                         AlertDefinitionEntity entity)

Updates source and source type of entity from source. Also updates UUID, which must be done for any change in to the entity for it to take effect on the agents.

Returns:

the updated entity to be persisted, or null if alert source cannot be serialized to JSON

getGson

public com.google.gson.Gson getGson()

Gets an instance of Gson that can correctly serialize and deserialize an AlertDefinition.

Returns:

a Gson instance (not null).