0N/A/*
2362N/A * Copyright (c) 1999, 2003, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
2362N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
2362N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
2362N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
2362N/A * or visit www.oracle.com if you need additional information or have any
2362N/A * questions.
0N/A */
0N/A
0N/Apackage javax.naming.ldap;
0N/A
0N/Aimport javax.naming.NamingException;
0N/A
0N/A/**
0N/A * This interface is for returning controls with objects returned
0N/A * in NamingEnumerations.
0N/A * For example, suppose a server sends back controls with the results
0N/A * of a search operation, the service provider would return a NamingEnumeration of
0N/A * objects that are both SearchResult and implement HasControls.
0N/A *<blockquote><pre>
0N/A * NamingEnumeration elts = ectx.search((Name)name, filter, sctls);
0N/A * while (elts.hasMore()) {
0N/A * Object entry = elts.next();
0N/A *
0N/A * // Get search result
0N/A * SearchResult res = (SearchResult)entry;
0N/A * // do something with it
0N/A *
0N/A * // Get entry controls
0N/A * if (entry instanceof HasControls) {
0N/A * Control[] entryCtls = ((HasControls)entry).getControls();
0N/A * // do something with controls
0N/A * }
0N/A * }
0N/A *</pre></blockquote>
0N/A *
0N/A * @author Rosanna Lee
0N/A * @author Scott Seligman
0N/A * @author Vincent Ryan
0N/A * @since 1.3
0N/A *
0N/A */
0N/A
0N/Apublic interface HasControls {
0N/A
0N/A /**
0N/A * Retrieves an array of <tt>Control</tt>s from the object that
0N/A * implements this interface. It is null if there are no controls.
0N/A *
0N/A * @return A possibly null array of <tt>Control</tt> objects.
0N/A * @throws NamingException If cannot return controls due to an error.
0N/A */
0N/A public Control[] getControls() throws NamingException;
0N/A}