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-2016 ForgeRock AS.
016 */
017package org.opends.server.extensions;
018
019import org.forgerock.i18n.LocalizableMessageBuilder;
020import org.forgerock.opendj.ldap.ByteString;
021import org.forgerock.opendj.ldap.schema.AttributeType;
022import org.opends.server.types.AccountStatusNotification;
023import org.opends.server.types.Attribute;
024import org.opends.server.types.Entry;
025
026/**
027 * This class implements a notification message template element that will
028 * generate a value that is the value of a specified attribute from the target
029 * user's entry.
030 */
031public class UserAttributeNotificationMessageTemplateElement
032       extends NotificationMessageTemplateElement
033{
034  /** The attribute type for which to obtain the value. */
035  private AttributeType attributeType;
036
037  /**
038   * Creates a new user DN notification message template element.
039   *
040   * @param  attributeType  The attribute type for which to obtain the value.
041   */
042  public UserAttributeNotificationMessageTemplateElement(AttributeType attributeType)
043  {
044    this.attributeType = attributeType;
045  }
046
047  @Override
048  public void generateValue(LocalizableMessageBuilder buffer,
049                            AccountStatusNotification notification)
050  {
051    Entry userEntry = notification.getUserEntry();
052    for (Attribute a : userEntry.getAttribute(attributeType))
053    {
054      for (ByteString v : a)
055      {
056        buffer.append(v);
057        return;
058      }
059    }
060  }
061}