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 static org.forgerock.api.enums.PatchOperation.*;
20
21 import java.lang.annotation.ElementType;
22 import java.lang.annotation.Retention;
23 import java.lang.annotation.RetentionPolicy;
24 import java.lang.annotation.Target;
25
26 import org.forgerock.api.enums.PatchOperation;
27
28 /**
29 * Indicates an CREST patch method on an annotated POJO. This annotation can be used on
30 * methods in both singleton and collection resource request handlers.
31 * <p>
32 * The annotated method's return type must be:
33 * <ul>
34 * <li>A {@code Promise<Resource, ? extends ResourceException>} promise.</li>
35 * </ul>
36 * The method must take the following parameters:
37 * <ul>
38 * <li>A {@code org.forgerock.json.resource.PatchRequest} to be given the request.</li>
39 * </ul>
40 * If the annotated method is on a collection handler, it must also take the following parameters:
41 * <ul>
42 * <li>A string parameter for the instance identifier.</li>
43 * </ul>
44 * The method may also take the following parameters:
45 * <ul>
46 * <li>A {@link org.forgerock.services.context.Context} to be given the context.</li>
47 * </ul>
48 * @see RequestHandler
49 * @see SingletonProvider
50 * @see CollectionProvider
51 */
52 @Retention(RetentionPolicy.RUNTIME)
53 @Target(ElementType.METHOD)
54 public @interface Patch {
55 /** Describe the standard operation details of this action. */
56 Operation operationDescription();
57 /** The set of patch operations supported by this request handler. By default, all are supported. */
58 PatchOperation[] operations() default { ADD, REMOVE, REPLACE, INCREMENT, MOVE, COPY, TRANSFORM };
59 }