com.connio.sdk.resource.alert.Alert.java Source code

Java tutorial

Introduction

Here is the source code for com.connio.sdk.resource.alert.Alert.java

Source

/**
 * Copyright (c) 2016 Connio Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Authors: juan@connio.com
 *
 */

package com.connio.sdk.resource.alert;

import com.connio.sdk.request.alert.AlertCreateRequest;
import com.connio.sdk.request.alert.AlertDeleteRequest;
import com.connio.sdk.request.alert.AlertUpdateRequest;
import com.connio.sdk.resource.Resource;
import com.connio.sdk.resource.device.Device;
import com.connio.sdk.resource.deviceprofile.DeviceProfile;
import com.fasterxml.jackson.annotation.*;
import com.google.common.base.MoreObjects;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import org.apache.commons.lang3.text.WordUtils;
import org.joda.time.DateTime;

import java.util.Objects;
import java.util.Optional;

/**
 * Alert resource
 */
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonIgnoreProperties(ignoreUnknown = true)
public class Alert extends Resource<AlertUpdateRequest, AlertDeleteRequest> {

    public enum Status {
        On, Off;

        @JsonValue
        public String value() {
            return name().toLowerCase();
        }

        @JsonCreator
        public static Status fromValue(@JsonProperty("name") final String name) {
            return Status.valueOf(WordUtils.capitalize(name.toLowerCase()));
        }
    }

    public enum Severity {
        Critical, Warning;

        @JsonValue
        public String value() {
            return name().toLowerCase();
        }

        @JsonCreator
        public static Status fromValue(@JsonProperty("name") final String name) {
            return Status.valueOf(WordUtils.capitalize(name.toLowerCase()));
        }
    }

    private final String id;

    private final String name;

    private final String accountId;

    private final String triggerPropId;

    private final String description;

    private final String ownerId;

    private final ImmutableSet<String> tags;

    private final Status status;

    private final String metric;

    private final ImmutableList<AlertCheck> checks;

    private final AlertHandler recover;

    private final ImmutableList<Notification> notifications;

    private final DateTime dateCreated;

    private final DateTime dateModified;

    public Alert(@JsonProperty("id") final String id, @JsonProperty("name") final String name,
            @JsonProperty("accountId") final String accountId,
            @JsonProperty("triggerPropId") final String triggerPropId,
            @JsonProperty("ownerId") final String ownerId, @JsonProperty("description") final String description,
            @JsonProperty("tags") final ImmutableSet<String> tags, @JsonProperty("status") final Status status,
            @JsonProperty("metric") final String metric,
            @JsonProperty("checks") final ImmutableList<AlertCheck> checks,
            @JsonProperty("recover") final AlertHandler recover,
            @JsonProperty("notifications") final ImmutableList<Notification> notifications,
            @JsonProperty("dateCreated") final DateTime dateCreated,
            @JsonProperty("dateModified") final DateTime dateModified) {

        this.id = id;
        this.name = name;
        this.accountId = accountId;
        this.triggerPropId = triggerPropId;
        this.description = description;
        this.ownerId = ownerId;
        this.tags = tags != null ? tags : ImmutableSet.<String>of();
        this.status = status;
        this.metric = metric;
        this.checks = checks;
        this.notifications = notifications;
        this.recover = recover;
        this.dateCreated = dateCreated;
        this.dateModified = dateModified;
    }

    public String getId() {
        return id;
    }

    public String getName() {
        return name;
    }

    public String getAccountId() {
        return accountId;
    }

    public String getTriggerPropId() {
        return triggerPropId;
    }

    public Optional<String> getDescription() {
        return Optional.ofNullable(description);
    }

    public String getOwnerId() {
        return ownerId;
    }

    public ImmutableSet<String> getTags() {
        return tags;
    }

    public Status getStatus() {
        return status;
    }

    public String getMetric() {
        return metric;
    }

    public ImmutableList<AlertCheck> getChecks() {
        return checks;
    }

    public Optional<AlertHandler> getRecover() {
        return Optional.ofNullable(recover);
    }

    public ImmutableList<Notification> getNotifications() {
        return notifications;
    }

    public DateTime getDateCreated() {
        return dateCreated;
    }

    public Optional<DateTime> getDateModified() {
        return Optional.ofNullable(dateModified);
    }

    /**
     * Creates and initialises a AlertCreateRequest with minimum data to create a new alert. Note that the returning
     * AlertCreateRequest can be completed with all desired information that the request permits before executing it.
     * @param deviceProfile that the alert will belong to.
     * @param name
     * @param triggerPropId
     * @param metric
     * @param checks
     * @param notifications
     * @return AlertCreateRequest.
     */
    public static AlertCreateRequest create(DeviceProfile deviceProfile, String name, String triggerPropId,
            String metric, ImmutableList<AlertCheck> checks, ImmutableList<Notification> notifications) {

        return new AlertCreateRequest(deviceProfile, name, triggerPropId, metric, checks, notifications);
    }

    /**
     * Creates and initialises a AlertCreateRequest with minimum data to create a new alert. Note that the returning
     * AlertCreateRequest can be completed with all desired information that the request permits before executing it.
     * @param device that the alert will belong to.
     * @param name
     * @param triggerPropId
     * @param metric
     * @param checks
     * @param notifications
     * @return AlertCreateRequest.
     */
    public static AlertCreateRequest create(Device device, String name, String triggerPropId, String metric,
            ImmutableList<AlertCheck> checks, ImmutableList<Notification> notifications) {

        return new AlertCreateRequest(device, name, triggerPropId, metric, checks, notifications);
    }

    /**
     * Return a AlertUpdateRequest for the current alert to be completed with the data that wants to be updated
     * before executing the request.
     * @return AlertUpdateRequest.
     */
    @Override
    public AlertUpdateRequest update() {
        return new AlertUpdateRequest(ownerId, id);
    }

    /**
     * Return a AlertDeleteRequest for the current alert in order to delete it when executing.
     * @return AlertDeleteRequest
     */
    @Override
    public AlertDeleteRequest delete() {
        return new AlertDeleteRequest(ownerId, id);
    }

    @Override
    public boolean equals(Object obj) {
        if (obj == null || getClass() != obj.getClass()) {
            return false;
        }
        if (this == obj) {
            return true;
        }
        Alert other = (Alert) obj;
        return Objects.equals(this.id, other.id);
    }

    @Override
    public int hashCode() {
        return Objects.hash(this.id);
    }

    @Override
    public String toString() {
        return MoreObjects.toStringHelper("Alert").add("id", id.toString()).add("name", name)
                .add("accountId", accountId).add("triggerPropId", triggerPropId).toString();
    }

}