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 ForgeRock AS. 015 */ 016 017package org.forgerock.json.resource.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.json.resource.QueryResourceHandler; 025 026/** 027 * Indicates an CREST query method on a {@link RequestHandler}-annotated POJO. This annotation can only be used on 028 * collection resource request handlers. 029 * <p> 030 * The annotated method's return type must be: 031 * <ul> 032 * <li>A {@code Promise<QueryResponse, ? extends ResourceException>} promise.</li> 033 * </ul> 034 * The method must take the following parameters: 035 * <ul> 036 * <li>A {@link QueryResourceHandler} for the results of the query.</li> 037 * <li>A {@link org.forgerock.json.resource.QueryRequest} 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 */ 044@Retention(RetentionPolicy.RUNTIME) 045@Target(ElementType.METHOD) 046public @interface Query { 047}