org.opends.server.api
Interface InvokableComponent


@PublicAPI(stability=VOLATILE,
           mayInstantiate=false,
           mayExtend=true,
           mayInvoke=false)
public interface InvokableComponent

This class defines an interface that may be implemented by Directory Server components that have methods that may be invoked either via adding configuration entries (e.g., task plugins) or through JMX.


Method Summary
 DN getInvokableComponentEntryDN()
          Retrieves the DN of the configuration entry with which this component is associated.
 InvokableMethod[] getOperationSignatures()
          Retrieves a list of the methods that may be invoked for this component.
 java.lang.Object invokeMethod(java.lang.String methodName, ConfigAttribute[] arguments)
          Invokes the specified method with the provided arguments.
 

Method Detail

getInvokableComponentEntryDN

DN getInvokableComponentEntryDN()
Retrieves the DN of the configuration entry with which this component is associated.

Returns:
The DN of the configuration entry with which this component is associated.

getOperationSignatures

InvokableMethod[] getOperationSignatures()
Retrieves a list of the methods that may be invoked for this component.

Returns:
A list of the methods that may be invoked for this component.

invokeMethod

java.lang.Object invokeMethod(java.lang.String methodName,
                              ConfigAttribute[] arguments)
                              throws DirectoryException
Invokes the specified method with the provided arguments.

Parameters:
methodName - The name of the method to invoke.
arguments - The set of configuration attributes holding the arguments to use for the method.
Returns:
The return value for the method, or null if it did not return a value.
Throws:
DirectoryException - If there was no such method, or if an error occurred while attempting to invoke it.