/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- * * ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Mozilla Public License Version * 1.1 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * http://www.mozilla.org/MPL/ * * Software distributed under the License is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License * for the specific language governing rights and limitations under the * License. * * The Original Code is mozilla.org code. * * The Initial Developer of the Original Code is * Netscape Communications Corporation. * Portions created by the Initial Developer are Copyright (C) 1999 * the Initial Developer. All Rights Reserved. * * Contributor(s): * * Alternatively, the contents of this file may be used under the terms of * either the GNU General Public License Version 2 or later (the "GPL"), or * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the MPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ package netscape.ldap; import java.util.*; import netscape.ldap.client.*; import netscape.ldap.client.opers.*; import java.io.*; /** * Specifies additional features available in version 3 of the * LDAP protocol. (To view preliminary information on this work * in progress, see the LDAP v3 internet draft. You can find the * latest version of this document listed under the Internet-Drafts * section of the * ASID home page.) * * @version 1.0 */ public interface LDAPv3 extends LDAPv2 { /** * Connects and authenticates to the LDAP server using the specified version of the * LDAP protocol. * @param version requested version of the LDAP protocol: currently 2 or 3 * @param host hostname of the LDAP server * @param port port number of the LDAP server. To specify the * default port, use DEFAULT_PORT. * @param dn distinguished name to use for authentication * @param passwd password for authentication * @exception LDAPException Failed to connect and authenticate to the server. */ public void connect(int version, String host, int port, String dn, String passwd) throws LDAPException; /** * Authenticates to the LDAP server (to which the object is currently * connected) using the specified name, password, and version * of the LDAP protocol. If the server does not support the requested * protocol version, an exception is thrown. If the object has been * disconnected from an LDAP server, this method attempts to reconnect * to the server. If the object had already authenticated, the old * authentication is discarded. * @param version requested LDAP protocol version: currently 2 or 3. * @param dn if non-null and non-empty, specifies that the * connection and all operations through it should * authenticate with dn as the distinguished name * @param passwd if non-null and non-empty, specifies that the * connection and all operations through it should * authenticated with passwd as password * @exception LDAPException Failed to authenticate to the LDAP server. */ public void authenticate(int version, String dn, String passwd) throws LDAPException; /** * Authenticates to the LDAP server (to which the object is currently * connected) using the specified name, password, and version of the * LDAP protocol. If the server does not support the requested * version of the protocol, an exception is thrown. If the * object has been disconnected from an LDAP server, this method * attempts to reconnect to the server. If the object had already * authenticated, the old authentication is discarded. * @param version requested LDAP protocol version: currently 2 or 3. * @param dn if non-null and non-empty, specifies that the * connection and all operations through it should authenticate * with dn as the distinguished name * @param passwd if non-null and non-empty, specifies that the * connection and all operations through it should authenticate * with passwd as password * @exception LDAPException Failed to authenticate to the LDAP server. */ public void bind(int version, String dn, String passwd) throws LDAPException; /** * Performs an extended operation on the directory. Extended operations * are part of version 3 of the LDAP protocol. *

* * @param op LDAPExtendedOperation object specifying the OID of the * extended operation and the data to use in the operation * @exception LDAPException Failed to execute the operation * @return LDAPExtendedOperation object representing the extended response * returned by the server. * @see LDAPExtendedOperation */ public LDAPExtendedOperation extendedOperation( LDAPExtendedOperation op ) throws LDAPException; /** * Renames and moves an entry in the directory. * @param DN original distinguished name (DN) for the entry * @param newRDN new relative distinguished name (RDN) for the entry * @param newParentDN distinguished name of the new parent entry of the * specified entry * @param deleteOldRDN specifies whether or not to remove the old RDN * when renaming and moving the entry. If true, the old RDN will be deleted. * @exception LDAPException Failed to rename the specified entry. */ public void rename( String DN, String newRDN, String newParentDN, boolean deleteOldRDN ) throws LDAPException; /** * Renames and moves an entry in the directory. * @param DN original distinguished name (DN) for the entry * @param newRDN new relative distinguished name (RDN) for the entry * @param newParentDN distinguished name of the new parent entry of the * specified entry * @param deleteOldRDN specifies whether or not to remove the old RDN * when renaming and moving the entry. If true, the old RDN will be deleted. * @param cons the constraints set for the rename operation * @exception LDAPException Failed to rename the specified entry. */ public void rename( String DN, String newRDN, String newParentDN, boolean deleteOldRDN, LDAPConstraints cons ) throws LDAPException; /** * Returns an array of the latest controls (if any) from the server. * @return an array of the controls returned by an operation, * or null if none. * @see netscape.ldap.LDAPControl */ public LDAPControl[] getResponseControls(); /** * Option specifying client controls for LDAP operations. These * controls are interpreted by the client and are not passed * to the LDAP server. * @see netscape.ldap.LDAPControl * @see netscape.ldap.LDAPConnection#getOption * @see netscape.ldap.LDAPConnection#setOption */ public static final int CLIENTCONTROLS = 11; /** * Option specifying server controls for LDAP operations. These * controls are passed to the LDAP server. They may also be returned by * the server. * @see netscape.ldap.LDAPControl * @see netscape.ldap.LDAPConnection#getOption * @see netscape.ldap.LDAPConnection#setOption */ public static final int SERVERCONTROLS = 12; /** * Attribute type that you can specify in the LDAPConnection * search method if you don't want to retrieve any of the * attribute types for entries found by the search. * @see netscape.ldap.LDAPConnection#search */ public static final String NO_ATTRS = "1.1"; /** * Attribute type that you can specify in the LDAPConnection * search method if you want to retrieve all attribute types. * You can use this if you want to retrieve all attributes in * addition to an operational attribute. For example: *

* * 

     * ...
     * String [] MY_ATTRS = { LDAPv3.ALL_USER_ATTRS, "modifiersName",
     *     "modifyTimestamp" };
     * LDAPSearchResults res = ld.search( MY_SEARCHBASE,
     *     LDAPConnection.SCOPE_SUB, MY_FILTER, MY_ATTRS, false, cons );
     * ...
     *
* @see netscape.ldap.LDAPConnection#search */ public static final String ALL_USER_ATTRS = "*"; }