This is an automated email from the ASF dual-hosted git repository. jamesbognar pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/juneau.git
The following commit(s) were added to refs/heads/master by this push: new f5826df Javadocs. f5826df is described below commit f5826df23f5336aa65f3600350e4ce4c356da7ce Author: JamesBognar <jamesbog...@apache.org> AuthorDate: Sat Jul 28 17:23:33 2018 -0400 Javadocs. --- juneau-doc/src/main/javadoc/overview.html | 94 +++++++++++++--------- .../06.RestMethod/16.PredefinedThrowables.html | 92 +++++++++++++-------- 2 files changed, 115 insertions(+), 71 deletions(-) diff --git a/juneau-doc/src/main/javadoc/overview.html b/juneau-doc/src/main/javadoc/overview.html index 3995ccd..79f3ec9 100644 --- a/juneau-doc/src/main/javadoc/overview.html +++ b/juneau-doc/src/main/javadoc/overview.html @@ -299,7 +299,7 @@ <li><p class=''><a class='doclink' href='#juneau-rest-server.RestMethod.Redirect'>Redirect</a></p> <li><p class=''><a class='doclink' href='#juneau-rest-server.RestMethod.RestMethodMatchers'>@RestMethod.matchers()</a></p> <li><p class='todo'><a class='doclink' href='#juneau-rest-server.RestMethod.PredefinedHelperBeans'>Helper Beans</a></p> - <li><p class='todo'><a class='doclink' href='#juneau-rest-server.RestMethod.PredefinedThrowables'>Predefined Throwables</a></p> + <li><p class='new'><a class='doclink' href='#juneau-rest-server.RestMethod.PredefinedThrowables'>Predefined Throwables</a></p> </ol> <li><p class='new'><a class='doclink' href='#juneau-rest-server.OpenApiSchemaPartParsing'>OpenAPI Schema Part Parsing</a></p> <li><p class='new'><a class='doclink' href='#juneau-rest-server.OpenApiSchemaPartSerializing'>OpenAPI Schema Part Serializing</a></p> @@ -14078,42 +14078,64 @@ StreamResourceBuilder <!-- ==================================================================================================== --> -<h4 class='topic todo' onclick='toggle(this)'><a href='#juneau-rest-server.RestMethod.PredefinedThrowables' id='juneau-rest-server.RestMethod.PredefinedThrowables'>7.6.16 - Predefined Throwables</a></h4> +<h4 class='topic new' onclick='toggle(this)'><a href='#juneau-rest-server.RestMethod.PredefinedThrowables' id='juneau-rest-server.RestMethod.PredefinedThrowables'>7.6.16 - Predefined Throwables</a></h4> <div class='topic'><!-- START: 7.6.16 - juneau-rest-server.RestMethod.PredefinedThrowables --> -org.apache.juneau.rest.exception -BadRequest -Conflict -ExpectationFailed -FailedDependency -Forbidden -Gone -HttpVersionNotSupported -InsufficientStorage -InternalServerError -LengthRequired -Locked -LoopDetected -MethodNotAllowed -MisdirectedRequest -NetworkAuthenticationRequired -NotAcceptable -NotExtended -NotFound -NotImplemented -PayloadTooLarge -PreconditionFailed -PreconditionRequired -RangeNotSatisfiable -RequestHeaderFieldsTooLarge -ServiceUnavailable -TooManyRequests -Unauthorized -UnavailableForLegalReasons -UnprocessableEntity -UnsupportedMediaType -UpgradeRequired -UriTooLong -VariantAlsoNegotiates +<p> + Exceptions are defined for all standardized HTTP responses. + These can be used to trigger HTTP errors simply by throwing an exception. +</p> +<h5 class='figure'>Example:</h5> +<p class='bpcode w800'> + <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/user/login"</js>) + <jk>public</jk> String login( + <ja>@FormData</ja>(<js>"username"</js>) String username, + <ja>@FormData</ja>(<js>"password"</js>) String password, + ) <jk>throws</jk> Unauthorized + { + <jk>if</jk> (! isOK(username, password)) + <jk>throw new</jk> Unauthorized(); + + <jk>return</jk> <js>"OK"</js>; + } +</p> +<ul class='doctree'> + <li class='jp'>{@link org.apache.juneau.rest.exception} + <ul> + <li class='jc'>{@link org.apache.juneau.rest.exception.BadRequest} + <li class='jc'>{@link org.apache.juneau.rest.exception.Conflict} + <li class='jc'>{@link org.apache.juneau.rest.exception.ExpectationFailed} + <li class='jc'>{@link org.apache.juneau.rest.exception.FailedDependency} + <li class='jc'>{@link org.apache.juneau.rest.exception.Forbidden} + <li class='jc'>{@link org.apache.juneau.rest.exception.Gone} + <li class='jc'>{@link org.apache.juneau.rest.exception.HttpVersionNotSupported} + <li class='jc'>{@link org.apache.juneau.rest.exception.InsufficientStorage} + <li class='jc'>{@link org.apache.juneau.rest.exception.InternalServerError} + <li class='jc'>{@link org.apache.juneau.rest.exception.LengthRequired} + <li class='jc'>{@link org.apache.juneau.rest.exception.Locked} + <li class='jc'>{@link org.apache.juneau.rest.exception.LoopDetected} + <li class='jc'>{@link org.apache.juneau.rest.exception.MethodNotAllowed} + <li class='jc'>{@link org.apache.juneau.rest.exception.MisdirectedRequest} + <li class='jc'>{@link org.apache.juneau.rest.exception.NetworkAuthenticationRequired} + <li class='jc'>{@link org.apache.juneau.rest.exception.NotAcceptable} + <li class='jc'>{@link org.apache.juneau.rest.exception.NotExtended} + <li class='jc'>{@link org.apache.juneau.rest.exception.NotFound} + <li class='jc'>{@link org.apache.juneau.rest.exception.NotImplemented} + <li class='jc'>{@link org.apache.juneau.rest.exception.PayloadTooLarge} + <li class='jc'>{@link org.apache.juneau.rest.exception.PreconditionFailed} + <li class='jc'>{@link org.apache.juneau.rest.exception.PreconditionRequired} + <li class='jc'>{@link org.apache.juneau.rest.exception.RangeNotSatisfiable} + <li class='jc'>{@link org.apache.juneau.rest.exception.RequestHeaderFieldsTooLarge} + <li class='jc'>{@link org.apache.juneau.rest.exception.ServiceUnavailable} + <li class='jc'>{@link org.apache.juneau.rest.exception.TooManyRequests} + <li class='jc'>{@link org.apache.juneau.rest.exception.Unauthorized} + <li class='jc'>{@link org.apache.juneau.rest.exception.UnavailableForLegalReasons} + <li class='jc'>{@link org.apache.juneau.rest.exception.UnprocessableEntity} + <li class='jc'>{@link org.apache.juneau.rest.exception.UnsupportedMediaType} + <li class='jc'>{@link org.apache.juneau.rest.exception.UpgradeRequired} + <li class='jc'>{@link org.apache.juneau.rest.exception.UriTooLong} + <li class='jc'>{@link org.apache.juneau.rest.exception.VariantAlsoNegotiates} + </ul> +</ul> </div><!-- END: 7.6.16 - juneau-rest-server.RestMethod.PredefinedThrowables --> </div><!-- END: 7.6 - juneau-rest-server.RestMethod --> diff --git a/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/16.PredefinedThrowables.html b/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/16.PredefinedThrowables.html index 710130a..4563534 100644 --- a/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/16.PredefinedThrowables.html +++ b/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/06.RestMethod/16.PredefinedThrowables.html @@ -13,39 +13,61 @@ ***************************************************************************************************************************/ --> -{todo} Predefined Throwables +{new} Predefined Throwables -org.apache.juneau.rest.exception -BadRequest -Conflict -ExpectationFailed -FailedDependency -Forbidden -Gone -HttpVersionNotSupported -InsufficientStorage -InternalServerError -LengthRequired -Locked -LoopDetected -MethodNotAllowed -MisdirectedRequest -NetworkAuthenticationRequired -NotAcceptable -NotExtended -NotFound -NotImplemented -PayloadTooLarge -PreconditionFailed -PreconditionRequired -RangeNotSatisfiable -RequestHeaderFieldsTooLarge -ServiceUnavailable -TooManyRequests -Unauthorized -UnavailableForLegalReasons -UnprocessableEntity -UnsupportedMediaType -UpgradeRequired -UriTooLong -VariantAlsoNegotiates \ No newline at end of file +<p> + Exceptions are defined for all standardized HTTP responses. + These can be used to trigger HTTP errors simply by throwing an exception. +</p> +<h5 class='figure'>Example:</h5> +<p class='bpcode w800'> + <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/user/login"</js>) + <jk>public</jk> String login( + <ja>@FormData</ja>(<js>"username"</js>) String username, + <ja>@FormData</ja>(<js>"password"</js>) String password, + ) <jk>throws</jk> Unauthorized + { + <jk>if</jk> (! isOK(username, password)) + <jk>throw new</jk> Unauthorized(); + + <jk>return</jk> <js>"OK"</js>; + } +</p> +<ul class='doctree'> + <li class='jp'>{@link org.apache.juneau.rest.exception} + <ul> + <li class='jc'>{@link org.apache.juneau.rest.exception.BadRequest} + <li class='jc'>{@link org.apache.juneau.rest.exception.Conflict} + <li class='jc'>{@link org.apache.juneau.rest.exception.ExpectationFailed} + <li class='jc'>{@link org.apache.juneau.rest.exception.FailedDependency} + <li class='jc'>{@link org.apache.juneau.rest.exception.Forbidden} + <li class='jc'>{@link org.apache.juneau.rest.exception.Gone} + <li class='jc'>{@link org.apache.juneau.rest.exception.HttpVersionNotSupported} + <li class='jc'>{@link org.apache.juneau.rest.exception.InsufficientStorage} + <li class='jc'>{@link org.apache.juneau.rest.exception.InternalServerError} + <li class='jc'>{@link org.apache.juneau.rest.exception.LengthRequired} + <li class='jc'>{@link org.apache.juneau.rest.exception.Locked} + <li class='jc'>{@link org.apache.juneau.rest.exception.LoopDetected} + <li class='jc'>{@link org.apache.juneau.rest.exception.MethodNotAllowed} + <li class='jc'>{@link org.apache.juneau.rest.exception.MisdirectedRequest} + <li class='jc'>{@link org.apache.juneau.rest.exception.NetworkAuthenticationRequired} + <li class='jc'>{@link org.apache.juneau.rest.exception.NotAcceptable} + <li class='jc'>{@link org.apache.juneau.rest.exception.NotExtended} + <li class='jc'>{@link org.apache.juneau.rest.exception.NotFound} + <li class='jc'>{@link org.apache.juneau.rest.exception.NotImplemented} + <li class='jc'>{@link org.apache.juneau.rest.exception.PayloadTooLarge} + <li class='jc'>{@link org.apache.juneau.rest.exception.PreconditionFailed} + <li class='jc'>{@link org.apache.juneau.rest.exception.PreconditionRequired} + <li class='jc'>{@link org.apache.juneau.rest.exception.RangeNotSatisfiable} + <li class='jc'>{@link org.apache.juneau.rest.exception.RequestHeaderFieldsTooLarge} + <li class='jc'>{@link org.apache.juneau.rest.exception.ServiceUnavailable} + <li class='jc'>{@link org.apache.juneau.rest.exception.TooManyRequests} + <li class='jc'>{@link org.apache.juneau.rest.exception.Unauthorized} + <li class='jc'>{@link org.apache.juneau.rest.exception.UnavailableForLegalReasons} + <li class='jc'>{@link org.apache.juneau.rest.exception.UnprocessableEntity} + <li class='jc'>{@link org.apache.juneau.rest.exception.UnsupportedMediaType} + <li class='jc'>{@link org.apache.juneau.rest.exception.UpgradeRequired} + <li class='jc'>{@link org.apache.juneau.rest.exception.UriTooLong} + <li class='jc'>{@link org.apache.juneau.rest.exception.VariantAlsoNegotiates} + </ul> +</ul> \ No newline at end of file