javax.naming.ldap
Interface HasControls
- All Known Subinterfaces:
- UnsolicitedNotification
- public interface HasControls
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 enum = ectx.search((Name)name, filter, sctls); while (enum.hasMore()) { Object entry = enum.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
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:
- A possibly null array of Control objects.
- Throws:
- NamingException - If cannot return controls due to an error.