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
024import org.forgerock.api.enums.CreateMode;
025import org.forgerock.api.enums.CreateSingleton;
026
027/**
028 * Indicates an CREST create method on an annotated POJO. This annotation can only be used on
029 * collection resource request handlers.
030 * <p>
031 * The annotated method's return type must be:
032 * <ul>
033 *     <li>A {@code Promise<JsonValue, ? extends ResourceException>} promise.</li>
034 * </ul>
035 * The method must take the following parameters:
036 * <ul>
037 *     <li>A {@code org.forgerock.json.resource.CreateRequest} for the request.</li>
038 * </ul>
039 * The method may also take the following parameters:
040 * <ul>
041 *     <li>A {@link org.forgerock.services.context.Context} to be given the context.</li>
042 * </ul>
043 * @see RequestHandler
044 * @see SingletonProvider
045 * @see CollectionProvider
046 */
047@Retention(RetentionPolicy.RUNTIME)
048@Target(ElementType.METHOD)
049public @interface Create {
050    /** Describe the standard operation details of this action. */
051    Operation operationDescription();
052    /**
053     * Specify the types of create request that are supported. By default, both ID_FROM_CLIENT (POST-to-collection type)
054     * and ID_FROM_SERVER (PUT-to-instance type) are supported.
055     */
056    CreateMode[] modes() default { CreateMode.ID_FROM_CLIENT, CreateMode.ID_FROM_SERVER };
057    /**
058     * Specify whether or not the created resource is a singleton or one of a collection. By default this will be
059     * worked out from the context, and should rarely have to be set to anything different.
060     */
061    CreateSingleton singleton() default CreateSingleton.FROM_CONTEXT;
062}