| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (18) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.juneau.http.annotation, annotation type: Content"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../javadoc.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">// ***************************************************************************************************************************</span> |
| <span class="source-line-no">002</span><span id="line-2">// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *</span> |
| <span class="source-line-no">003</span><span id="line-3">// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *</span> |
| <span class="source-line-no">004</span><span id="line-4">// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *</span> |
| <span class="source-line-no">005</span><span id="line-5">// * with the License. You may obtain a copy of the License at *</span> |
| <span class="source-line-no">006</span><span id="line-6">// * *</span> |
| <span class="source-line-no">007</span><span id="line-7">// * http://www.apache.org/licenses/LICENSE-2.0 *</span> |
| <span class="source-line-no">008</span><span id="line-8">// * *</span> |
| <span class="source-line-no">009</span><span id="line-9">// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *</span> |
| <span class="source-line-no">010</span><span id="line-10">// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *</span> |
| <span class="source-line-no">011</span><span id="line-11">// * specific language governing permissions and limitations under the License. *</span> |
| <span class="source-line-no">012</span><span id="line-12">// ***************************************************************************************************************************</span> |
| <span class="source-line-no">013</span><span id="line-13">package org.apache.juneau.http.annotation;</span> |
| <span class="source-line-no">014</span><span id="line-14"></span> |
| <span class="source-line-no">015</span><span id="line-15">import static java.lang.annotation.ElementType.*;</span> |
| <span class="source-line-no">016</span><span id="line-16">import static java.lang.annotation.RetentionPolicy.*;</span> |
| <span class="source-line-no">017</span><span id="line-17"></span> |
| <span class="source-line-no">018</span><span id="line-18">import java.lang.annotation.*;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import org.apache.juneau.annotation.*;</span> |
| <span class="source-line-no">021</span><span id="line-21">import org.apache.juneau.json.*;</span> |
| <span class="source-line-no">022</span><span id="line-22"></span> |
| <span class="source-line-no">023</span><span id="line-23">/**</span> |
| <span class="source-line-no">024</span><span id="line-24"> * REST request body annotation.</span> |
| <span class="source-line-no">025</span><span id="line-25"> *</span> |
| <span class="source-line-no">026</span><span id="line-26"> * <p></span> |
| <span class="source-line-no">027</span><span id="line-27"> * Identifies a POJO to be used as the body of an HTTP request.</span> |
| <span class="source-line-no">028</span><span id="line-28"> *</span> |
| <span class="source-line-no">029</span><span id="line-29"> * <p></span> |
| <span class="source-line-no">030</span><span id="line-30"> * Can be used in the following locations:</span> |
| <span class="source-line-no">031</span><span id="line-31"> * <ul></span> |
| <span class="source-line-no">032</span><span id="line-32"> * <li>Arguments and argument-types of server-side <ja>@RestOp</ja>-annotated methods.</span> |
| <span class="source-line-no">033</span><span id="line-33"> * <li>Arguments and argument-types of client-side <ja>@RemoteOp</ja>-annotated interfaces.</span> |
| <span class="source-line-no">034</span><span id="line-34"> * <li>Methods and return types of server-side and client-side <ja>@Request</ja>-annotated interfaces.</span> |
| <span class="source-line-no">035</span><span id="line-35"> * </ul></span> |
| <span class="source-line-no">036</span><span id="line-36"> *</span> |
| <span class="source-line-no">037</span><span id="line-37"> * <h5 class='topic'>Arguments and argument-types of server-side @RestOp-annotated methods</h5></span> |
| <span class="source-line-no">038</span><span id="line-38"> *</span> |
| <span class="source-line-no">039</span><span id="line-39"> * <p></span> |
| <span class="source-line-no">040</span><span id="line-40"> * On server-side REST, this annotation can be applied to method parameters or parameter classes to identify them as the body of an HTTP request.</span> |
| <span class="source-line-no">041</span><span id="line-41"> *</span> |
| <span class="source-line-no">042</span><span id="line-42"> * <h5 class='section'>Examples:</h5></span> |
| <span class="source-line-no">043</span><span id="line-43"> * <p class='bjava'></span> |
| <span class="source-line-no">044</span><span id="line-44"> * <jc>// Used on parameter</jc></span> |
| <span class="source-line-no">045</span><span id="line-45"> * <ja>@RestPost</ja>(<js>"/pets"</js>)</span> |
| <span class="source-line-no">046</span><span id="line-46"> * <jk>public void</jk> addPet(<ja>@Content</ja> Pet <jv>pet</jv>) {...}</span> |
| <span class="source-line-no">047</span><span id="line-47"> * </p></span> |
| <span class="source-line-no">048</span><span id="line-48"> * <p class='bjava'></span> |
| <span class="source-line-no">049</span><span id="line-49"> * <jc>// Used on class</jc></span> |
| <span class="source-line-no">050</span><span id="line-50"> * <ja>@RestPost</ja>(<js>"/pets"</js>)</span> |
| <span class="source-line-no">051</span><span id="line-51"> * <jk>public void</jk> addPet(Pet <jv>pet</jv>) {...}</span> |
| <span class="source-line-no">052</span><span id="line-52"> *</span> |
| <span class="source-line-no">053</span><span id="line-53"> * <ja>@Content</ja></span> |
| <span class="source-line-no">054</span><span id="line-54"> * <jk>public class</jk> Pet {...}</span> |
| <span class="source-line-no">055</span><span id="line-55"> * </p></span> |
| <span class="source-line-no">056</span><span id="line-56"> *</span> |
| <span class="source-line-no">057</span><span id="line-57"> * <p></span> |
| <span class="source-line-no">058</span><span id="line-58"> * This is functionally equivalent to the following code...</span> |
| <span class="source-line-no">059</span><span id="line-59"> * <p class='bjava'></span> |
| <span class="source-line-no">060</span><span id="line-60"> * <ja>@RestPost</ja>(<js>"/pets"</js>)</span> |
| <span class="source-line-no">061</span><span id="line-61"> * <jk>public void</jk> addPet(RestRequest <jv>req</jv>) {</span> |
| <span class="source-line-no">062</span><span id="line-62"> * Pet <jv>pet</jv> = <jv>req</jv>.getContent().as(Pet.<jk>class</jk>);</span> |
| <span class="source-line-no">063</span><span id="line-63"> * ...</span> |
| <span class="source-line-no">064</span><span id="line-64"> * }</span> |
| <span class="source-line-no">065</span><span id="line-65"> * </p></span> |
| <span class="source-line-no">066</span><span id="line-66"> *</span> |
| <span class="source-line-no">067</span><span id="line-67"> * <h5 class='topic'>Arguments and argument-types of client-side @RemoteResource-annotated interfaces</h5></span> |
| <span class="source-line-no">068</span><span id="line-68"> *</span> |
| <span class="source-line-no">069</span><span id="line-69"> * <h5 class='section'>See Also:</h5><ul></span> |
| <span class="source-line-no">070</span><span id="line-70"> * <li class='link'><a class="doclink" href="../../../../../index.html#jrc.Content">@Content</a></span> |
| <span class="source-line-no">071</span><span id="line-71"> * </ul></span> |
| <span class="source-line-no">072</span><span id="line-72"> *</span> |
| <span class="source-line-no">073</span><span id="line-73"> * <h5 class='topic'>Methods and return types of server-side and client-side @Request-annotated interfaces</h5></span> |
| <span class="source-line-no">074</span><span id="line-74"> *</span> |
| <span class="source-line-no">075</span><span id="line-75"> * <h5 class='section'>See Also:</h5><ul></span> |
| <span class="source-line-no">076</span><span id="line-76"> * <li class='link'><a class="doclink" href="../../../../../index.html#jrc.Request">@Request</a></span> |
| <span class="source-line-no">077</span><span id="line-77"> * </ul></span> |
| <span class="source-line-no">078</span><span id="line-78"> *</span> |
| <span class="source-line-no">079</span><span id="line-79"> * <h5 class='section'>Notes:</h5><ul></span> |
| <span class="source-line-no">080</span><span id="line-80"> * <li class='note'></span> |
| <span class="source-line-no">081</span><span id="line-81"> * Annotation parameter values will be aggregated when used on POJO parent and child classes.</span> |
| <span class="source-line-no">082</span><span id="line-82"> * <br>Values on child classes override values on parent classes.</span> |
| <span class="source-line-no">083</span><span id="line-83"> * <li class='note'></span> |
| <span class="source-line-no">084</span><span id="line-84"> * Annotation parameter values will be aggregated when used on both POJOs and REST methods.</span> |
| <span class="source-line-no">085</span><span id="line-85"> * <br>Values on methods override values on POJO classes.</span> |
| <span class="source-line-no">086</span><span id="line-86"> * <li class='warn'></span> |
| <span class="source-line-no">087</span><span id="line-87"> * If using this annotation on a Spring bean, note that you are likely to encounter issues when using on parameterized</span> |
| <span class="source-line-no">088</span><span id="line-88"> * types such as <code>List&lt;MyBean&gt;</code>. This is due to the fact that Spring uses CGLIB to recompile classes</span> |
| <span class="source-line-no">089</span><span id="line-89"> * at runtime, and CGLIB was written before generics were introduced into Java and is a virtually-unsupported library.</span> |
| <span class="source-line-no">090</span><span id="line-90"> * Therefore, parameterized types will often be stripped from class definitions and replaced with unparameterized types</span> |
| <span class="source-line-no">091</span><span id="line-91"> * (e.g. <code>List</code>). Under these circumstances, you are likely to get <code>ClassCastExceptions</code></span> |
| <span class="source-line-no">092</span><span id="line-92"> * when trying to access generalized <code>JsonMaps</code> as beans. The best solution to this issue is to either</span> |
| <span class="source-line-no">093</span><span id="line-93"> * specify the parameter as a bean array (e.g. <code>MyBean[]</code>) or declare the method as final so that CGLIB</span> |
| <span class="source-line-no">094</span><span id="line-94"> * will not try to recompile it.</span> |
| <span class="source-line-no">095</span><span id="line-95"> * </ul></span> |
| <span class="source-line-no">096</span><span id="line-96"> *</span> |
| <span class="source-line-no">097</span><span id="line-97"> * <h5 class='section'>See Also:</h5><ul></span> |
| <span class="source-line-no">098</span><span id="line-98"></span> |
| <span class="source-line-no">099</span><span id="line-99"> * </ul></span> |
| <span class="source-line-no">100</span><span id="line-100"> */</span> |
| <span class="source-line-no">101</span><span id="line-101">@Documented</span> |
| <span class="source-line-no">102</span><span id="line-102">@Target({PARAMETER,METHOD,TYPE})</span> |
| <span class="source-line-no">103</span><span id="line-103">@Retention(RUNTIME)</span> |
| <span class="source-line-no">104</span><span id="line-104">@Inherited</span> |
| <span class="source-line-no">105</span><span id="line-105">@Repeatable(ContentAnnotation.Array.class)</span> |
| <span class="source-line-no">106</span><span id="line-106">@ContextApply(ContentAnnotation.Applier.class)</span> |
| <span class="source-line-no">107</span><span id="line-107">public @interface Content {</span> |
| <span class="source-line-no">108</span><span id="line-108"></span> |
| <span class="source-line-no">109</span><span id="line-109"> /**</span> |
| <span class="source-line-no">110</span><span id="line-110"> * Dynamically apply this annotation to the specified classes.</span> |
| <span class="source-line-no">111</span><span id="line-111"> *</span> |
| <span class="source-line-no">112</span><span id="line-112"> * <h5 class='section'>See Also:</h5><ul></span> |
| <span class="source-line-no">113</span><span id="line-113"> * <li class='link'><a class="doclink" href="../../../../../index.html#jm.DynamicallyAppliedAnnotations">Dynamically Applied Annotations</a></span> |
| <span class="source-line-no">114</span><span id="line-114"> * </ul></span> |
| <span class="source-line-no">115</span><span id="line-115"> *</span> |
| <span class="source-line-no">116</span><span id="line-116"> * @return The annotation value.</span> |
| <span class="source-line-no">117</span><span id="line-117"> */</span> |
| <span class="source-line-no">118</span><span id="line-118"> String[] on() default {};</span> |
| <span class="source-line-no">119</span><span id="line-119"></span> |
| <span class="source-line-no">120</span><span id="line-120"> /**</span> |
| <span class="source-line-no">121</span><span id="line-121"> * Dynamically apply this annotation to the specified classes.</span> |
| <span class="source-line-no">122</span><span id="line-122"> *</span> |
| <span class="source-line-no">123</span><span id="line-123"> * <p></span> |
| <span class="source-line-no">124</span><span id="line-124"> * Identical to {@link #on()} except allows you to specify class objects instead of a strings.</span> |
| <span class="source-line-no">125</span><span id="line-125"> *</span> |
| <span class="source-line-no">126</span><span id="line-126"> * <h5 class='section'>See Also:</h5><ul></span> |
| <span class="source-line-no">127</span><span id="line-127"> * <li class='link'><a class="doclink" href="../../../../../index.html#jm.DynamicallyAppliedAnnotations">Dynamically Applied Annotations</a></span> |
| <span class="source-line-no">128</span><span id="line-128"> * </ul></span> |
| <span class="source-line-no">129</span><span id="line-129"> *</span> |
| <span class="source-line-no">130</span><span id="line-130"> * @return The annotation value.</span> |
| <span class="source-line-no">131</span><span id="line-131"> */</span> |
| <span class="source-line-no">132</span><span id="line-132"> Class<?>[] onClass() default {};</span> |
| <span class="source-line-no">133</span><span id="line-133"></span> |
| <span class="source-line-no">134</span><span id="line-134"> /**</span> |
| <span class="source-line-no">135</span><span id="line-135"> * <mk>schema</mk> field of the <a class='doclink' href='https://swagger.io/specification/v2#parameterObject'>Swagger Parameter Object</a>.</span> |
| <span class="source-line-no">136</span><span id="line-136"> *</span> |
| <span class="source-line-no">137</span><span id="line-137"> * <p></span> |
| <span class="source-line-no">138</span><span id="line-138"> * The schema defining the type used for parameter.</span> |
| <span class="source-line-no">139</span><span id="line-139"> *</span> |
| <span class="source-line-no">140</span><span id="line-140"> * <p></span> |
| <span class="source-line-no">141</span><span id="line-141"> * This is a required attribute per the swagger definition.</span> |
| <span class="source-line-no">142</span><span id="line-142"> * However, if not explicitly specified, the value will be auto-generated using {@link JsonSchemaSerializer}.</span> |
| <span class="source-line-no">143</span><span id="line-143"> *</span> |
| <span class="source-line-no">144</span><span id="line-144"> * <p></span> |
| <span class="source-line-no">145</span><span id="line-145"> * The {@link Schema @Schema} annotation can also be used standalone on the parameter or type.</span> |
| <span class="source-line-no">146</span><span id="line-146"> * Values specified on this field override values specified on the type, and values specified on child types override values</span> |
| <span class="source-line-no">147</span><span id="line-147"> * specified on parent types.</span> |
| <span class="source-line-no">148</span><span id="line-148"> *</span> |
| <span class="source-line-no">149</span><span id="line-149"> * <h5 class='section'>Used for:</h5></span> |
| <span class="source-line-no">150</span><span id="line-150"> * <ul class='spaced-list'></span> |
| <span class="source-line-no">151</span><span id="line-151"> * <li></span> |
| <span class="source-line-no">152</span><span id="line-152"> * Server-side schema-based parsing and parsing validation.</span> |
| <span class="source-line-no">153</span><span id="line-153"> * <li></span> |
| <span class="source-line-no">154</span><span id="line-154"> * Server-side generated Swagger documentation.</span> |
| <span class="source-line-no">155</span><span id="line-155"> * <li></span> |
| <span class="source-line-no">156</span><span id="line-156"> * Client-side schema-based serializing and serializing validation.</span> |
| <span class="source-line-no">157</span><span id="line-157"> * </ul></span> |
| <span class="source-line-no">158</span><span id="line-158"> *</span> |
| <span class="source-line-no">159</span><span id="line-159"> * @return The annotation value.</span> |
| <span class="source-line-no">160</span><span id="line-160"> */</span> |
| <span class="source-line-no">161</span><span id="line-161"> Schema schema() default @Schema;</span> |
| <span class="source-line-no">162</span><span id="line-162">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
