edu.vt.middleware.ldap.props.PropertyConfig 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: PropertyConfig.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.props;

import java.util.Hashtable;
import java.util.Properties;

/**
 * PropertyConfig provides an interface for objects that can be
 * configured with a PropertyInvoker.
 *
 * @author  Middleware Services
 * @version  $Revision: 1330 $ $Date: 2010-05-23 18:10:53 -0400 (Sun, 23 May 2010) $
 */
public interface PropertyConfig
{


  /**
   * This returns the properties domain for this property config.
   *
   * @return  String properties domain
   */
  String getPropertiesDomain();


  /**
   * This returns whether the supplied property exists.
   *
   * @param  name  String to check
   *
   * @return  boolean whether the supplied property exists
   */
  boolean hasEnvironmentProperty(String name);


  /**
   * This adds environment properties to this object. If name or value is null,
   * then this method does nothing.
   *
   * @param  name  String property name
   * @param  value  String property value
   */
  void setEnvironmentProperties(String name, String value);


  /**
   * See {@link #setEnvironmentProperties(String,String)}.
   *
   * @param  properties  Properties
   */
  void setEnvironmentProperties(Properties properties);


  /**
   * See {@link #setEnvironmentProperties(String,String)}.
   *
   * @param  properties  Hashtable
   */
  void setEnvironmentProperties(Hashtable properties);
}