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     * docs/licenses/cddl.txt
011     * or http://www.opensource.org/licenses/cddl1.php.
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     * docs/licenses/cddl.txt.  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 2010-2014 UnboundID Corp.
026     */
027    package com.unboundid.directory.sdk.common.internal;
028    
029    
030    
031    import com.unboundid.util.NotExtensible;
032    import com.unboundid.util.ThreadSafety;
033    import com.unboundid.util.ThreadSafetyLevel;
034    
035    
036    
037    /**
038     * This interface is used to mark classes which may be extensions to UnboundID
039     * products.
040     */
041    @NotExtensible()
042    @ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
043    public interface UnboundIDExtension
044    {
045      /**
046       * Retrieves a human-readable name for this extension.
047       *
048       * @return  A human-readable name for this extension.
049       */
050      String getExtensionName();
051    
052    
053    
054      /**
055       * Retrieves a human-readable description for this extension.  Each element
056       * of the array that is returned will be considered a separate paragraph in
057       * generated documentation.
058       *
059       * @return  A human-readable description for this extension, or {@code null}
060       *          or an empty array if no description should be available.
061       */
062      String[] getExtensionDescription();
063    }