edu.vt.middleware.ldap.auth.DnResolver 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: DnResolver.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.auth;

import javax.naming.NamingException;

/**
 * DnResolver provides an interface for finding LDAP DNs.
 *
 * @author  Middleware Services
 * @version  $Revision: 1330 $ $Date: 2010-05-23 18:10:53 -0400 (Sun, 23 May 2010) $
 */
public interface DnResolver
{

  /**
   * Attempts to find the LDAP DN for the supplied user.
   *
   * @param  user  String to find dn for
   *
   * @return  String - user's dn
   *
   * @throws  NamingException  if an LDAP error occurs
   */
  String resolve(String user)
    throws NamingException;


  /**
   * Returns the authenticator config.
   *
   * @return  authenticator configuration
   */
  AuthenticatorConfig getAuthenticatorConfig();


  /**
   * Sets the authenticator config.
   *
   * @param  config  authenticator configuration
   */
  void setAuthenticatorConfig(AuthenticatorConfig config);


  /** This will close any resources associated with this resolver. */
  void close();
}