APIdia Launch Partner
Top Description Methods
javax.naming.ldap

public Interface HasControls

Known Direct Subinterfaces
javax.naming.ldap.UnsolicitedNotification
Known Direct Implementers
com.sun.jndi.ldap.BindingWithControls, com.sun.jndi.ldap.NameClassPairWithControls, com.sun.jndi.ldap.SearchResultWithControls
Imports
javax.naming.NamingException

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
     }
   }
Authors
Rosanna Lee, Scott Seligman, Vincent Ryan
Since
1.3

Method Summary

Modifier and TypeMethod and Description
public Control[]

Returns:

A possibly null array of Control objects.
getControls
()

Retrieves an array of Controls from the object that implements this interface.

Method Detail

getControlsback to summary
public 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:Control[]

A possibly null array of Control objects.

Exceptions
NamingException:
If cannot return controls due to an error.