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-2015 ForgeRock AS
026 */
027package org.opends.server.extensions;
028
029
030
031import java.util.List;
032
033import org.forgerock.i18n.LocalizableMessageBuilder;
034import org.opends.server.types.AccountStatusNotification;
035import org.opends.server.types.Attribute;
036import org.opends.server.types.AttributeType;
037import org.forgerock.opendj.ldap.ByteString;
038import org.opends.server.types.Entry;
039
040
041
042/**
043 * This class implements a notification message template element that will
044 * generate a value that is the value of a specified attribute from the target
045 * user's entry.
046 */
047public class UserAttributeNotificationMessageTemplateElement
048       extends NotificationMessageTemplateElement
049{
050  /** The attribute type for which to obtain the value. */
051  private AttributeType attributeType;
052
053
054
055  /**
056   * Creates a new user DN notification message template element.
057   *
058   * @param  attributeType  The attribute type for which to obtain the value.
059   */
060  public UserAttributeNotificationMessageTemplateElement(AttributeType
061                                                              attributeType)
062  {
063    this.attributeType = attributeType;
064  }
065
066
067
068  /** {@inheritDoc} */
069  public void generateValue(LocalizableMessageBuilder buffer,
070                            AccountStatusNotification notification)
071  {
072    Entry userEntry = notification.getUserEntry();
073
074    List<Attribute> attrList = userEntry.getAttribute(attributeType);
075    if (attrList != null)
076    {
077      for (Attribute a : attrList)
078      {
079        for (ByteString v : a)
080        {
081          buffer.append(v);
082          return;
083        }
084      }
085    }
086  }
087}
088