com.unboundid.directory.sdk.proxy.internal.DirectoryProxyServerExtension Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of server-sdk Show documentation

The UnboundID Server SDK is a library that may be used to develop various types of extensions to Ping Identity server products, including the PingDirectory Server, PingDirectoryProxy Server, PingDataSync Server, PingDataMetrics Server, and PingAuthorize Server.

The newest version!

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at
 * docs/licenses/cddl.txt
 * or http://www.opensource.org/licenses/cddl1.php.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at
 * docs/licenses/cddl.txt.  If applicable,
 * add the following below this CDDL HEADER, with the fields enclosed
 * by brackets "[]" replaced with your own identifying information:
 *      Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 *
 *
 *      Portions Copyright 2010-2024 Ping Identity Corporation
 */
package com.unboundid.directory.sdk.proxy.internal;



import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;



/**
 * This annotation type may be used to indicate that the marked class represents
 * an API that can be used to create an extension for use in the Directory Proxy
 * Server (which may also be referred to as the ${PROXY_SERVER_BASE_NAME}).
 */
@Documented()
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE })
@Inherited()
public @interface DirectoryProxyServerExtension
{
  /**
   * Indicates whether this extension applies to content which exists locally
   * within the Directory Proxy Server (e.g., configuration or monitor data).
   *
   * @return {@code true} if extension applies to local content,
   *         {@code false} otherwise
   */
  boolean appliesToLocalContent();



  /**
   * Indicates whether this extension applies to remote content which exists
   * in backend servers.
   *
   * @return {@code true} if extension applies to remote content,
   *         {@code false} otherwise
   */
  boolean appliesToRemoteContent();



  /**
   * A set of notes about the usage of this API in the Directory Proxy Server.
   *
   * @return Notes about the usage of this API in the Directory Proxy Server
   */
  String notes() default "";
}