com.ca.jcs.processor
Interface PostQueryAttributesProcessor

All Known Implementing Classes:

AbstractAttributeStyleOpProcessor, AbstractAttributeStyleOpProcessorAssocDirect, AbstractAttributeStyleOpProcessorAssocIndirect, DefaultAssocAttributeOpProcessor, DefaultAssocDirectAttributeOpProcessor, JDBCAttributeStyleOpProcessor, JNDIAttributeStyleOpProcessor, NestedAssocDirectAttributeOpProcessor, ORAAttributeStyleOpProcessor, SDKAttributeStyleOpProcessor, SDKWSAttributeStyleOpProcessor, StubAttributeStyleOpProcessor, StubDirectAssocAttributeStyleOpProcessor

public interface PostQueryAttributesProcessor

Optional interface that should be implemented by AttributeStyleOpProcessors that wish to script specialized handling of query results.

Method Summary

boolean	isPostQueryPocessingActive() Boolean to turn on calling of the methods below, as there are efficiency impacts to calling them.
void	processPostQueryAttributes(ObjectInfo objInfo, Attributes attrs) Called after attributes have been collected after a doLookUp or for each result returned by a doSearch.
void	processPostQuerySearchResult(ObjectInfo objInfo, Set<String> requestedConnAttrIds, Attributes attrs, SearchResult sr) Called after LDAP search result returned by a doSearch is finalized (note that processPostQueryAttributes(ObjectInfo, Attributes) will have already been called) to allow specialized processing.
void	setPostQueryPocessingActive(boolean active)

Method Detail

isPostQueryPocessingActive

boolean isPostQueryPocessingActive()

Boolean to turn on calling of the methods below, as there are efficiency impacts to calling them.

Returns:

True if methods below (and possible opbindings) should be called.

setPostQueryPocessingActive

void setPostQueryPocessingActive(boolean active)

processPostQueryAttributes

@OpBindingMethod(operation=PROCESS_POST_QUERY_ATTRIBUTES)
void processPostQueryAttributes(ObjectInfo objInfo,
                                                                                      Attributes attrs)
                                throws NamingException

Called after attributes have been collected after a doLookUp or for each result returned by a doSearch.

Parameters:

objInfo - Information about object for which attrs were retrieved.

attrs - Connector-speak attributes.

Throws:

NamingException - If thrown then doLookUp will fail or search result will be skipped.

processPostQuerySearchResult

@OpBindingMethod(operation=PROCESS_POST_QUERY_SEARCH_RESULT)
void processPostQuerySearchResult(ObjectInfo objInfo,
                                                                                           Set<String> requestedConnAttrIds,
                                                                                           Attributes attrs,
                                                                                           SearchResult sr)
                                  throws NamingException

Called after LDAP search result returned by a doSearch is finalized (note that processPostQueryAttributes(ObjectInfo, Attributes) will have already been called) to allow specialized processing.

Parameters:

objInfo - Information about object for which attrs were retrieved.

requestedConnAttrIds - Attributes requested by the top-level search which generated this SearchResult.

attrs - Connector-speak attributes.

sr - Search result in LDAP-speak that will be returned to the client after any manipulations done by this method.

Throws:

NamingException - If thrown then doLookUp will fail or search result will be skipped.