org.apache.juneau.rest.annotation.HasQuery Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *
// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *
// * with the License. You may obtain a copy of the License at *
// * *
// * http://www.apache.org/licenses/LICENSE-2.0 *
// * *
// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
package org.apache.juneau.rest.annotation;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;
import java.lang.annotation.*;
import org.apache.juneau.rest.*;
/**
* Identical to {@link HasFormData @HasFormData}, but only checks the existing of the parameter in the URL string, not
* URL-encoded form posts.
*
*
* Unlike {@link HasFormData @HasFormData}, using this annotation does not result in the servlet reading the contents
* of URL-encoded form posts.
* Therefore, this annotation can be used in conjunction with the {@link Body @Body} annotation or
* {@link RestRequest#getBody()} method for application/x-www-form-urlencoded POST calls.
*
*
Example:
*
* @RestMethod (name=GET )
* public void doPost(@HasQuery ("p1" ) boolean p1, @Body Bean myBean) {
* ...
* }
*
*
*
* This is functionally equivalent to the following code...
*
* @RestMethod (name=GET )
* public void doGet(RestRequest req) {
* boolean p1 = req.hasQueryParameter("p1" );
* ...
* }
*
*/
@Documented
@Target(PARAMETER)
@Retention(RUNTIME)
@Inherited
public @interface HasQuery {
/**
* URL query parameter name.
*/
String name() default "";
/**
* A synonym for {@link #name()}.
*
*
* Allows you to use shortened notation if you're only specifying the name.
*/
String value() default "";
}