org.apache.directory.server.ldap
Interface ExtendedOperationHandler

All Known Implementing Classes:

GracefulShutdownHandler, LaunchDiagnosticUiHandler, StartTlsHandler, StoredProcedureExtendedOperationHandler

public interface ExtendedOperationHandler

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

Version:

$Rev: 692919 $, $Date: 2008-09-07 15:00:21 -0400 (Sun, 07 Sep 2008) $

Author:

Apache Directory Project

XBean

Method Summary

java.util.Set<java.lang.String>	getExtensionOids() The OIDs of the extensions supported by this handler.
java.lang.String	getOid() Returns the EXTENSION_OID of the extended request this handler can handle.
void	handleExtendedOperation(LdapSession session, org.apache.directory.shared.ldap.message.ExtendedRequest req) Handles the specified extended operation.
void	setLdapServer(LdapService ldapService) Sets the LDAP server for this extendedOperation handler.

Method Detail

getOid

java.lang.String getOid()

Returns the EXTENSION_OID of the extended request this handler can handle.

getExtensionOids

java.util.Set<java.lang.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,
                             org.apache.directory.shared.ldap.message.ExtendedRequest req)
                             throws java.lang.Exception

Handles the specified extended operation.

Parameters:

session - the session object related with current connection

req - the LDAP Extended operation request

Throws:

java.lang.Exception - if failed to handle the operation

setLdapServer

void setLdapServer(LdapService ldapService)

Sets the LDAP server for this extendedOperation handler.

Parameters:

ldapService - the ldap protocol server