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 static org.forgerock.api.enums.PatchOperation.*;
020
021import java.lang.annotation.ElementType;
022import java.lang.annotation.Retention;
023import java.lang.annotation.RetentionPolicy;
024import java.lang.annotation.Target;
025
026import org.forgerock.api.enums.PatchOperation;
027
028/**
029 * Indicates an CREST patch method on an annotated POJO. This annotation can be used on
030 * methods in both singleton and collection resource request handlers.
031 * <p>
032 * The annotated method's return type must be:
033 * <ul>
034 *     <li>A {@code Promise<Resource, ? extends ResourceException>} promise.</li>
035 * </ul>
036 * The method must take the following parameters:
037 * <ul>
038 *     <li>A {@code org.forgerock.json.resource.PatchRequest} to be given the request.</li>
039 * </ul>
040 * If the annotated method is on a collection handler, it must also take the following parameters:
041 * <ul>
042 *     <li>A string parameter for the instance identifier.</li>
043 * </ul>
044 * The method may also take the following parameters:
045 * <ul>
046 *     <li>A {@link org.forgerock.services.context.Context} to be given the context.</li>
047 * </ul>
048 * @see RequestHandler
049 * @see SingletonProvider
050 * @see CollectionProvider
051 */
052@Retention(RetentionPolicy.RUNTIME)
053@Target(ElementType.METHOD)
054public @interface Patch {
055    /** Describe the standard operation details of this action. */
056    Operation operationDescription();
057    /** The set of patch operations supported by this request handler. By default, all are supported. */
058    PatchOperation[] operations() default { ADD, REMOVE, REPLACE, INCREMENT, MOVE, COPY, TRANSFORM };
059}