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 legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2008 Sun Microsystems, Inc.
025 *      Portions Copyright 2014 ForgeRock AS
026 */
027package org.opends.server.extensions;
028
029
030
031import org.forgerock.i18n.LocalizableMessageBuilder;
032import org.opends.server.types.AccountStatusNotification;
033
034
035
036/**
037 * This class defines the base class for elements that may be used to generate
038 * an account status notification message.
039 */
040public abstract class NotificationMessageTemplateElement
041{
042  /**
043   * Generates a value for this template element using the information contained
044   * in the provided account status notification and appends it to the given
045   * buffer.
046   *
047   * @param  buffer        The buffer to which the generated value should be
048   *                       appended.
049   * @param  notification  The account status notification to process.
050   */
051  public abstract void generateValue(LocalizableMessageBuilder buffer,
052                                     AccountStatusNotification notification);
053}
054