Doc updates

This commit is contained in:
James Agnew 2017-04-08 06:53:49 -04:00
parent 0a61096f6f
commit bf94d78872
2 changed files with 28 additions and 1 deletions

View File

@ -24,7 +24,24 @@ import ca.uhn.fhir.util.CoverageIgnore;
*/
/**
* Represents an <b>HTTP 401 Client Unauthorized</b> response, which means that the client needs to provide credentials, or has provided invalid credentials.
* Represents an <b>HTTP 401 Client Unauthorized</b> response, which
* means that the client needs to provide credentials, or has
* provided invalid credentials.
* <p>
* For security failures, you should use
* {@link AuthenticationException} if you want to indicate that the
* user could not be authenticated (e.g. credential failures), also
* known as an <b>authentication</b> failure.
* You should use {@link ForbiddenOperationException} if you want to
* indicate that the authenticated user does not have permission to
* perform the requested operation, also known as an <b>authorization</b>
* failure.
* </p>
* <p>
* Note that a complete list of RESTful exceptions is available in the <a href="./package-summary.html">Package
* Summary</a>.
* </p>
*/
@CoverageIgnore
public class AuthenticationException extends BaseServerResponseException {

View File

@ -33,6 +33,16 @@ import ca.uhn.fhir.util.CoverageIgnore;
* </ul>
*
* <p>
* For security failures, you should use
* {@link AuthenticationException} if you want to indicate that the
* user could not be authenticated (e.g. credential failures), also
* known as an <b>authentication</b> failure.
* You should use {@link ForbiddenOperationException} if you want to
* indicate that the authenticated user does not have permission to
* perform the requested operation, also known as an <b>authorization</b>
* failure.
* </p>
* <p>
* Note that a complete list of RESTful exceptions is available in the <a href="./package-summary.html">Package
* Summary</a>.
* </p>