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 2015-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 * Indicates an CREST read method on an annotated POJO. This annotation can be used on
26 * methods in both singleton and collection resource request handlers.
27 * <p>
28 * The annotated method's return type must be:
29 * <ul>
30 * <li>A {@code Promise<Resource, ? extends ResourceException>} promise.</li>
31 * </ul>
32 * If the annotated method is on a collection handler, it must take the following parameters:
33 * <ul>
34 * <li>A string parameter for the instance identifier.</li>
35 * </ul>
36 * The method may also take the following parameters:
37 * <ul>
38 * <li>A {@link org.forgerock.services.context.Context} to be given the context.</li>
39 * <li>A {@code org.forgerock.json.resource.ReadRequest} to be given the request.</li>
40 * </ul>
41 * @see RequestHandler
42 * @see SingletonProvider
43 * @see CollectionProvider
44 */
45 @Retention(RetentionPolicy.RUNTIME)
46 @Target(ElementType.METHOD)
47 public @interface Read {
48 /** Describe the standard operation details of this action. */
49 Operation operationDescription();
50 }