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 2015-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 * Indicates an CREST read method on an annotated POJO. This annotation can be used on
026 * methods in both singleton and collection resource request handlers.
027 * <p>
028 * The annotated method's return type must be:
029 * <ul>
030 *     <li>A {@code Promise<Resource, ? extends ResourceException>} promise.</li>
031 * </ul>
032 * If the annotated method is on a collection handler, it must take the following parameters:
033 * <ul>
034 *     <li>A string parameter for the instance identifier.</li>
035 * </ul>
036 * The method may also take the following parameters:
037 * <ul>
038 *     <li>A {@link org.forgerock.services.context.Context} to be given the context.</li>
039 *     <li>A {@code org.forgerock.json.resource.ReadRequest} to be given the request.</li>
040 * </ul>
041 * @see RequestHandler
042 * @see SingletonProvider
043 * @see CollectionProvider
044 */
045@Retention(RetentionPolicy.RUNTIME)
046@Target(ElementType.METHOD)
047public @interface Read {
048    /** Describe the standard operation details of this action. */
049    Operation operationDescription();
050}