/*
|
* The contents of this file are subject to the terms of the Common Development and
|
* Distribution License (the License). You may not use this file except in compliance with the
|
* License.
|
*
|
* You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
|
* specific language governing permission and limitations under the License.
|
*
|
* When distributing Covered Software, include this CDDL Header Notice in each file and include
|
* the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
|
* Header, with the fields enclosed by brackets [] replaced by your own identifying
|
* information: "Portions Copyright [year] [name of copyright owner]".
|
*
|
* Copyright 2006-2008 Sun Microsystems, Inc.
|
* Portions Copyright 2015-2016 ForgeRock AS.
|
*/
|
package org.opends.server.api;
|
|
|
|
import org.opends.server.config.ConfigAttribute;
|
import org.opends.server.types.DirectoryException;
|
import org.forgerock.opendj.ldap.DN;
|
import org.opends.server.types.InvokableMethod;
|
|
|
|
/**
|
* 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.
|
*/
|
@org.opends.server.types.PublicAPI(
|
stability=org.opends.server.types.StabilityLevel.VOLATILE,
|
mayInstantiate=false,
|
mayExtend=true,
|
mayInvoke=false)
|
public interface InvokableComponent
|
{
|
/**
|
* Retrieves the DN of the configuration entry with which this
|
* component is associated.
|
*
|
* @return The DN of the configuration entry with which this
|
* component is associated.
|
*/
|
DN getInvokableComponentEntryDN();
|
|
|
|
/**
|
* Retrieves a list of the methods that may be invoked for this
|
* component.
|
*
|
* @return A list of the methods that may be invoked for this
|
* component.
|
*/
|
InvokableMethod[] getOperationSignatures();
|
|
|
|
/**
|
* Invokes the specified method with the provided arguments.
|
*
|
* @param methodName The name of the method to invoke.
|
* @param arguments The set of configuration attributes holding
|
* the arguments to use for the method.
|
*
|
* @return The return value for the method, or {@code 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.
|
*/
|
Object invokeMethod(String methodName, ConfigAttribute[] arguments)
|
throws DirectoryException;
|
}
|
