Please note that this documentation is not final and is subject to change.

Java™ Platform
Standard Ed. 7

DRAFT internal-b21

javax.naming.ldap
Interface HasControls

All Known Subinterfaces:
UnsolicitedNotification

public interface HasControls

This interface is for returning controls with objects returned in NamingEnumerations. For example, suppose a server sends back controls with the results of a search operation, the service provider would return a NamingEnumeration of objects that are both SearchResult and implement HasControls.

   NamingEnumeration elts = ectx.search((Name)name, filter, sctls);
   while (elts.hasMore()) {
        Object entry = elts.next();

        // Get search result 
        SearchResult res = (SearchResult)entry;
        // do something with it 

        // Get entry controls
        if (entry instanceof HasControls) {
            Control[] entryCtls = ((HasControls)entry).getControls();
            // do something with controls
        }
   }

Since:
1.3

Method Summary
 Control[] getControls()
          Retrieves an array of Controls from the object that implements this interface.
 

Method Detail

getControls

Control[] getControls()
                      throws NamingException
Retrieves an array of Controls from the object that implements this interface. It is null if there are no controls.

Returns:
A possibly null array of Control objects.
Throws:
NamingException - If cannot return controls due to an error.

Java™ Platform
Standard Ed. 7

DRAFT internal-b21

Submit a bug or feature

Copyright 2007 Sun Microsystems, Inc. All rights reserved. Use is subject to the terms of the GNU General Public License.