001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2016 ForgeRock AS.
015 */
016
017package org.forgerock.api.annotations;
018
019import java.lang.annotation.ElementType;
020import java.lang.annotation.Retention;
021import java.lang.annotation.RetentionPolicy;
022import java.lang.annotation.Target;
023
024/**
025 * A marker annotation to indicate that the annotated class should be interpreted as an annotated CREST
026 * singleton provider resource.
027 * <p>
028 * Individual operations can then be supported by either annotating a method with the relevant annotation, or
029 * by naming the method according to the following convention:
030 * <ul>
031 *     <li>{@code read} for read methods.</li>
032 *     <li>{@code update} for update methods.</li>
033 *     <li>{@code patch} for patch methods.</li>
034 * </ul>
035 * Note that action methods do not have a convention and MUST be annotated using the {@link Action} annotation.
036 *
037 * @see Read
038 * @see Update
039 * @see Patch
040 * @see Action
041 */
042@Retention(RetentionPolicy.RUNTIME)
043@Target(ElementType.TYPE)
044public @interface SingletonProvider {
045    /** The details of the handler. */
046    Handler value();
047}