Skip to content

Commit

Permalink
fix issues prior to release of 0.0.1
Browse files Browse the repository at this point in the history
- fix javadoc generation issues
- fix snapshot dependencies
  • Loading branch information
jshaughn committed May 22, 2015
1 parent 6415e31 commit e5334b9
Show file tree
Hide file tree
Showing 11 changed files with 25 additions and 29 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ public Dampening() {
* @param triggerId
* @param triggerMode the trigger mode for when this dampening is active
* @param numConsecutiveTrueEvals
* @return
* @return the configured Dampening
*/
public static Dampening forStrict(String triggerId, Mode triggerMode, int numConsecutiveTrueEvals) {
return new Dampening(triggerId, triggerMode, Type.STRICT, numConsecutiveTrueEvals, numConsecutiveTrueEvals, 0);
Expand All @@ -112,7 +112,7 @@ public static Dampening forStrict(String triggerId, Mode triggerMode, int numCon
* @param triggerMode the trigger mode for when this dampening is active
* @param numTrueEvals
* @param numTotalEvals
* @return
* @return the configured Dampening
*/
public static Dampening forRelaxedCount(String triggerId, Mode triggerMode, int numTrueEvals, int numTotalEvals) {
return new Dampening(triggerId, triggerMode, Type.RELAXED_COUNT, numTrueEvals, numTotalEvals, 0);
Expand All @@ -127,7 +127,7 @@ public static Dampening forRelaxedCount(String triggerId, Mode triggerMode, int
* @param numTrueEvals
* @param evalPeriod Elapsed real time, in milliseconds. In other words, this is not measured against
* collectionTimes (i.e. the timestamp on the data) but rather the evaluation times.
* @return
* @return the configured Dampening
*/
public static Dampening forRelaxedTime(String triggerId, Mode triggerMode, int numTrueEvals, long evalPeriod) {
return new Dampening(triggerId, triggerMode, Type.RELAXED_TIME, numTrueEvals, 0, evalPeriod);
Expand All @@ -141,7 +141,7 @@ public static Dampening forRelaxedTime(String triggerId, Mode triggerMode, int n
* @param triggerMode the trigger mode for when this dampening is active
* @param evalPeriod Elapsed real time, in milliseconds. In other words, this is not measured against
* collectionTimes (i.e. the timestamp on the data) but rather the evaluation times.
* @return
* @return the configured Dampening
*/
public static Dampening forStrictTime(String triggerId, Mode triggerMode, long evalPeriod) {
return new Dampening(triggerId, triggerMode, Type.STRICT_TIME, 0, 0, evalPeriod);
Expand All @@ -155,7 +155,7 @@ public static Dampening forStrictTime(String triggerId, Mode triggerMode, long e
* @param triggerMode the trigger mode for when this dampening is active
* @param evalPeriod Elapsed real time, in milliseconds. In other words, this is not measured against
* collectionTimes (i.e. the timestamp on the data) but rather the clock starts at true-evaluation-time-1.
* @return
* @return the configured Dampening
*/
public static Dampening forStrictTimeout(String triggerId, Mode triggerMode, long evalPeriod) {
return new Dampening(triggerId, triggerMode, Type.STRICT_TIMEOUT, 0, 0, evalPeriod);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public Availability() {
/**
* @param id
* @param timestamp
* @param value Must be a valid {@link #Availability.AvailabilityType} name.
* @param value Must be a valid {@link AvailabilityType} name.
*/
public Availability(String id, long timestamp, String value) {
super(id, timestamp, (null == value) ? AvailabilityType.UP : AvailabilityType.valueOf(value),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public Tag() {
/**
* Create a searchable Tag on name only
*
* @param tag @NotEmpty
* @param name @NotEmpty
*/
public Tag(String name) {
this(null, null, name, false);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,13 +108,13 @@ public void setTriggerId(String triggerId) {
this.triggerId = triggerId;
}

/**
* @param triggerId fetched Alerts must be for any of the specified triggers.
*/
public Collection<String> getTriggerIds() {
return triggerIds;
}

/**
* @param triggerIds fetched alerts must be for one of the specified triggers.
*/
public void setTriggerIds(Collection<String> triggerIds) {
this.triggerIds = triggerIds;
}
Expand All @@ -124,7 +124,7 @@ public Tag getTag() {
}

/**
* @param triggerId fetched Alerts must be for triggers with the specified Tag. Ignored if Tags is not empty.
* @param tag fetched Alerts must be for triggers with the specified Tag. Ignored if Tags filter is set.
*/
public void setTag(Tag tag) {
this.tag = tag;
Expand All @@ -135,7 +135,7 @@ public Collection<Tag> getTags() {
}

/**
* @param triggerId fetched Alerts must be for trigger with any of the specified Tags.
* @param tags fetched Alerts must be for trigger with any of the specified Tags.
*/
public void setTags(Collection<Tag> tags) {
this.tags = tags;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,28 +62,25 @@ public interface AlertsService {
/**
* Persist the provided alerts.
* @param alerts Set of unpersisted Alerts.
* @return
*/
void addAlerts(Collection<Alert> alerts) throws Exception;

/**
* The alerts must already have been added. Set the alerts to ACKNOWLEDGED status. The ackTime will be set to the
* system time.
* @param alerts Alerts to be acknowledged.
* @param alertIds Alerts to be acknowledged.
* @param ackBy Optional. Typically the user acknowledging the alerts.
* @param ackNotes Optional notes about the acknowledgement.
* @return
*/
void ackAlerts(Collection<String> alertIds, String ackBy, String ackNotes) throws Exception;

/**
* The alerts must already have been added. Set the alerts to RESOLVED status. The resolvedTime will be set to the
* system time.
* @param alerts Alerts to be acknowledged.
* @param alertIds AlertIds to be acknowledged.
* @param resolvedBy Optional. Typically the user resolving the alerts.
* @param resolvedNotes Optional notes about the resolution.
* @param resolvedEvalSets Optional. Typically the evalSets leading to an auto-resolved alert.
* @return
*/
void resolveAlerts(Collection<String> alertIds, String resolvedBy, String resolvedNotes,
List<Set<ConditionEval>> resolvedEvalSets) throws Exception;
Expand All @@ -95,7 +92,6 @@ void resolveAlerts(Collection<String> alertIds, String resolvedBy, String resolv
* @param resolvedBy Optional. Typically the user resolving the alerts.
* @param resolvedNotes Optional notes about the resolution.
* @param resolvedEvalSets Optional. Typically the evalSets leading to an auto-resolved alert.
* @return
*/
void resolveAlertsForTrigger(String triggerId, String resolvedBy, String resolvedNotes,
List<Set<ConditionEval>> resolvedEvalSets) throws Exception;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,17 @@
package org.hawkular.alerts.api.services;

/**
* A listener that will process a action sent to the ActionsService.
* A listener for reacting to definitions changes.
*
* @author Jay Shaughnessy
* @author Lucas Ponce
*/
public interface DefinitionsListener {

/**
* Process a action sent to {@link ActionListener}.
* Process a change event sent to {@link DefinitionsListener}.
*
* @param action Action to be processed.
* @param event event to be processed.
*/
void onChange(DefinitionsEvent event);
}
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public interface DefinitionsService {
* Update the <code>Trigger</code>. <code>Conditions</code> and <code>Actions</code> are manipulated in separate
* calls. The updated </code>Trigger</code> will be persisted. If enabled the </code>Trigger</code>
* will be [re-]inserted into the Alerts engine and any prior dampening will be reset.
* @param triggerId
* @param trigger
* @throws Exception If the </code>Trigger</code> does not exist.
*/
Trigger updateTrigger(Trigger trigger) throws Exception;
Expand All @@ -75,7 +75,7 @@ public interface DefinitionsService {
* Conditions with actual dataIds.
* @param triggerId
* @param dataIdMap
* @return
* @return The copy
* @throws Exception
*/
Trigger copyTrigger(String triggerId, Map<String, String> dataIdMap) throws Exception;
Expand Down
2 changes: 1 addition & 1 deletion hawkular-alerts-engine/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@
<configuration>
<groupId>org.hawkular.nest</groupId>
<artifactId>hawkular-nest-distro</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>${version.org.hawkular.nest}</version>
<classifier>distribution</classifier>
<skip>${skipTests}</skip>
<port>${wildfly.management.port}</port>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public interface RulesEngine {
/**
* Insert the provided <code>fact</code> into the rules engine. This method is not appropriate for
* <code>Data</code>. For <code>Data</code> use {@link #addData(Data)}.
* @param facts
* @param fact
* @throws IllegalArgumentExeption If <code>fact</code> instanceof <code>Data</code>.
*/
void addFact(Object fact);
Expand Down
2 changes: 1 addition & 1 deletion hawkular-alerts-rest-tests/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@
<configuration>
<groupId>org.hawkular.nest</groupId>
<artifactId>hawkular-nest-distro</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>${version.org.hawkular.nest}</version>
<classifier>distribution</classifier>
<skip>${skipTests}</skip>
<port>${wildfly.management.port}</port>
Expand Down
6 changes: 3 additions & 3 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,11 @@

<modules>
<module>hawkular-alerts-api</module>
<module>hawkular-actions-api</module>
<module>hawkular-alerts-engine</module>
<module>hawkular-alerts-bus</module>
<module>hawkular-alerts-rest</module>
<module>hawkular-alerts-ear</module>
<module>hawkular-actions-api</module>
<module>hawkular-actions-plugins</module>
<module>hawkular-alerts-rest-tests</module>
</modules>
Expand Down Expand Up @@ -97,9 +97,9 @@
<version.org.codehaus.groovy.maven>1.0</version.org.codehaus.groovy.maven>
<version.org.codehaus.groovy.modules.http-builder>0.7</version.org.codehaus.groovy.modules.http-builder>
<version.org.drools>6.1.0.Final</version.org.drools>
<version.org.hawkular.bus>1.0.0-SNAPSHOT</version.org.hawkular.bus>
<version.org.hawkular.bus>0.0.5</version.org.hawkular.bus>
<version.org.hawkular.nest>0.0.5</version.org.hawkular.nest>
<version.org.hawkular.metrics>0.3.3</version.org.hawkular.metrics>
<version.org.hawkular.nest>1.0.0-SNAPSHOT</version.org.hawkular.nest>
<version.org.rhq.helpers>4.11.0</version.org.rhq.helpers>
<version.org.slf4j>1.7.2</version.org.slf4j>
<version.org.wildfly>8.2.0.Final</version.org.wildfly>
Expand Down

0 comments on commit e5334b9

Please sign in to comment.