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 import org.forgerock.api.enums.CreateMode;
25 import org.forgerock.api.enums.CreateSingleton;
26
27 /**
28 * Indicates an CREST create method on an annotated POJO. This annotation can only be used on
29 * collection resource request handlers.
30 * <p>
31 * The annotated method's return type must be:
32 * <ul>
33 * <li>A {@code Promise<JsonValue, ? extends ResourceException>} promise.</li>
34 * </ul>
35 * The method must take the following parameters:
36 * <ul>
37 * <li>A {@code org.forgerock.json.resource.CreateRequest} for the request.</li>
38 * </ul>
39 * The method may also take the following parameters:
40 * <ul>
41 * <li>A {@link org.forgerock.services.context.Context} to be given the context.</li>
42 * </ul>
43 * @see RequestHandler
44 * @see SingletonProvider
45 * @see CollectionProvider
46 */
47 @Retention(RetentionPolicy.RUNTIME)
48 @Target(ElementType.METHOD)
49 public @interface Create {
50 /** Describe the standard operation details of this action. */
51 Operation operationDescription();
52 /**
53 * Specify the types of create request that are supported. By default, both ID_FROM_CLIENT (POST-to-collection type)
54 * and ID_FROM_SERVER (PUT-to-instance type) are supported.
55 */
56 CreateMode[] modes() default { CreateMode.ID_FROM_CLIENT, CreateMode.ID_FROM_SERVER };
57 /**
58 * Specify whether or not the created resource is a singleton or one of a collection. By default this will be
59 * worked out from the context, and should rarely have to be set to anything different.
60 */
61 CreateSingleton singleton() default CreateSingleton.FROM_CONTEXT;
62 }