edu.vt.middleware.ldap.bean.AbstractLdapEntry Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vt-ldap Show documentation

Library for performing common LDAP operations

There is a newer version: 3.3.9

/*
  $Id: AbstractLdapEntry.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 javax.naming.NamingException;
import javax.naming.directory.SearchResult;

/**
 * AbstractLdapEntry provides a base implementation of 
 * LdapEntry.
 *
 * @author  Middleware Services
 * @version  $Revision: 1330 $ $Date: 2010-05-23 18:10:53 -0400 (Sun, 23 May 2010) $
 */
public abstract class AbstractLdapEntry extends AbstractLdapBean
  implements LdapEntry
{

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

  /** Distinguished name for this entry. */
  protected String dn;

  /** Attributes contained in this entry. */
  protected LdapAttributes ldapAttributes;


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


  /** {@inheritDoc} */
  public String getDn()
  {
    return this.dn;
  }


  /** {@inheritDoc} */
  public LdapAttributes getLdapAttributes()
  {
    return this.ldapAttributes;
  }


  /** {@inheritDoc} */
  public void setEntry(final SearchResult sr)
    throws NamingException
  {
    this.setDn(sr.getName());

    final LdapAttributes la = this.beanFactory.newLdapAttributes();
    la.addAttributes(sr.getAttributes());
    this.setLdapAttributes(la);
  }


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


  /** {@inheritDoc} */
  public void setLdapAttributes(final LdapAttributes a)
  {
    if (a != null) {
      this.ldapAttributes = a;
    }
  }


  /** {@inheritDoc} */
  public int hashCode()
  {
    int hc = HASH_CODE_SEED;
    if (this.getDn() != null) {
      hc += this.getDn().hashCode();
    }
    hc += this.getLdapAttributes().hashCode();
    return hc;
  }


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


  /** {@inheritDoc} */
  public SearchResult toSearchResult()
  {
    return new SearchResult(this.dn, null, this.ldapAttributes.toAttributes());
  }
}