001    /*
002     * CDDL HEADER START
003     *
004     * The contents of this file are subject to the terms of the
005     * Common Development and Distribution License, Version 1.0 only
006     * (the "License").  You may not use this file except in compliance
007     * with the License.
008     *
009     * You can obtain a copy of the license at
010     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2006-2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.api;
028    
029    
030    
031    import org.opends.server.config.ConfigAttribute;
032    import org.opends.server.types.DirectoryException;
033    import org.opends.server.types.DN;
034    import org.opends.server.types.InvokableMethod;
035    
036    
037    
038    /**
039     * This class defines an interface that may be implemented by
040     * Directory Server components that have methods that may be invoked
041     * either via adding configuration entries (e.g., task plugins) or
042     * through JMX.
043     */
044    @org.opends.server.types.PublicAPI(
045         stability=org.opends.server.types.StabilityLevel.VOLATILE,
046         mayInstantiate=false,
047         mayExtend=true,
048         mayInvoke=false)
049    public interface InvokableComponent
050    {
051      /**
052       * Retrieves the DN of the configuration entry with which this
053       * component is associated.
054       *
055       * @return  The DN of the configuration entry with which this
056       *          component is associated.
057       */
058      public DN getInvokableComponentEntryDN();
059    
060    
061    
062      /**
063       * Retrieves a list of the methods that may be invoked for this
064       * component.
065       *
066       * @return  A list of the methods that may be invoked for this
067       *          component.
068       */
069      public InvokableMethod[] getOperationSignatures();
070    
071    
072    
073      /**
074       * Invokes the specified method with the provided arguments.
075       *
076       * @param  methodName  The name of the method to invoke.
077       * @param  arguments   The set of configuration attributes holding
078       *                     the arguments to use for the method.
079       *
080       * @return  The return value for the method, or {@code null} if it
081       *          did not return a value.
082       *
083       * @throws  DirectoryException  If there was no such method, or if
084       *                              an error occurred while attempting
085       *                              to invoke it.
086       */
087      public Object invokeMethod(String methodName,
088                                 ConfigAttribute[] arguments)
089             throws DirectoryException;
090    }
091