1 /*
2 * The contents of this file are subject to the terms of the Common Development and
3 * Distribution License (the License). You may not use this file except in compliance with the
4 * License.
5 *
6 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
7 * specific language governing permission and limitations under the License.
8 *
9 * When distributing Covered Software, include this CDDL Header Notice in each file and include
10 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
11 * Header, with the fields enclosed by brackets [] replaced by your own identifying
12 * information: "Portions copyright [year] [name of copyright owner]".
13 *
14 * Copyright 2016 ForgeRock AS.
15 */
16
17 package org.forgerock.api.annotations;
18
19 import java.lang.annotation.ElementType;
20 import java.lang.annotation.Retention;
21 import java.lang.annotation.RetentionPolicy;
22 import java.lang.annotation.Target;
23
24 /**
25 * A marker annotation to indicate that the annotated class should be interpreted as an annotated CREST
26 * singleton provider resource.
27 * <p>
28 * Individual operations can then be supported by either annotating a method with the relevant annotation, or
29 * by naming the method according to the following convention:
30 * <ul>
31 * <li>{@code read} for read methods.</li>
32 * <li>{@code update} for update methods.</li>
33 * <li>{@code patch} for patch methods.</li>
34 * </ul>
35 * Note that action methods do not have a convention and MUST be annotated using the {@link Action} annotation.
36 *
37 * @see Read
38 * @see Update
39 * @see Patch
40 * @see Action
41 */
42 @Retention(RetentionPolicy.RUNTIME)
43 @Target(ElementType.TYPE)
44 public @interface SingletonProvider {
45 /** The details of the handler. */
46 Handler value();
47 }