|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.plugin.DirectoryServerPlugin<T>
T
- The type of configuration handled by this plugin.@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=true, mayInvoke=false) public abstract class DirectoryServerPlugin<T extends PluginCfg>
This class defines the set of methods and structures that are available for use in Directory Server plugins. This is a single class that may be used for all types of plugins, and an individual plugin only needs to implement the specific methods that are applicable to that particular plugin type.
Constructor Summary | |
---|---|
protected |
DirectoryServerPlugin()
Creates a new instance of this Directory Server plugin. |
Method Summary | |
---|---|
PluginResult.ImportLDIF |
doLDIFExport(LDIFExportConfig exportConfig,
Entry entry)
Performs any necessary processing that should be done during an LDIF export operation immediately after determining that the provided entry should be included in the export. |
PluginResult.ImportLDIF |
doLDIFImport(LDIFImportConfig importConfig,
Entry entry)
Performs any necessary processing that should be done during an LDIF import operation immediately after reading an entry and confirming that it should be imported based on the provided configuration. |
PluginResult.PostConnect |
doPostConnect(ClientConnection clientConnection)
Performs any processing that should be done when the Directory Server accepts a new connection from a client. |
PluginResult.PostDisconnect |
doPostDisconnect(ClientConnection clientConnection,
DisconnectReason disconnectReason,
Message message)
Performs any processing that should be done whenever a client connection is closed (regardless of whether the closure is initiated by the client or the server). |
PluginResult.PostOperation |
doPostOperation(PostOperationAbandonOperation abandonOperation)
Performs any necessary processing that should be done after the Directory Server has completed processing for an abandon operation. |
PluginResult.PostOperation |
doPostOperation(PostOperationAddOperation addOperation)
Performs any necessary processing that should be done after the Directory Server has completed the core processing for an add operation but before the response has been sent to the client. |
PluginResult.PostOperation |
doPostOperation(PostOperationBindOperation bindOperation)
Performs any necessary processing that should be done after the Directory Server has completed the core processing for a bind operation but before the response has been sent to the client. |
PluginResult.PostOperation |
doPostOperation(PostOperationCompareOperation compareOperation)
Performs any necessary processing that should be done after the Directory Server has completed the core processing for a compare operation but before the response has been sent to the client. |
PluginResult.PostOperation |
doPostOperation(PostOperationDeleteOperation deleteOperation)
Performs any necessary processing that should be done after the Directory Server has completed the core processing for a delete operation but before the response has been sent to the client. |
PluginResult.PostOperation |
doPostOperation(PostOperationExtendedOperation extendedOperation)
Performs any necessary processing that should be done after the Directory Server has completed the core processing for an extended operation but before the response has been sent to the client. |
PluginResult.PostOperation |
doPostOperation(PostOperationModifyDNOperation modifyDNOperation)
Performs any necessary processing that should be done after the Directory Server has completed the core processing for a modify DN operation but before the response has been sent to the client. |
PluginResult.PostOperation |
doPostOperation(PostOperationModifyOperation modifyOperation)
Performs any necessary processing that should be done after the Directory Server has completed the core processing for a modify operation but before the response has been sent to the client. |
PluginResult.PostOperation |
doPostOperation(PostOperationSearchOperation searchOperation)
Performs any necessary processing that should be done after the Directory Server has completed the core processing for a search operation but before the response has been sent to the client. |
PluginResult.PostOperation |
doPostOperation(PostOperationUnbindOperation unbindOperation)
Performs any necessary processing that should be done after the Directory Server has completed processing for an unbind operation. |
PluginResult.PostResponse |
doPostResponse(PostResponseAddOperation addOperation)
Performs any necessary processing that should be done after the Directory Server has completed all processing for an add operation and has sent the response to the client. |
PluginResult.PostResponse |
doPostResponse(PostResponseBindOperation bindOperation)
Performs any necessary processing that should be done after the Directory Server has completed all processing for a bind operation and has sent the response to the client. |
PluginResult.PostResponse |
doPostResponse(PostResponseCompareOperation compareOperation)
Performs any necessary processing that should be done after the Directory Server has completed all processing for a compare operation and has sent the response to the client. |
PluginResult.PostResponse |
doPostResponse(PostResponseDeleteOperation deleteOperation)
Performs any necessary processing that should be done after the Directory Server has completed all processing for a delete operation and has sent the response to the client. |
PluginResult.PostResponse |
doPostResponse(PostResponseExtendedOperation extendedOperation)
Performs any necessary processing that should be done after the Directory Server has completed all processing for an extended operation and has sent the response to the client. |
PluginResult.PostResponse |
doPostResponse(PostResponseModifyDNOperation modifyDNOperation)
Performs any necessary processing that should be done after the Directory Server has completed all processing for a modify DN operation and has sent the response to the client. |
PluginResult.PostResponse |
doPostResponse(PostResponseModifyOperation modifyOperation)
Performs any necessary processing that should be done after the Directory Server has completed all processing for a modify operation and has sent the response to the client. |
PluginResult.PostResponse |
doPostResponse(PostResponseSearchOperation searchOperation)
Performs any necessary processing that should be done after the Directory Server has completed all processing for a search operation and has sent the response to the client. |
void |
doPostSynchronization(PostSynchronizationAddOperation addOperation)
Performs any necessary processing that should be done after the Directory Server has completed processing for an add operation performed via synchronization. |
void |
doPostSynchronization(PostSynchronizationDeleteOperation deleteOperation)
Performs any necessary processing that should be done after the Directory Server has completed processing for a delete operation performed via synchronization. |
void |
doPostSynchronization(PostSynchronizationModifyDNOperation modifyDNOperation)
Performs any necessary processing that should be done after the Directory Server has completed processing for a modify DN operation performed via synchronization. |
void |
doPostSynchronization(PostSynchronizationModifyOperation modifyOperation)
Performs any necessary processing that should be done after the Directory Server has completed processing for a modify operation performed via synchronization. |
PluginResult.PreOperation |
doPreOperation(PreOperationAddOperation addOperation)
Performs any necessary processing that should be done just before the Directory Server performs the core processing for an add operation. |
PluginResult.PreOperation |
doPreOperation(PreOperationBindOperation bindOperation)
Performs any necessary processing that should be done just before the Directory Server performs the core processing for a bind operation. |
PluginResult.PreOperation |
doPreOperation(PreOperationCompareOperation compareOperation)
Performs any necessary processing that should be done just before the Directory Server performs the core processing for a compare operation. |
PluginResult.PreOperation |
doPreOperation(PreOperationDeleteOperation deleteOperation)
Performs any necessary processing that should be done just before the Directory Server performs the core processing for a delete operation. |
PluginResult.PreOperation |
doPreOperation(PreOperationExtendedOperation extendedOperation)
Performs any necessary processing that should be done just before the Directory Server performs the core processing for an extended operation. |
PluginResult.PreOperation |
doPreOperation(PreOperationModifyDNOperation modifyDNOperation)
Performs any necessary processing that should be done just before the Directory Server performs the core processing for a modify DN operation. |
PluginResult.PreOperation |
doPreOperation(PreOperationModifyOperation modifyOperation)
Performs any necessary processing that should be done just before the Directory Server performs the core processing for a modify operation. |
PluginResult.PreOperation |
doPreOperation(PreOperationSearchOperation searchOperation)
Performs any necessary processing that should be done just before the Directory Server performs the core processing for a search operation. |
PluginResult.PreParse |
doPreParse(PreParseAbandonOperation abandonOperation)
Performs any necessary processing that should be done before the Directory Server parses the elements of an abandon request. |
PluginResult.PreParse |
doPreParse(PreParseAddOperation addOperation)
Performs any necessary processing that should be done before the Directory Server parses the elements of an add request. |
PluginResult.PreParse |
doPreParse(PreParseBindOperation bindOperation)
Performs any necessary processing that should be done before the Directory Server parses the elements of a bind request. |
PluginResult.PreParse |
doPreParse(PreParseCompareOperation compareOperation)
Performs any necessary processing that should be done before the Directory Server parses the elements of a compare request. |
PluginResult.PreParse |
doPreParse(PreParseDeleteOperation deleteOperation)
Performs any necessary processing that should be done before the Directory Server parses the elements of a delete request. |
PluginResult.PreParse |
doPreParse(PreParseExtendedOperation extendedOperation)
Performs any necessary processing that should be done before the Directory Server parses the elements of an extended request. |
PluginResult.PreParse |
doPreParse(PreParseModifyDNOperation modifyDNOperation)
Performs any necessary processing that should be done before the Directory Server parses the elements of a modify DN request. |
PluginResult.PreParse |
doPreParse(PreParseModifyOperation modifyOperation)
Performs any necessary processing that should be done before the Directory Server parses the elements of a modify request. |
PluginResult.PreParse |
doPreParse(PreParseSearchOperation searchOperation)
Performs any necessary processing that should be done before the Directory Server parses the elements of a search request. |
PluginResult.PreParse |
doPreParse(PreParseUnbindOperation unbindOperation)
Performs any necessary processing that should be done before the Directory Server parses the elements of an unbind request. |
void |
doShutdown(Message reason)
Performs any processing that should be done when the Directory Server is in the process of performing a graceful shutdown. |
PluginResult.Startup |
doStartup()
Performs any processing that should be done when the Directory Server is in the process of starting. |
void |
finalizePlugin()
Performs any necessary finalization for this plugin. |
DN |
getPluginEntryDN()
Retrieves the DN of the configuration entry for this plugin. |
java.util.Set<PluginType> |
getPluginTypes()
Retrieves the plugin types for which this plugin is registered. |
void |
initializeInternal(PluginCfg configuration,
java.util.Set<PluginType> pluginTypes)
Performs any initialization that should be done for all types of plugins regardless of type. |
abstract void |
initializePlugin(java.util.Set<PluginType> pluginTypes,
T configuration)
Performs any initialization necessary for this plugin. |
boolean |
invokeForInternalOperations()
Indicates whether this plugin should be invoked for internal operations. |
boolean |
isConfigurationAcceptable(PluginCfg configuration,
java.util.List<Message> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this plugin. |
PluginResult.IntermediateResponse |
processIntermediateResponse(IntermediateResponse intermediateResponse)
Performs any necessary processing that should be done before an intermediate response message is sent to a client. |
PluginResult.IntermediateResponse |
processSearchEntry(SearchEntrySearchOperation searchOperation,
SearchResultEntry searchEntry)
Performs any necessary processing that should be done before a search result entry is sent to a client. |
PluginResult.IntermediateResponse |
processSearchReference(SearchReferenceSearchOperation searchOperation,
SearchResultReference searchReference)
Performs any necessary processing that should be done before a search result reference is sent to a client. |
PluginResult.SubordinateModifyDN |
processSubordinateModifyDN(SubordinateModifyDNOperation modifyDNOperation,
Entry oldEntry,
Entry newEntry,
java.util.List<Modification> modifications)
Performs any necessary processing that should be done whenever a subordinate entry is moved or renamed as part of a modify DN operation. |
void |
setInvokeForInternalOperations(boolean invokeForInternalOps)
Specifies whether this plugin should be invoked for internal operations. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected DirectoryServerPlugin()
super()
as its first action.
Method Detail |
---|
public boolean isConfigurationAcceptable(PluginCfg configuration, java.util.List<Message> unacceptableReasons)
configuration
- The plugin configuration for which
to make the determination.unacceptableReasons
- A list that may be used to hold the
reasons that the provided
configuration is not acceptable.
true
if the provided configuration is acceptable
for this plugin, or false
if not.@PublicAPI(stability=PRIVATE, mayInstantiate=false, mayExtend=false, mayInvoke=false) public final void initializeInternal(PluginCfg configuration, java.util.Set<PluginType> pluginTypes)
configuration
- The configuration for this plugin.pluginTypes
- The set of plugin types for which this
plugin is registered.public abstract void initializePlugin(java.util.Set<PluginType> pluginTypes, T configuration) throws ConfigException, InitializationException
pluginTypes
- The set of plugin types that indicate the
ways in which this plugin will be invoked.configuration
- The configuration for this plugin.
ConfigException
- If the provided entry does not contain
a valid configuration for this plugin.
InitializationException
- If a problem occurs while
initializing the plugin that is
not related to the server
configuration.public void finalizePlugin()
public final DN getPluginEntryDN()
public final java.util.Set<PluginType> getPluginTypes()
public final boolean invokeForInternalOperations()
true
if this plugin should be invoked for
internal operations, or false
if not.@PublicAPI(stability=PRIVATE, mayInstantiate=false, mayExtend=false, mayInvoke=false) public final void setInvokeForInternalOperations(boolean invokeForInternalOps)
invokeForInternalOps
- Indicates whether this plugin
should be invoked for internal
operations.public PluginResult.Startup doStartup()
public void doShutdown(Message reason)
reason
- The human-readable reason for the shutdown.public PluginResult.PostConnect doPostConnect(ClientConnection clientConnection)
clientConnection
- The client connection that has been
accepted.
public PluginResult.PostDisconnect doPostDisconnect(ClientConnection clientConnection, DisconnectReason disconnectReason, Message message)
clientConnection
- The client connection that has been
closed.disconnectReason
- The disconnect reason for the closure.message
- A message providing additional
information about the closure, or
null
if there is none.
public PluginResult.ImportLDIF doLDIFImport(LDIFImportConfig importConfig, Entry entry)
importConfig
- The configuration used for the LDIF import.entry
- The entry that has been read to the LDIF
file.
public PluginResult.ImportLDIF doLDIFExport(LDIFExportConfig exportConfig, Entry entry)
exportConfig
- The configuration used for the LDIF export.entry
- The entry to be written to the LDIF file.
public PluginResult.PreParse doPreParse(PreParseAbandonOperation abandonOperation)
abandonOperation
- The abandon operation that has been
requested.
public PluginResult.PostOperation doPostOperation(PostOperationAbandonOperation abandonOperation)
abandonOperation
- The abandon operation for which
processing has completed.
public PluginResult.PreParse doPreParse(PreParseAddOperation addOperation) throws CanceledOperationException
addOperation
- The add operation that has been requested.
CanceledOperationException
- if this operation should
be cancelled.public PluginResult.PreOperation doPreOperation(PreOperationAddOperation addOperation) throws CanceledOperationException
addOperation
- The add operation to be processed.
CanceledOperationException
- if this operation should
be cancelled.public PluginResult.PostOperation doPostOperation(PostOperationAddOperation addOperation)
addOperation
- The add operation for which processing has
completed but no response has yet been
sent.
public PluginResult.PostResponse doPostResponse(PostResponseAddOperation addOperation)
addOperation
- The add operation for which processing has
completed and the response has been sent to
the client.
public void doPostSynchronization(PostSynchronizationAddOperation addOperation)
addOperation
- The synchronized add operation for which
processing has been completed.public PluginResult.PreParse doPreParse(PreParseBindOperation bindOperation)
bindOperation
- The bind operation that has been
requested.
public PluginResult.PreOperation doPreOperation(PreOperationBindOperation bindOperation)
bindOperation
- The bind operation to be processed.
public PluginResult.PostOperation doPostOperation(PostOperationBindOperation bindOperation)
bindOperation
- The bind operation for which processing
has completed but no response has yet been
sent.
public PluginResult.PostResponse doPostResponse(PostResponseBindOperation bindOperation)
bindOperation
- The bind operation for which processing
has completed and the response has been
sent to the client.
public PluginResult.PreParse doPreParse(PreParseCompareOperation compareOperation) throws CanceledOperationException
compareOperation
- The compare operation that has been
requested.
CanceledOperationException
- if this operation should
be cancelled.public PluginResult.PreOperation doPreOperation(PreOperationCompareOperation compareOperation) throws CanceledOperationException
compareOperation
- The compare operation to be processed.
CanceledOperationException
- if this operation should
be cancelled.public PluginResult.PostOperation doPostOperation(PostOperationCompareOperation compareOperation)
compareOperation
- The compare operation for which
processing has completed but no
response has yet been sent.
public PluginResult.PostResponse doPostResponse(PostResponseCompareOperation compareOperation)
compareOperation
- The compare operation for which
processing has completed and the
response has been sent to the client.
public PluginResult.PreParse doPreParse(PreParseDeleteOperation deleteOperation) throws CanceledOperationException
deleteOperation
- The delete operation that has been
requested.
CanceledOperationException
- if this operation should
be cancelled.public PluginResult.PreOperation doPreOperation(PreOperationDeleteOperation deleteOperation) throws CanceledOperationException
deleteOperation
- The delete operation to be processed.
CanceledOperationException
- if this operation should
be cancelled.public PluginResult.PostOperation doPostOperation(PostOperationDeleteOperation deleteOperation)
deleteOperation
- The delete operation for which
processing has completed but no
response has yet been sent.
public PluginResult.PostResponse doPostResponse(PostResponseDeleteOperation deleteOperation)
deleteOperation
- The delete operation for which
processing has completed and the
response has been sent to the client.
public void doPostSynchronization(PostSynchronizationDeleteOperation deleteOperation)
deleteOperation
- The synchronized delete operation for
which processing has been completed.public PluginResult.PreParse doPreParse(PreParseExtendedOperation extendedOperation) throws CanceledOperationException
extendedOperation
- The extended operation that has been
requested.
CanceledOperationException
- if this operation should
be cancelled.public PluginResult.PreOperation doPreOperation(PreOperationExtendedOperation extendedOperation) throws CanceledOperationException
extendedOperation
- The extended operation to be
processed.
CanceledOperationException
- if this operation should
be cancelled.public PluginResult.PostOperation doPostOperation(PostOperationExtendedOperation extendedOperation)
extendedOperation
- The extended operation for which
processing has completed but no
response has yet been sent.
public PluginResult.PostResponse doPostResponse(PostResponseExtendedOperation extendedOperation)
extendedOperation
- The extended operation for which
processing has completed and the
response has been sent to the client.
public PluginResult.PreParse doPreParse(PreParseModifyOperation modifyOperation) throws CanceledOperationException
modifyOperation
- The modify operation that has been
requested.
CanceledOperationException
- if this operation should
be cancelled.public PluginResult.PreOperation doPreOperation(PreOperationModifyOperation modifyOperation) throws CanceledOperationException
modifyOperation
- The modify operation to be processed.
CanceledOperationException
- if this operation should
be cancelled.public PluginResult.PostOperation doPostOperation(PostOperationModifyOperation modifyOperation)
modifyOperation
- The modify operation for which
processing has completed but no response
has yet been sent.
public PluginResult.PostResponse doPostResponse(PostResponseModifyOperation modifyOperation)
modifyOperation
- The modify operation for which
processing has completed and the
response has been sent to the client.
public void doPostSynchronization(PostSynchronizationModifyOperation modifyOperation)
modifyOperation
- The synchronized modify operation for
which processing has been completed.public PluginResult.PreParse doPreParse(PreParseModifyDNOperation modifyDNOperation) throws CanceledOperationException
modifyDNOperation
- The modify DN operation that has been
requested.
CanceledOperationException
- if this operation should
be cancelled.public PluginResult.PreOperation doPreOperation(PreOperationModifyDNOperation modifyDNOperation) throws CanceledOperationException
modifyDNOperation
- The modify DN operation to be
processed.
CanceledOperationException
- if this operation should
be cancelled.public PluginResult.SubordinateModifyDN processSubordinateModifyDN(SubordinateModifyDNOperation modifyDNOperation, Entry oldEntry, Entry newEntry, java.util.List<Modification> modifications)
modifyDNOperation
- The modify DN operation with which the
subordinate entry is associated.oldEntry
- The subordinate entry prior to the
move/rename operation.newEntry
- The subordinate enry after the
move/rename operation.modifications
- A list into which any modifications
made to the target entry should be
placed.
public PluginResult.PostOperation doPostOperation(PostOperationModifyDNOperation modifyDNOperation)
modifyDNOperation
- The modify DN operation for which
processing has completed but no
response has yet been sent.
public PluginResult.PostResponse doPostResponse(PostResponseModifyDNOperation modifyDNOperation)
modifyDNOperation
- The modifyDN operation for which
processing has completed and the
response has been sent to the client.
public void doPostSynchronization(PostSynchronizationModifyDNOperation modifyDNOperation)
modifyDNOperation
- The synchronized modify DN operation
for which processing has been
completed.public PluginResult.PreParse doPreParse(PreParseSearchOperation searchOperation) throws CanceledOperationException
searchOperation
- The search operation that has been
requested.
CanceledOperationException
- if this operation should
be cancelled.public PluginResult.PreOperation doPreOperation(PreOperationSearchOperation searchOperation) throws CanceledOperationException
searchOperation
- The search operation to be processed.
CanceledOperationException
- if this operation should
be cancelled.public PluginResult.IntermediateResponse processSearchEntry(SearchEntrySearchOperation searchOperation, SearchResultEntry searchEntry)
searchOperation
- The search operation with which the
search entry is associated.searchEntry
- The search result entry that is to be
sent to the client. Its contents may be
altered by the plugin if necessary.
public PluginResult.IntermediateResponse processSearchReference(SearchReferenceSearchOperation searchOperation, SearchResultReference searchReference)
searchOperation
- The search operation with which the
search result reference is associated.searchReference
- The search result reference that is to
be sent to the client. Its contents may
be altered by the plugin if necessary.
public PluginResult.PostOperation doPostOperation(PostOperationSearchOperation searchOperation)
searchOperation
- The search operation for which
processing has completed but no response
has yet been sent.
public PluginResult.PostResponse doPostResponse(PostResponseSearchOperation searchOperation)
searchOperation
- The search operation for which
processing has completed and the
response has been sent to the client.
public PluginResult.PreParse doPreParse(PreParseUnbindOperation unbindOperation)
unbindOperation
- The unbind operation that has been
requested.
public PluginResult.PostOperation doPostOperation(PostOperationUnbindOperation unbindOperation)
unbindOperation
- The unbind operation for which
processing has completed.
public PluginResult.IntermediateResponse processIntermediateResponse(IntermediateResponse intermediateResponse)
intermediateResponse
- The intermediate response to be
sent to the client.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |