| | |
| | | * CDDL HEADER END |
| | | * |
| | | * |
| | | * Portions Copyright 2006 Sun Microsystems, Inc. |
| | | * Portions Copyright 2006-2007 Sun Microsystems, Inc. |
| | | */ |
| | | package org.opends.server.api.plugin; |
| | | |
| | |
| | | import org.opends.server.types.SearchResultReference; |
| | | import org.opends.server.types.operation.*; |
| | | |
| | | import static org.opends.server.loggers.Debug.*; |
| | | import static org.opends.server.messages.MessageHandler.*; |
| | | import static org.opends.server.messages.PluginMessages.*; |
| | | |
| | |
| | | */ |
| | | public abstract class DirectoryServerPlugin |
| | | { |
| | | /** |
| | | * The fully-qualified name of this class for debugging purposes. |
| | | */ |
| | | private static final String CLASS_NAME = |
| | | "org.opends.server.api.plugin.DirectoryServerPlugin"; |
| | | |
| | | |
| | | |
| | |
| | | */ |
| | | protected DirectoryServerPlugin() |
| | | { |
| | | assert debugConstructor(CLASS_NAME); |
| | | |
| | | } |
| | | |
| | | |
| | |
| | | public final void initializeInternal(DN pluginDN, |
| | | Set<PluginType> pluginTypes) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "initializeInternal", |
| | | String.valueOf(pluginDN), |
| | | String.valueOf(pluginTypes)); |
| | | |
| | | this.pluginDN = pluginDN; |
| | | this.pluginTypes = pluginTypes; |
| | |
| | | */ |
| | | public void finalizePlugin() |
| | | { |
| | | assert debugEnter(CLASS_NAME, "finalizePlugin"); |
| | | |
| | | // No implementation is required by default. |
| | | } |
| | |
| | | */ |
| | | public final DN getPluginEntryDN() |
| | | { |
| | | assert debugEnter(CLASS_NAME, "getPluginEntryDN"); |
| | | |
| | | return pluginDN; |
| | | } |
| | |
| | | */ |
| | | public final Set<PluginType> getPluginTypes() |
| | | { |
| | | assert debugEnter(CLASS_NAME, "getPluginTypes"); |
| | | |
| | | return pluginTypes; |
| | | } |
| | |
| | | */ |
| | | public StartupPluginResult doStartup() |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doStartup"); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | */ |
| | | public void doShutdown(String reason) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doShutdown", |
| | | String.valueOf(reason)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PostConnectPluginResult doPostConnect(ClientConnection |
| | | clientConnection) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPostConnect", |
| | | String.valueOf(clientConnection)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | DisconnectReason disconnectReason, |
| | | int messageID, String message) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPostDisconnect", |
| | | String.valueOf(clientConnection), |
| | | String.valueOf(disconnectReason), |
| | | String.valueOf(messageID), |
| | | String.valueOf(message)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String msg = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public LDIFPluginResult doLDIFImport(LDIFImportConfig importConfig, |
| | | Entry entry) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doLDIFImport", |
| | | String.valueOf(importConfig), |
| | | String.valueOf(entry)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public LDIFPluginResult doLDIFExport(LDIFExportConfig exportConfig, |
| | | Entry entry) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doLDIFExport", |
| | | String.valueOf(exportConfig), |
| | | String.valueOf(entry)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PreParsePluginResult |
| | | doPreParse(PreParseAbandonOperation abandonOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPreParse", |
| | | String.valueOf(abandonOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PostOperationPluginResult |
| | | doPostOperation(PostOperationAbandonOperation abandonOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPostOperation", |
| | | String.valueOf(abandonOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = |
| | |
| | | public PreParsePluginResult |
| | | doPreParse(PreParseAddOperation addOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPreParse", |
| | | String.valueOf(addOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PreOperationPluginResult |
| | | doPreOperation(PreOperationAddOperation addOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPreOperation", |
| | | String.valueOf(addOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PostOperationPluginResult |
| | | doPostOperation(PostOperationAddOperation addOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPostOperation", |
| | | String.valueOf(addOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PostResponsePluginResult |
| | | doPostResponse(PostResponseAddOperation addOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPostResponse", |
| | | String.valueOf(addOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PreParsePluginResult |
| | | doPreParse(PreParseBindOperation bindOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPreParse", |
| | | String.valueOf(bindOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PreOperationPluginResult |
| | | doPreOperation(PreOperationBindOperation bindOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPreOperation", |
| | | String.valueOf(bindOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PostOperationPluginResult |
| | | doPostOperation(PostOperationBindOperation bindOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPostOperation", |
| | | String.valueOf(bindOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PostResponsePluginResult |
| | | doPostResponse(PostResponseBindOperation bindOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPostResponse", |
| | | String.valueOf(bindOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PreParsePluginResult |
| | | doPreParse(PreParseCompareOperation compareOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPreParse", |
| | | String.valueOf(compareOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PreOperationPluginResult |
| | | doPreOperation(PreOperationCompareOperation compareOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPreOperation", |
| | | String.valueOf(compareOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PostOperationPluginResult |
| | | doPostOperation(PostOperationCompareOperation compareOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPostOperation", |
| | | String.valueOf(compareOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = |
| | |
| | | public PostResponsePluginResult |
| | | doPostResponse(PostResponseCompareOperation compareOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPostResponse", |
| | | String.valueOf(compareOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PreParsePluginResult |
| | | doPreParse(PreParseDeleteOperation deleteOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPreParse", |
| | | String.valueOf(deleteOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PreOperationPluginResult |
| | | doPreOperation(PreOperationDeleteOperation deleteOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPreOperation", |
| | | String.valueOf(deleteOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PostOperationPluginResult |
| | | doPostOperation(PostOperationDeleteOperation deleteOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPostOperation", |
| | | String.valueOf(deleteOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PostResponsePluginResult |
| | | doPostResponse(PostResponseDeleteOperation deleteOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPostResponse", |
| | | String.valueOf(deleteOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PreParsePluginResult |
| | | doPreParse(PreParseExtendedOperation extendedOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPreParse", |
| | | String.valueOf(extendedOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PreOperationPluginResult |
| | | doPreOperation(PreOperationExtendedOperation extendedOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPreOperation", |
| | | String.valueOf(extendedOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = |
| | |
| | | doPostOperation(PostOperationExtendedOperation |
| | | extendedOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPostOperation", |
| | | String.valueOf(extendedOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = |
| | |
| | | public PostResponsePluginResult |
| | | doPostResponse(PostResponseExtendedOperation extendedOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPostResponse", |
| | | String.valueOf(extendedOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = |
| | |
| | | public PreParsePluginResult |
| | | doPreParse(PreParseModifyOperation modifyOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPreParse", |
| | | String.valueOf(modifyOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PreOperationPluginResult |
| | | doPreOperation(PreOperationModifyOperation modifyOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPreOperation", |
| | | String.valueOf(modifyOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PostOperationPluginResult |
| | | doPostOperation(PostOperationModifyOperation modifyOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPostOperation", |
| | | String.valueOf(modifyOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PostResponsePluginResult |
| | | doPostResponse(PostResponseModifyOperation modifyOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPostResponse", |
| | | String.valueOf(modifyOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PreParsePluginResult |
| | | doPreParse(PreParseModifyDNOperation modifyDNOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPreParse", |
| | | String.valueOf(modifyDNOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PreOperationPluginResult |
| | | doPreOperation(PreOperationModifyDNOperation modifyDNOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPreOperation", |
| | | String.valueOf(modifyDNOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = |
| | |
| | | doPostOperation(PostOperationModifyDNOperation |
| | | modifyDNOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPostOperation", |
| | | String.valueOf(modifyDNOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = |
| | |
| | | public PostResponsePluginResult |
| | | doPostResponse(PostResponseModifyDNOperation modifyDNOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPostResponse", |
| | | String.valueOf(modifyDNOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = |
| | |
| | | public PreParsePluginResult |
| | | doPreParse(PreParseSearchOperation searchOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPreParse", |
| | | String.valueOf(searchOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PreOperationPluginResult |
| | | doPreOperation(PreOperationSearchOperation searchOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPreOperation", |
| | | String.valueOf(searchOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | processSearchEntry(SearchEntrySearchOperation searchOperation, |
| | | SearchResultEntry searchEntry) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "processSearchEntry", |
| | | String.valueOf(searchOperation), |
| | | String.valueOf(searchEntry)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | searchOperation, |
| | | SearchResultReference searchReference) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "processSearchReference", |
| | | String.valueOf(searchOperation), |
| | | String.valueOf(searchReference)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = |
| | |
| | | public PostOperationPluginResult |
| | | doPostOperation(PostOperationSearchOperation searchOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPostOperation", |
| | | String.valueOf(searchOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PostResponsePluginResult |
| | | doPostResponse(PostResponseSearchOperation searchOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPostResponse", |
| | | String.valueOf(searchOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PreParsePluginResult |
| | | doPreParse(PreParseUnbindOperation unbindOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPreParse", |
| | | String.valueOf(unbindOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | public PostOperationPluginResult |
| | | doPostOperation(PostOperationUnbindOperation unbindOperation) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "doPostOperation", |
| | | String.valueOf(unbindOperation)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |
| | |
| | | processIntermediateResponse( |
| | | IntermediateResponse intermediateResponse) |
| | | { |
| | | assert debugEnter(CLASS_NAME, "processIntermediateResponse", |
| | | String.valueOf(intermediateResponse)); |
| | | |
| | | int msgID = MSGID_PLUGIN_TYPE_NOT_SUPPORTED; |
| | | String message = getMessage(msgID, String.valueOf(pluginDN), |