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 * A marker annotation to indicate that the annotated class should be interpreted as an annotated CREST
026 * request handler.
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 create} for create methods.</li>
032 *     <li>{@code read} for read methods.</li>
033 *     <li>{@code update} for update methods.</li>
034 *     <li>{@code delete} for delete methods.</li>
035 *     <li>{@code patch} for patch methods.</li>
036 *     <li>{@code query} for query methods.</li>
037 * </ul>
038 * Note that action methods do not have a convention and MUST be annotated using the {@link Action} annotation.
039 *
040 * @see Create
041 * @see Read
042 * @see Update
043 * @see Delete
044 * @see Patch
045 * @see Action
046 * @see Query
047 * @see Queries
048 */
049@Retention(RetentionPolicy.RUNTIME)
050@Target(ElementType.TYPE)
051public @interface RequestHandler {
052    /** The details of the handler. */
053    Handler value();
054}