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-2013 UnboundID Corp.
026     */
027    package com.unboundid.directory.sdk.proxy.internal;
028    
029    
030    
031    import java.lang.annotation.Documented;
032    import java.lang.annotation.ElementType;
033    import java.lang.annotation.Retention;
034    import java.lang.annotation.RetentionPolicy;
035    import java.lang.annotation.Target;
036    
037    
038    
039    /**
040     * This annotation type may be used to indicate that the marked class represents
041     * an API that can be used to create an extension for use in the Directory Proxy
042     * Server.
043     */
044    @Documented()
045    @Retention(RetentionPolicy.RUNTIME)
046    @Target({ ElementType.TYPE })
047    public @interface DirectoryProxyServerExtension
048    {
049      /**
050       * Indicates whether this extension applies to content which exists locally
051       * within the Directory Proxy Server (e.g., configuration or monitor data).
052       */
053      boolean appliesToLocalContent();
054    
055    
056    
057      /**
058       * Indicates whether this extension applies to remote content which exists
059       * in backend servers.
060       */
061      boolean appliesToRemoteContent();
062    
063    
064    
065      /**
066       * A set of notes about the usage of this API in the Directory Proxy Server.
067       */
068      String notes() default "";
069    }