Package org.opends.server.api.plugin
Enum PluginType
- java.lang.Object
-
- java.lang.Enum<PluginType>
-
- org.opends.server.api.plugin.PluginType
-
- All Implemented Interfaces:
Serializable
,Comparable<PluginType>
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public enum PluginType extends Enum<PluginType>
This class defines an enumeration containing the types of plugins that are supported for use in the Directory Server.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description INITIALIZATION
The plugin type for plugins that are invoked at the initialization of the Directory server.INTERMEDIATE_RESPONSE
The plugin type for plugins that are to be invoked before each intermediate response message is sent to a client.LDIF_IMPORT
The plugin type for plugins that are to be invoked for each entry read during an LDIF import.LDIF_IMPORT_BEGIN
The plugin type for plugins that are to be invoked for each import session beginning.LDIF_IMPORT_END
The plugin type for plugins that are to be invoked for each import session end.POST_CONNECT
The plugin type for plugins that are to be invoked whenever a new client connection is established.POST_DISCONNECT
The plugin type for plugins that are to be invoked whenever a client connection is closed.POST_OPERATION_ABANDON
The plugin type for plugins that are to be invoked just after the core processing for an abandon operation.POST_OPERATION_ADD
The plugin type for plugins that are to be invoked just after the core processing for an add operation.POST_OPERATION_BIND
The plugin type for plugins that are to be invoked just after the core processing for a bind operation.POST_OPERATION_COMPARE
The plugin type for plugins that are to be invoked just after the core processing for a compare operation.POST_OPERATION_DELETE
The plugin type for plugins that are to be invoked just after the core processing for a delete operation.POST_OPERATION_EXTENDED
The plugin type for plugins that are to be invoked just after the core processing for an extended operation.POST_OPERATION_MODIFY
The plugin type for plugins that are to be invoked just after the core processing for a modify operation.POST_OPERATION_MODIFY_DN
The plugin type for plugins that are to be invoked just after the core processing for a modify DN operation.POST_OPERATION_SEARCH
The plugin type for plugins that are to be invoked just after the core processing for a search operation.POST_OPERATION_UNBIND
The plugin type for plugins that are to be invoked just after the core processing for an unbind operation.POST_RESPONSE_ADD
The plugin type for plugins that are to be invoked just after the response is sent for an add operation.POST_RESPONSE_BIND
The plugin type for plugins that are to be invoked just after the response is sent for a bind operation.POST_RESPONSE_COMPARE
The plugin type for plugins that are to be invoked just after the response is sent for a compare operation.POST_RESPONSE_DELETE
The plugin type for plugins that are to be invoked just after the response is sent for a delete operation.POST_RESPONSE_EXTENDED
The plugin type for plugins that are to be invoked just after the response is sent for an extended operation.POST_RESPONSE_MODIFY
The plugin type for plugins that are to be invoked just after the response is sent for a modify operation.POST_RESPONSE_MODIFY_DN
The plugin type for plugins that are to be invoked just after the response is sent for a modify DN operation.POST_RESPONSE_SEARCH
The plugin type for plugins that are to be invoked just after the response is sent for a search operation.POST_SYNCHRONIZATION_ADD
The plugin type for plugins that are to be invoked just after an add operation has been completed via synchronization.POST_SYNCHRONIZATION_DELETE
The plugin type for plugins that are to be invoked just after a delete operation has been completed via synchronization.POST_SYNCHRONIZATION_MODIFY
The plugin type for plugins that are to be invoked just after a modify operation has been completed via synchronization.POST_SYNCHRONIZATION_MODIFY_DN
The plugin type for plugins that are to be invoked just after a modify DN operation has been completed via synchronization.PRE_OPERATION_ADD
The plugin type for plugins that are to be invoked just before the core processing for an add operation.PRE_OPERATION_BIND
The plugin type for plugins that are to be invoked just before the core processing for a bind operation.PRE_OPERATION_COMPARE
The plugin type for plugins that are to be invoked just before the core processing for a compare operation.PRE_OPERATION_DELETE
The plugin type for plugins that are to be invoked just before the core processing for a delete operation.PRE_OPERATION_EXTENDED
The plugin type for plugins that are to be invoked just before the core processing for an extended operation.PRE_OPERATION_MODIFY
The plugin type for plugins that are to be invoked just before the core processing for a modify operation.PRE_OPERATION_MODIFY_DN
The plugin type for plugins that are to be invoked just before the core processing for a modify DN operation.PRE_OPERATION_SEARCH
The plugin type for plugins that are to be invoked just before the core processing for a search operation.PRE_PARSE_ABANDON
The plugin type for plugins that are to be invoked before processing begins on an abandon operation.PRE_PARSE_ADD
The plugin type for plugins that are to be invoked before processing begins on an add operation.PRE_PARSE_BIND
The plugin type for plugins that are to be invoked before processing begins on a bind operation.PRE_PARSE_COMPARE
The plugin type for plugins that are to be invoked before processing begins on a compare operation.PRE_PARSE_DELETE
The plugin type for plugins that are to be invoked before processing begins on a delete operation.PRE_PARSE_EXTENDED
The plugin type for plugins that are to be invoked before processing begins on an extended operation.PRE_PARSE_MODIFY
The plugin type for plugins that are to be invoked before processing begins on a modify operation.PRE_PARSE_MODIFY_DN
The plugin type for plugins that are to be invoked before processing begins on a modify DN operation.PRE_PARSE_SEARCH
The plugin type for plugins that are to be invoked before processing begins on a search operation.PRE_PARSE_UNBIND
The plugin type for plugins that are to be invoked before processing begins on an unbind operation.SEARCH_RESULT_ENTRY
The plugin type for plugins that are to be invoked before each search result entry is sent to a client.SEARCH_RESULT_REFERENCE
The plugin type for plugins that are to be invoked before each search result reference is sent to a client.SHUTDOWN
The plugin type for plugins that are invoked when the Directory Server is performing a graceful shutdown.STARTUP
The plugin type for plugins that are invoked when the Directory Server is starting up.SUBORDINATE_DELETE
The plugin type for plugins that are to be invoked on each subordinate entry that is deleted as part of a subtree delete operation.SUBORDINATE_MODIFY_DN
The plugin type for plugins that are to be invoked on each subordinate entry that is moved or renamed as part of a modify DN operation.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PluginType
forName(String lowerName)
Retrieves the plugin type for the plugin with the specified name.String
getName()
Retrieves the name for this plugin type.static Set<String>
getPluginTypeNames()
Retrieves a hash set containing the names of all the plugin types.String
toString()
Retrieves a string representation of this plugin type.static PluginType
valueOf(String name)
Returns the enum constant of this type with the specified name.static PluginType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
STARTUP
public static final PluginType STARTUP
The plugin type for plugins that are invoked when the Directory Server is starting up.
-
SHUTDOWN
public static final PluginType SHUTDOWN
The plugin type for plugins that are invoked when the Directory Server is performing a graceful shutdown.
-
INITIALIZATION
public static final PluginType INITIALIZATION
The plugin type for plugins that are invoked at the initialization of the Directory server.
-
POST_CONNECT
public static final PluginType POST_CONNECT
The plugin type for plugins that are to be invoked whenever a new client connection is established.
-
POST_DISCONNECT
public static final PluginType POST_DISCONNECT
The plugin type for plugins that are to be invoked whenever a client connection is closed.
-
LDIF_IMPORT
public static final PluginType LDIF_IMPORT
The plugin type for plugins that are to be invoked for each entry read during an LDIF import.
-
LDIF_IMPORT_END
public static final PluginType LDIF_IMPORT_END
The plugin type for plugins that are to be invoked for each import session end.
-
LDIF_IMPORT_BEGIN
public static final PluginType LDIF_IMPORT_BEGIN
The plugin type for plugins that are to be invoked for each import session beginning.
-
PRE_PARSE_ABANDON
public static final PluginType PRE_PARSE_ABANDON
The plugin type for plugins that are to be invoked before processing begins on an abandon operation.
-
PRE_PARSE_ADD
public static final PluginType PRE_PARSE_ADD
The plugin type for plugins that are to be invoked before processing begins on an add operation.
-
PRE_PARSE_BIND
public static final PluginType PRE_PARSE_BIND
The plugin type for plugins that are to be invoked before processing begins on a bind operation.
-
PRE_PARSE_COMPARE
public static final PluginType PRE_PARSE_COMPARE
The plugin type for plugins that are to be invoked before processing begins on a compare operation.
-
PRE_PARSE_DELETE
public static final PluginType PRE_PARSE_DELETE
The plugin type for plugins that are to be invoked before processing begins on a delete operation.
-
PRE_PARSE_EXTENDED
public static final PluginType PRE_PARSE_EXTENDED
The plugin type for plugins that are to be invoked before processing begins on an extended operation.
-
PRE_PARSE_MODIFY
public static final PluginType PRE_PARSE_MODIFY
The plugin type for plugins that are to be invoked before processing begins on a modify operation.
-
PRE_PARSE_MODIFY_DN
public static final PluginType PRE_PARSE_MODIFY_DN
The plugin type for plugins that are to be invoked before processing begins on a modify DN operation.
-
PRE_PARSE_SEARCH
public static final PluginType PRE_PARSE_SEARCH
The plugin type for plugins that are to be invoked before processing begins on a search operation.
-
PRE_PARSE_UNBIND
public static final PluginType PRE_PARSE_UNBIND
The plugin type for plugins that are to be invoked before processing begins on an unbind operation.
-
PRE_OPERATION_ADD
public static final PluginType PRE_OPERATION_ADD
The plugin type for plugins that are to be invoked just before the core processing for an add operation.
-
PRE_OPERATION_BIND
public static final PluginType PRE_OPERATION_BIND
The plugin type for plugins that are to be invoked just before the core processing for a bind operation.
-
PRE_OPERATION_COMPARE
public static final PluginType PRE_OPERATION_COMPARE
The plugin type for plugins that are to be invoked just before the core processing for a compare operation.
-
PRE_OPERATION_DELETE
public static final PluginType PRE_OPERATION_DELETE
The plugin type for plugins that are to be invoked just before the core processing for a delete operation.
-
PRE_OPERATION_EXTENDED
public static final PluginType PRE_OPERATION_EXTENDED
The plugin type for plugins that are to be invoked just before the core processing for an extended operation.
-
PRE_OPERATION_MODIFY
public static final PluginType PRE_OPERATION_MODIFY
The plugin type for plugins that are to be invoked just before the core processing for a modify operation.
-
PRE_OPERATION_MODIFY_DN
public static final PluginType PRE_OPERATION_MODIFY_DN
The plugin type for plugins that are to be invoked just before the core processing for a modify DN operation.
-
PRE_OPERATION_SEARCH
public static final PluginType PRE_OPERATION_SEARCH
The plugin type for plugins that are to be invoked just before the core processing for a search operation.
-
POST_OPERATION_ABANDON
public static final PluginType POST_OPERATION_ABANDON
The plugin type for plugins that are to be invoked just after the core processing for an abandon operation.
-
POST_OPERATION_ADD
public static final PluginType POST_OPERATION_ADD
The plugin type for plugins that are to be invoked just after the core processing for an add operation.
-
POST_OPERATION_BIND
public static final PluginType POST_OPERATION_BIND
The plugin type for plugins that are to be invoked just after the core processing for a bind operation.
-
POST_OPERATION_COMPARE
public static final PluginType POST_OPERATION_COMPARE
The plugin type for plugins that are to be invoked just after the core processing for a compare operation.
-
POST_OPERATION_DELETE
public static final PluginType POST_OPERATION_DELETE
The plugin type for plugins that are to be invoked just after the core processing for a delete operation.
-
POST_OPERATION_EXTENDED
public static final PluginType POST_OPERATION_EXTENDED
The plugin type for plugins that are to be invoked just after the core processing for an extended operation.
-
POST_OPERATION_MODIFY
public static final PluginType POST_OPERATION_MODIFY
The plugin type for plugins that are to be invoked just after the core processing for a modify operation.
-
POST_OPERATION_MODIFY_DN
public static final PluginType POST_OPERATION_MODIFY_DN
The plugin type for plugins that are to be invoked just after the core processing for a modify DN operation.
-
POST_OPERATION_SEARCH
public static final PluginType POST_OPERATION_SEARCH
The plugin type for plugins that are to be invoked just after the core processing for a search operation.
-
POST_OPERATION_UNBIND
public static final PluginType POST_OPERATION_UNBIND
The plugin type for plugins that are to be invoked just after the core processing for an unbind operation.
-
POST_RESPONSE_ADD
public static final PluginType POST_RESPONSE_ADD
The plugin type for plugins that are to be invoked just after the response is sent for an add operation.
-
POST_RESPONSE_BIND
public static final PluginType POST_RESPONSE_BIND
The plugin type for plugins that are to be invoked just after the response is sent for a bind operation.
-
POST_RESPONSE_COMPARE
public static final PluginType POST_RESPONSE_COMPARE
The plugin type for plugins that are to be invoked just after the response is sent for a compare operation.
-
POST_RESPONSE_DELETE
public static final PluginType POST_RESPONSE_DELETE
The plugin type for plugins that are to be invoked just after the response is sent for a delete operation.
-
POST_RESPONSE_EXTENDED
public static final PluginType POST_RESPONSE_EXTENDED
The plugin type for plugins that are to be invoked just after the response is sent for an extended operation.
-
POST_RESPONSE_MODIFY
public static final PluginType POST_RESPONSE_MODIFY
The plugin type for plugins that are to be invoked just after the response is sent for a modify operation.
-
POST_RESPONSE_MODIFY_DN
public static final PluginType POST_RESPONSE_MODIFY_DN
The plugin type for plugins that are to be invoked just after the response is sent for a modify DN operation.
-
POST_RESPONSE_SEARCH
public static final PluginType POST_RESPONSE_SEARCH
The plugin type for plugins that are to be invoked just after the response is sent for a search operation.
-
POST_SYNCHRONIZATION_ADD
public static final PluginType POST_SYNCHRONIZATION_ADD
The plugin type for plugins that are to be invoked just after an add operation has been completed via synchronization.
-
POST_SYNCHRONIZATION_DELETE
public static final PluginType POST_SYNCHRONIZATION_DELETE
The plugin type for plugins that are to be invoked just after a delete operation has been completed via synchronization.
-
POST_SYNCHRONIZATION_MODIFY
public static final PluginType POST_SYNCHRONIZATION_MODIFY
The plugin type for plugins that are to be invoked just after a modify operation has been completed via synchronization.
-
POST_SYNCHRONIZATION_MODIFY_DN
public static final PluginType POST_SYNCHRONIZATION_MODIFY_DN
The plugin type for plugins that are to be invoked just after a modify DN operation has been completed via synchronization.
-
SEARCH_RESULT_ENTRY
public static final PluginType SEARCH_RESULT_ENTRY
The plugin type for plugins that are to be invoked before each search result entry is sent to a client.
-
SEARCH_RESULT_REFERENCE
public static final PluginType SEARCH_RESULT_REFERENCE
The plugin type for plugins that are to be invoked before each search result reference is sent to a client.
-
SUBORDINATE_MODIFY_DN
public static final PluginType SUBORDINATE_MODIFY_DN
The plugin type for plugins that are to be invoked on each subordinate entry that is moved or renamed as part of a modify DN operation.
-
SUBORDINATE_DELETE
public static final PluginType SUBORDINATE_DELETE
The plugin type for plugins that are to be invoked on each subordinate entry that is deleted as part of a subtree delete operation.
-
INTERMEDIATE_RESPONSE
public static final PluginType INTERMEDIATE_RESPONSE
The plugin type for plugins that are to be invoked before each intermediate response message is sent to a client.
-
-
Method Detail
-
values
public static PluginType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (PluginType c : PluginType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static PluginType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
getName
public String getName()
Retrieves the name for this plugin type.- Returns:
- The name for this plugin type.
-
toString
public String toString()
Retrieves a string representation of this plugin type.- Overrides:
toString
in classEnum<PluginType>
- Returns:
- A string representation of this plugin type.
-
getPluginTypeNames
public static Set<String> getPluginTypeNames()
Retrieves a hash set containing the names of all the plugin types.- Returns:
- A hash set containing the names of all the plugin types.
-
forName
public static PluginType forName(String lowerName)
Retrieves the plugin type for the plugin with the specified name.- Parameters:
lowerName
- The name of the plugin type to retrieve, formatted in all lowercase characters.- Returns:
- The requested plugin type, or
null
if there is no type for the provided name.
-
-