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     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
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     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  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 2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.extensions;
028    
029    
030    
031    import org.opends.messages.MessageBuilder;
032    import 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     */
040    public 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(MessageBuilder buffer,
052                                         AccountStatusNotification notification);
053    }
054