edu.vt.middleware.ldap.pool.AbstractLdapFactory Maven / Gradle / Ivy

Go to download
/*
  $Id: AbstractLdapFactory.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.pool;

import edu.vt.middleware.ldap.BaseLdap;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * AbstractLdapFactory provides a basic implementation of an ldap
 * factory.
 *
 * @param    type of ldap object
 *
 * @author  Middleware Services
 * @version  $Revision: 1330 $ $Date: 2010-05-23 18:10:53 -0400 (Sun, 23 May 2010) $
 */
public abstract class AbstractLdapFactory
  implements LdapFactory
{

  /** Log for this class. */
  protected final Log logger = LogFactory.getLog(this.getClass());

  /** For activating ldap objects. */
  protected LdapActivator activator;

  /** For passivating ldap objects. */
  protected LdapPassivator passivator;

  /** For validating ldap objects. */
  protected LdapValidator validator;


  /**
   * Sets the ldap activator for this factory.
   *
   * @param  la  ldap activator
   */
  public void setLdapActivator(final LdapActivator la)
  {
    this.activator = la;
  }


  /**
   * Returns the ldap activator for this factory.
   *
   * @return  ldap activator
   */
  public LdapActivator getLdapActivator()
  {
    return this.activator;
  }


  /**
   * Sets the ldap passivator for this factory.
   *
   * @param  lp  ldap passivator
   */
  public void setLdapPassivator(final LdapPassivator lp)
  {
    this.passivator = lp;
  }


  /**
   * Returns the ldap passivator for this factory.
   *
   * @return  ldap passivator
   */
  public LdapPassivator getLdapPassivator()
  {
    return this.passivator;
  }


  /**
   * Sets the ldap validator for this factory.
   *
   * @param  lv  ldap validator
   */
  public void setLdapValidator(final LdapValidator lv)
  {
    this.validator = lv;
  }


  /**
   * Returns the ldap validator for this factory.
   *
   * @return  ldap validator
   */
  public LdapValidator getLdapValidator()
  {
    return this.validator;
  }


  /** {@inheritDoc} */
  public abstract T create();


  /** {@inheritDoc} */
  public abstract void destroy(final T t);


  /** {@inheritDoc} */
  public boolean activate(final T t)
  {
    boolean success = false;
    if (this.activator == null) {
      success = true;
      if (this.logger.isTraceEnabled()) {
        this.logger.trace("no activator configured");
      }
    } else {
      success = this.activator.activate(t);
      if (this.logger.isTraceEnabled()) {
        this.logger.trace("activation for " + t + " = " + success);
      }
    }
    return success;
  }


  /** {@inheritDoc} */
  public boolean passivate(final T t)
  {
    boolean success = false;
    if (this.passivator == null) {
      success = true;
      if (this.logger.isTraceEnabled()) {
        this.logger.trace("no passivator configured");
      }
    } else {
      success = this.passivator.passivate(t);
      if (this.logger.isTraceEnabled()) {
        this.logger.trace("passivation for " + t + " = " + success);
      }
    }
    return success;
  }


  /** {@inheritDoc} */
  public boolean validate(final T t)
  {
    boolean success = false;
    if (this.validator == null) {
      success = true;
      if (this.logger.isWarnEnabled()) {
        this.logger.warn("validate called, but no validator configured");
      }
    } else {
      success = this.validator.validate(t);
      if (this.logger.isTraceEnabled()) {
        this.logger.trace("validation for " + t + " = " + success);
      }
    }
    return success;
  }
}