org.apache.directory.server.ldap

Interface ExtendedOperationHandler<R extends org.apache.directory.api.ldap.model.message.ExtendedRequest,P extends org.apache.directory.api.ldap.model.message.ExtendedResponse>

All Known Implementing Classes:

CertGenerationRequestHandler, EndTransactionHandler, GracefulShutdownHandler, PwdModifyHandler, StartTlsHandler, StartTransactionHandler, StoredProcedureExtendedOperationHandler, WhoAmIHandler

public interface ExtendedOperationHandler<R extends org.apache.directory.api.ldap.model.message.ExtendedRequest,P extends org.apache.directory.api.ldap.model.message.ExtendedResponse>

An extension (hook) point that enables an implementor to provide his or her own LDAP 'Extended' operation.

Author:

Apache Directory Project

Method Summary

Modifier and Type	Method and Description
Set<String>	getExtensionOids() The OIDs of the extensions supported by this handler.
String	getOid()
void	handleExtendedOperation(LdapSession session, R req) Handles the specified extended operation.
void	setLdapServer(LdapServer ldapServer) Sets the LDAP server for this extendedOperation handler.

Method Detail

getOid

String getOid()

Returns:

the EXTENSION_OID of the extended request this handler can handle.

getExtensionOids

Set<String> getExtensionOids()

The OIDs of the extensions supported by this handler. This includes the request as well as any responses associated with the request. These OIDs will be registered with the server to publish them as supportedExtensions.

Returns:

the OIDs supported by this handler.

handleExtendedOperation

void handleExtendedOperation(LdapSession session,
                             R req)
                      throws Exception

Handles the specified extended operation.

Parameters:

session - the session object related with current connection

req - the LDAP Extended operation request

Throws:

Exception - if failed to handle the operation

setLdapServer

void setLdapServer(LdapServer ldapServer)

Sets the LDAP server for this extendedOperation handler.

Parameters:

ldapServer - the ldap protocol server