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