001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2008 Sun Microsystems, Inc.
015 * Portions Copyright 2014 ForgeRock AS.
016 */
017package org.opends.server.extensions;
018
019
020
021import org.forgerock.i18n.LocalizableMessageBuilder;
022import org.opends.server.types.AccountStatusNotification;
023
024
025
026/**
027 * This class defines the base class for elements that may be used to generate
028 * an account status notification message.
029 */
030public abstract class NotificationMessageTemplateElement
031{
032  /**
033   * Generates a value for this template element using the information contained
034   * in the provided account status notification and appends it to the given
035   * buffer.
036   *
037   * @param  buffer        The buffer to which the generated value should be
038   *                       appended.
039   * @param  notification  The account status notification to process.
040   */
041  public abstract void generateValue(LocalizableMessageBuilder buffer,
042                                     AccountStatusNotification notification);
043}
044