001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at
010 * docs/licenses/cddl.txt
011 * or http://www.opensource.org/licenses/cddl1.php.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * docs/licenses/cddl.txt.  If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 *      Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 *      Copyright 2014-2021 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.common.types;
028
029
030
031/**
032 * This interface may be used to interact with an alert type that may cause the
033 * server to be classified as degraded.
034 */
035public interface DegradedAlertType
036{
037  /**
038   * Retrieves the alert type name for this degraded alert type.
039   *
040   * @return  The alert type name for this degraded alert type.
041   */
042  String getAlertTypeName();
043
044
045
046  /**
047   * Retrieves the OID for this degraded alert type.
048   *
049   * @return  The OID for this degraded alert type.
050   */
051  String getAlertTypeOID();
052
053
054
055  /**
056   * Retrieves the severity for this degraded alert type.
057   *
058   * @return  The severity for this degraded alert type.
059   */
060  AlertSeverity getAlertSeverity();
061
062
063
064  /**
065   * Indicates that the condition that triggered this degraded alert type has
066   * been resolved and should no longer cause the server to be considered
067   * degraded.
068   */
069  void setResolved();
070}