oracle.oud

Interface RequestManager

All Known Subinterfaces:

ManagedPlugin, Plugin

All Known Implementing Classes:

AbstractPlugin

public interface RequestManager

This interface defines the way plugins receive and execute LDAP requests in a workflow.

Method Summary

Modifier and Type	Method and Description
void	handleAdd(RequestContext requestContext, AddRequest request, ResultHandler resultHandler) Invoked when an add request is received from a client.
void	handleBind(RequestContext requestContext, int version, BindRequest request, ResultHandler resultHandler) Invoked when a bind request is received from a client.
void	handleCompare(RequestContext requestContext, CompareRequest request, ResultHandler resultHandler) Invoked when a compare request is received from a client.
void	handleDelete(RequestContext requestContext, DeleteRequest request, ResultHandler resultHandler) Invoked when a delete request is received from a client.
<R extends ExtendedResult> void	handleExtended(RequestContext requestContext, ExtendedRequest<R> request, ResultHandler resultHandler) Invoked when an extended request is received from a client.
void	handleModify(RequestContext requestContext, ModifyRequest request, ResultHandler resultHandler) Invoked when a modify request is received from a client.
void	handleModifyDN(RequestContext requestContext, ModifyDNRequest request, ResultHandler resultHandler) Invoked when a modify DN request is received from a client.
void	handleSearch(RequestContext requestContext, SearchRequest request, SearchResultHandler resultHandler) Invoked when a search request is received from a client.

Method Detail

handleAdd

void handleAdd(RequestContext requestContext,
               AddRequest request,
               ResultHandler resultHandler)
        throws java.lang.UnsupportedOperationException

Invoked when an add request is received from a client.

Parameters:

requestContext - The request context.

request - The add request.

resultHandler - The handler which should be used to send back the result to the client.

Throws:

java.lang.UnsupportedOperationException - If this request handler does not handle add requests.

handleBind

void handleBind(RequestContext requestContext,
                int version,
                BindRequest request,
                ResultHandler resultHandler)
         throws java.lang.UnsupportedOperationException

Invoked when a bind request is received from a client.

Parameters:

requestContext - The request context.

version - The protocol version included with the bind request.

request - The bind request.

resultHandler - The handler which should be used to send back the result to the client.

Throws:

java.lang.UnsupportedOperationException - If this request handler does not handle bind requests.

handleCompare

void handleCompare(RequestContext requestContext,
                   CompareRequest request,
                   ResultHandler resultHandler)
            throws java.lang.UnsupportedOperationException

Invoked when a compare request is received from a client.

Parameters:

requestContext - The request context.

request - The compare request.

resultHandler - The handler which should be used to send back the result to the client.

Throws:

java.lang.UnsupportedOperationException - If this request handler does not handle compare requests.

handleDelete

void handleDelete(RequestContext requestContext,
                  DeleteRequest request,
                  ResultHandler resultHandler)
           throws java.lang.UnsupportedOperationException

Invoked when a delete request is received from a client.

Parameters:

requestContext - The request context.

request - The delete request.

resultHandler - The handler which should be used to send back the result to the client.

Throws:

java.lang.UnsupportedOperationException - If this request handler does not handle delete requests.

handleExtended

<R extends ExtendedResult> void handleExtended(RequestContext requestContext,
                                               ExtendedRequest<R> request,
                                               ResultHandler resultHandler)
                                        throws java.lang.UnsupportedOperationException

Invoked when an extended request is received from a client.

Type Parameters:

R - The type of result returned by the extended request.

Parameters:

requestContext - The request context.

request - The extended request.

resultHandler - The handler which should be used to send back the result to the client.

Throws:

java.lang.UnsupportedOperationException - If this request handler does not handle extended requests.

handleModify

void handleModify(RequestContext requestContext,
                  ModifyRequest request,
                  ResultHandler resultHandler)
           throws java.lang.UnsupportedOperationException

Invoked when a modify request is received from a client.

Parameters:

requestContext - The request context.

request - The modify request.

resultHandler - The handler which should be used to send back the result to the client.

Throws:

java.lang.UnsupportedOperationException - If this request handler does not handle modify requests.

handleModifyDN

void handleModifyDN(RequestContext requestContext,
                    ModifyDNRequest request,
                    ResultHandler resultHandler)
             throws java.lang.UnsupportedOperationException

Invoked when a modify DN request is received from a client.

Parameters:

requestContext - The request context.

request - The modify DN request.

resultHandler - The handler which should be used to send back the result to the client.

Throws:

java.lang.UnsupportedOperationException - If this request handler does not handle modify DN requests.

handleSearch

void handleSearch(RequestContext requestContext,
                  SearchRequest request,
                  SearchResultHandler resultHandler)
           throws java.lang.UnsupportedOperationException

Invoked when a search request is received from a client.

Parameters:

requestContext - The request context.

request - The search request.

resultHandler - The handler which should be used to send back the search results to the client.

Throws:

java.lang.UnsupportedOperationException - If this request handler does not handle search requests.