/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */
package org.apache.ambari.server.events;

import org.apache.ambari.server.orm.entities.AlertCurrentEntity;
import org.apache.ambari.server.orm.entities.AlertHistoryEntity;
import org.apache.ambari.server.state.Alert;
import org.apache.ambari.server.state.AlertFirmness;
import org.apache.ambari.server.state.AlertState;

/**
 * The {@link AlertStateChangeEvent} is fired when an {@link Alert} instance has
 * its {@link AlertState} changed or has it's {@link AlertFirmness} changed.
 * <p/>
 * An {@link AlertState} change coupled with a {@link AlertFirmness#HARD}
 * firmness is what would eventually trigger notifications to be created.
 */
public class AlertStateChangeEvent extends AlertEvent {

  /**
   * The prior alert state.
   */
  private final AlertState m_fromState;

  /**
   * The prior alert firmness.
   */
  private final AlertFirmness m_fromFirmness;

  /**
   * The current alert, including state and history.
   */
  private final AlertCurrentEntity m_currentAlert;

  /**
   * The historical record for this alert state change event.
   */
  private final AlertHistoryEntity m_history;

  /**
   * Constructor.
   *
   * @param clusterId
   * @param alert
   * @param currentAlert
   * @param fromState
   * @param fromFirmness
   */
  public AlertStateChangeEvent(long clusterId, Alert alert,
      AlertCurrentEntity currentAlert, AlertState fromState, AlertFirmness fromFirmness) {
    super(clusterId, alert);

    m_currentAlert = currentAlert;
    m_history = currentAlert.getAlertHistory();
    m_fromState = fromState;
    m_fromFirmness = fromFirmness;
  }

  /**
   * Gets the current alert.
   *
   * @return the current alert.
   */
  public AlertCurrentEntity getCurrentAlert() {
    return m_currentAlert;
  }

  /**
   * Gets the newly created item in alert history.
   *
   * @return the newly created historical item.
   */
  public AlertHistoryEntity getNewHistoricalEntry() {
    return m_history;
  }

  /**
   * Gets the prior state of the alert.
   *
   * @return the prior state of the alert.
   */
  public AlertState getFromState() {
    return m_fromState;
  }

  /**
   * Gets the prior firmness of the alert.
   *
   * @return the prior firmness of the alert.
   */
  public AlertFirmness getFromFirmness() {
    return m_fromFirmness;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public String toString() {
    StringBuilder buffer = new StringBuilder("AlertStateChangeEvent{");
    buffer.append("cluserId=").append(m_clusterId);
    buffer.append(", fromState=").append(m_fromState);
    buffer.append(", firmness=").append(m_currentAlert.getFirmness());
    buffer.append(", alert=").append(m_alert);

    buffer.append("}");
    return buffer.toString();
  }
}