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.CountPolicy;
025import org.forgerock.api.enums.PagingMode;
026import org.forgerock.api.enums.QueryType;
027
028/**
029 * Indicates an CREST query method on an annotated POJO. This annotation can only be used on
030 * collection resource request handlers.
031 * <p>
032 * The annotated method's return type must be:
033 * <ul>
034 *     <li>A {@code Promise<QueryResponse, ? extends ResourceException>} promise.</li>
035 * </ul>
036 * The method must take the following parameters:
037 * <ul>
038 *     <li>A {@code org.forgerock.json.resource.QueryResourceHandler} for the results of the query.</li>
039 *     <li>A {@code org.forgerock.json.resource.QueryRequest} for the request.</li>
040 * </ul>
041 * The method may also take the following parameters:
042 * <ul>
043 *     <li>A {@link org.forgerock.services.context.Context} to be given the context.</li>
044 * </ul>
045 * @see RequestHandler
046 * @see SingletonProvider
047 * @see CollectionProvider
048 */
049@Retention(RetentionPolicy.RUNTIME)
050@Target(ElementType.METHOD)
051public @interface Query {
052    /** Describe the standard operation details of this action. */
053    Operation operationDescription();
054    /** The type of query this method supports. */
055    QueryType type();
056    /** The paging modes that can be used with this query. */
057    PagingMode[] pagingModes() default {};
058    /**
059     * The count policies that can be used with this query.
060     * If the array is empty, this means that the query does not support any form of count policy,
061     * and no value for count policy should be specified
062     */
063    CountPolicy[] countPolicies() default {};
064    /**
065     * The query ID - required only when {@code type} is {@code ID}. If not supplied but required, the name of the
066     * annotated method is used.
067     */
068    String id() default "";
069    /** The set of fields that can be used in a query filter. Required only when the {@code type} is {@code FILTER}. */
070    String[] queryableFields() default {};
071    /** The keys that can be used to sort the results of the query. */
072    String[] sortKeys() default {};
073}