| /* |
| * Copyright (c) 2002, 2018 Oracle and/or its affiliates. All rights reserved. |
| * |
| * This program and the accompanying materials are made available under the |
| * terms of the Eclipse Public License v. 2.0, which is available at |
| * http://www.eclipse.org/legal/epl-2.0. |
| * |
| * This Source Code may also be made available under the following Secondary |
| * Licenses when the conditions for such availability set forth in the |
| * Eclipse Public License v. 2.0 are satisfied: GNU General Public License, |
| * version 2 with the GNU Classpath Exception, which is available at |
| * https://www.gnu.org/software/classpath/license.html. |
| * |
| * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 |
| */ |
| |
| package com.sun.jndi.ldap.ext; |
| |
| import javax.naming.ConfigurationException; |
| import javax.naming.NamingException; |
| import javax.naming.ldap.ExtendedRequest; |
| import javax.naming.ldap.ExtendedResponse; |
| |
| /** |
| * This class implements the LDAPv3 Extended Request for BulkImportFinished. |
| * The BulkImportFinishedRequest mark the end of bulk import operation. |
| * <p> |
| * The bulk import extended operations allow importing entries |
| * remotely with a series of LDAP add operations. When a |
| * {@link BulkImportStartRequest} is sent the import must end by |
| * sending the <tt>BulkImportFinishedRequest</tt> before |
| * the normal LDAP operations can resume. Only LDAP add operations are legal |
| * between BulkImportStart and BulkImportFinished operations. |
| * <p> |
| * Note that to add entries using JNDI, use the context methods {@link javax.naming.Context#createSubcontext(javax.naming.Name) Context.createSubcontext} |
| * or {@link javax.naming.Context#bind(javax.naming.Name, java.lang.Object) Context.bind}. |
| * <p> |
| * <b>WARNING:</b> Users have to be extremely careful when using bulk import |
| * operations. Once a bulk import has begun, the previous contents under the |
| * naming context tree are erased. When a bulk import is started, if the |
| * connection is aborted before the bulk import finished is sent, no entries are |
| * imported and the previous contents under the naming context tree are wiped |
| * out of the directory. |
| * <p> |
| * The object identifier for BulkImportFinished is 2.16.840.1.113730.3.5.8 |
| * and there is no extended request value. |
| * <p> |
| * The following code sample shows how the extended operation may be used: |
| * <pre> |
| * // create an initial context using the supplied environment properties |
| * LdapContext ctx = new InitialLdapContext(env, null); |
| * |
| * // The naming context to import to |
| * String namingContext; |
| * |
| * // Bulk import starts |
| * ctx.extendedOperation(new BulkImportStartRequest( |
| * namingContext)); |
| * System.out.println("Bulk import operation begins"); |
| * |
| * // Add entries |
| * ctx.createSubcontext(entryName, entryAttrs); |
| * : |
| * : |
| * // Bulk import done |
| * ctx.extendedOperation(new BulkImportFinishedRequest()); |
| * System.out.println("Bulk import operation finished"); |
| * </pre> |
| * |
| * @see BulkImportStartRequest |
| * @author Jayalaxmi Hangal |
| */ |
| |
| public class BulkImportFinishedRequest implements ExtendedRequest { |
| |
| /** |
| * The BulkImportFinished extended request's assigned object identifier |
| * is 2.16.840.1.113730.3.5.8 |
| */ |
| public static final String OID = "2.16.840.1.113730.3.5.8"; |
| |
| private static final long serialVersionUID = 4555688155005767980L; |
| |
| /** |
| * Constructs a BulkImportFinished extended request. |
| */ |
| public BulkImportFinishedRequest() { |
| } |
| |
| /** |
| * Retrieves the BulkImportFinished request's object identifier string. |
| * |
| * @return The non-null object identifier string. |
| */ |
| @Override |
| public String getID() { |
| return OID; |
| } |
| |
| /** |
| * Retrieves the BulkImportFinished request's ASN.1 BER encoded value. |
| * Since the request has no defined value, null is always |
| * returned. |
| * |
| * @return The null value. |
| */ |
| @Override |
| public byte[] getEncodedValue() { |
| return null; |
| } |
| |
| /** |
| * Creates an extended response object that corresponds to the |
| * LDAP BulkImportFinished extended request. |
| */ |
| @Override |
| public ExtendedResponse createExtendedResponse(String id, byte[] berValue, int offset, int length) |
| throws NamingException { |
| // Confirm that the object identifier is correct |
| if ((id != null) && (!id.equals(OID))) { |
| throw new ConfigurationException( |
| "BulkImportFinished received the following response instead of " + |
| OID + ": " + id); |
| } |
| return new EmptyExtendedResponse(id); |
| } |
| } |