| <!-- |
| /*************************************************************************************************************************** |
| * 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. |
| ***************************************************************************************************************************/ |
| --> |
| |
| @ResponseStatus |
| |
| <p> |
| The {@link oaj.http.annotation.ResponseStatus @ResponseStatus} annotation annotation can be applied to <ja>@RestMethod</ja>-annotated parameters to denote them as an HTTP response status codes. |
| </p> |
| <ul class='javatree'> |
| <li class='ja'>{@link oaj.http.annotation.ResponseStatus} |
| </ul> |
| <p> |
| This can only be applied to parameters of the {@link oaj.Value} class with an {@link java.lang.Integer} type. |
| </p> |
| |
| <h5 class='figure'>Examples:</h5> |
| <p class='bpcode w800'> |
| <jc>// Defined on parameter.</jc> |
| <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/user/login"</js>) |
| <jk>public void</jk> login( |
| <ja>@FormData</ja>(<js>"username"</js>) String username, |
| <ja>@FormData</ja>(<js>"password"</js>) String password, |
| <ja>@ResponseStatus</ja> Value<Integer> status |
| ) |
| { |
| <jk>if</jk> (! isValid(username, password)) |
| status.set(401); |
| } |
| </p> |
