1/* 2 * Copyright (c) 1999, 2003, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26package javax.naming.ldap; 27 28import javax.naming.NamingException; 29 30/** 31 * This interface is for returning controls with objects returned 32 * in NamingEnumerations. 33 * For example, suppose a server sends back controls with the results 34 * of a search operation, the service provider would return a NamingEnumeration of 35 * objects that are both SearchResult and implement HasControls. 36 *<blockquote><pre> 37 * NamingEnumeration elts = ectx.search((Name)name, filter, sctls); 38 * while (elts.hasMore()) { 39 * Object entry = elts.next(); 40 * 41 * // Get search result 42 * SearchResult res = (SearchResult)entry; 43 * // do something with it 44 * 45 * // Get entry controls 46 * if (entry instanceof HasControls) { 47 * Control[] entryCtls = ((HasControls)entry).getControls(); 48 * // do something with controls 49 * } 50 * } 51 *</pre></blockquote> 52 * 53 * @author Rosanna Lee 54 * @author Scott Seligman 55 * @author Vincent Ryan 56 * @since 1.3 57 * 58 */ 59 60public interface HasControls { 61 62 /** 63 * Retrieves an array of {@code Control}s from the object that 64 * implements this interface. It is null if there are no controls. 65 * 66 * @return A possibly null array of {@code Control} objects. 67 * @throws NamingException If cannot return controls due to an error. 68 */ 69 public Control[] getControls() throws NamingException; 70} 71