server/extensions/TestAlertGenerator.java

5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL/*
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL * CDDL HEADER START
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL *
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL * The contents of this file are subject to the terms of the
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL * Common Development and Distribution License, Version 1.0 only
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL * (the "License").  You may not use this file except in compliance
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL * with the License.
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL *
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL * or http://forgerock.org/license/CDDLv1.0.html.
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL * See the License for the specific language governing permissions
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL * and limitations under the License.
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL *
ce2e2c2c7126b18ccfce0fe69a3bfa2eafea68b7Quentin CASTEL * When distributing Covered Code, include this CDDL HEADER in each
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL * file and include the License file at legal-notices/CDDLv1_0.txt.
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL * If applicable, add the following below this CDDL HEADER, with the
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL * fields enclosed by brackets "[]" replaced with your own identifying
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL * information:
10165d7e4cd84a62ad539bbc21526ff549137fc1Quentin CASTEL *      Portions Copyright [yyyy] [name of copyright owner]
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL *
10165d7e4cd84a62ad539bbc21526ff549137fc1Quentin CASTEL * CDDL HEADER END
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL *
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL *
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL *      Copyright 2006-2008 Sun Microsystems, Inc.
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL */
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTELpackage org.opends.server.extensions;
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTELimport java.util.LinkedHashMap;
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTELimport org.opends.server.api.AlertGenerator;
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTELimport org.opends.server.types.DN;
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL/**
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL * This class defines a simple alert generator that may be used for testing
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL * purposes.
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL */
ce2e2c2c7126b18ccfce0fe69a3bfa2eafea68b7Quentin CASTELpublic class TestAlertGenerator
ce2e2c2c7126b18ccfce0fe69a3bfa2eafea68b7Quentin CASTEL       implements AlertGenerator
ce2e2c2c7126b18ccfce0fe69a3bfa2eafea68b7Quentin CASTEL{
ce2e2c2c7126b18ccfce0fe69a3bfa2eafea68b7Quentin CASTEL  /**
ce2e2c2c7126b18ccfce0fe69a3bfa2eafea68b7Quentin CASTEL   * The fully-qualified name of this class for debugging purposes.
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL   */
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL  private static final String CLASS_NAME =
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL       "org.opends.server.extensions.TestAlertGenerator";
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL
ce2e2c2c7126b18ccfce0fe69a3bfa2eafea68b7Quentin CASTEL
10165d7e4cd84a62ad539bbc21526ff549137fc1Quentin CASTEL
10165d7e4cd84a62ad539bbc21526ff549137fc1Quentin CASTEL  // The DN of the "configuration entry" for this alert generator.
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL  private DN configEntryDN;
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL  // The alert description used for testing purposes.
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL  private String alertDescription;
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL  // The alert type used for testing purposes.
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL  private String alertType;
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL  /**
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL   * Creates a new instance of this test alert generator.
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL   *
ce2e2c2c7126b18ccfce0fe69a3bfa2eafea68b7Quentin CASTEL   * @throws  Exception  if an unexpected problem occurs.
ce2e2c2c7126b18ccfce0fe69a3bfa2eafea68b7Quentin CASTEL   */
ce2e2c2c7126b18ccfce0fe69a3bfa2eafea68b7Quentin CASTEL  public TestAlertGenerator()
ce2e2c2c7126b18ccfce0fe69a3bfa2eafea68b7Quentin CASTEL         throws Exception
ce2e2c2c7126b18ccfce0fe69a3bfa2eafea68b7Quentin CASTEL  {
ce2e2c2c7126b18ccfce0fe69a3bfa2eafea68b7Quentin CASTEL    configEntryDN    = DN.decode("cn=Test Alert Generator,cn=config");
ce2e2c2c7126b18ccfce0fe69a3bfa2eafea68b7Quentin CASTEL    alertType        = "org.opends.server.TestAlert";
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL    alertDescription = "This is a test alert.";
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL  }
ce2e2c2c7126b18ccfce0fe69a3bfa2eafea68b7Quentin CASTEL
ce2e2c2c7126b18ccfce0fe69a3bfa2eafea68b7Quentin CASTEL
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL
ce2e2c2c7126b18ccfce0fe69a3bfa2eafea68b7Quentin CASTEL  /**
ce2e2c2c7126b18ccfce0fe69a3bfa2eafea68b7Quentin CASTEL   * Retrieves the alert type for this test alert generator.
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL   *
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL   * @return  The alert type for this test alert generator.
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL   */
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL  public String getAlertType()
5e89746cb5bec21d15a044ce89cfcdbf99d3d49dQuentin CASTEL  {
    return alertType;
  }


  /**
   * {@inheritDoc}
   */
  public DN getComponentEntryDN()
  {
    return configEntryDN;
  }


  /**
   * {@inheritDoc}
   */
  public String getClassName()
  {
    return CLASS_NAME;
  }


  /**
   * {@inheritDoc}
   */
  public LinkedHashMap<String,String> getAlerts()
  {
    LinkedHashMap<String,String> alerts = new LinkedHashMap<String,String>();

    alerts.put(alertType, alertDescription);

    return alerts;
  }
}