All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • edu.vt.middleware.ldap.bean.AbstractLdapAttribute Maven / Gradle / Ivy

    There is a newer version: 3.3.9
    Show newest version
    /*
  $Id: AbstractLdapAttribute.java 1330 2010-05-23 22:10:53Z dfisher $

  Copyright (C) 2003-2010 Virginia Tech.
  All rights reserved.

  SEE LICENSE FOR MORE INFORMATION

  Author:  Middleware Services
  Email:   [email protected]
  Version: $Revision: 1330 $
  Updated: $Date: 2010-05-23 18:10:53 -0400 (Sun, 23 May 2010) $
*/
package edu.vt.middleware.ldap.bean;

import java.util.Set;
import javax.naming.NamingEnumeration;
import javax.naming.NamingException;
import javax.naming.directory.Attribute;
import javax.naming.directory.BasicAttribute;
import edu.vt.middleware.ldap.LdapUtil;

/**
 * AbstractLdapAttribute provides a base implementation of 
 * LdapAttribute where the underlying values are backed by a 
 * Set.
 *
 * @param    type of backing set
 *
 * @author  Middleware Services
 * @version  $Revision: 1330 $ $Date: 2010-05-23 18:10:53 -0400 (Sun, 23 May 2010) $
 */
public abstract class AbstractLdapAttribute>
  extends AbstractLdapBean implements LdapAttribute
{

  /** hash code seed. */
  protected static final int HASH_CODE_SEED = 41;

  /** Name for this attribute. */
  protected String name;

  /** Values for this attribute. */
  protected Set values;


  /**
   * Creates a new AbstractLdapAttribute with the supplied ldap
   * bean factory.
   *
   * @param  lbf  LdapBeanFactory
   */
  public AbstractLdapAttribute(final LdapBeanFactory lbf)
  {
    super(lbf);
  }


  /** {@inheritDoc} */
  public String getName()
  {
    return this.name;
  }


  /** {@inheritDoc} */
  public Set getValues()
  {
    return this.values;
  }


  /** {@inheritDoc} */
  public abstract Set getStringValues();


  /** {@inheritDoc} */
  public void setAttribute(final Attribute attribute)
    throws NamingException
  {
    this.setName(attribute.getID());

    final NamingEnumeration ne = attribute.getAll();
    while (ne.hasMore()) {
      this.values.add(ne.next());
    }
  }


  /** {@inheritDoc} */
  public void setName(final String name)
  {
    this.name = name;
  }


  /** {@inheritDoc} */
  public int hashCode()
  {
    int hc = HASH_CODE_SEED;
    if (this.name != null) {
      hc += this.name.hashCode();
    }
    for (String s : this.getStringValues()) {
      if (s != null) {
        hc += s.hashCode();
      }
    }
    return hc;
  }


  /**
   * This returns a string representation of this object.
   *
   * @return  String
   */
  @Override
  public String toString()
  {
    return String.format("%s%s", this.name, this.values);
  }


  /** {@inheritDoc} */
  public Attribute toAttribute()
  {
    final Attribute attribute = new BasicAttribute(this.name);
    for (Object o : this.values) {
      attribute.add(o);
    }
    return attribute;
  }


  /**
   * Converts the underlying set of objects to a set of strings. Objects of type
   * byte[] are base64 encoded. Objects which are not of type String or byte[]
   * are converted using Object.toString().
   *
   * @param  stringValues  Set to populate with strings
   */
  protected void convertValuesToString(final Set stringValues)
  {
    for (Object o : this.values) {
      if (o != null) {
        if (o instanceof String) {
          stringValues.add((String) o);
        } else if (o instanceof byte[]) {
          final String encodedValue = LdapUtil.base64Encode((byte[]) o);
          if (encodedValue != null) {
            stringValues.add(encodedValue);
          }
        } else {
          stringValues.add(o.toString());
        }
      }
    }
  }
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy