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 * http://www.opensource.org/licenses/cddl1.php.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file. If applicable, add the following below this CDDL HEADER,
016 * with the fields enclosed by brackets "[]" replaced with your own
017 * identifying information:
018 *      Portions Copyright [yyyy] [name of copyright owner]
019 *
020 * CDDL HEADER END
021 *
022 *
023 *      Portions Copyright 2010-2024 Ping Identity Corporation
024 */
025package com.unboundid.directory.sdk.broker.internal;
026
027
028
029import java.lang.annotation.Documented;
030import java.lang.annotation.ElementType;
031import java.lang.annotation.Inherited;
032import java.lang.annotation.Retention;
033import java.lang.annotation.RetentionPolicy;
034import java.lang.annotation.Target;
035
036
037/**
038 * This annotation type may be used to indicate that the marked class represents
039 * an API that can be used to create an extension for use in the
040 * Ping Identity PingAuthorize Server.
041 */
042@Documented()
043@Retention(RetentionPolicy.RUNTIME)
044@Target({ ElementType.TYPE })
045@Inherited()
046public @interface BrokerExtension
047{
048  /**
049   * A set of notes about the usage of this API in the PingAuthorize Server.
050   *
051   * @return Notes about the usage of this API in the PingAuthorize Server
052   */
053  String notes() default "";
054}