com.google.gerrit.extensions.restapi

Class AuthException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.google.gerrit.extensions.restapi.RestApiException

com.google.gerrit.extensions.restapi.AuthException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PermissionDeniedException

public class AuthException
extends RestApiException

Caller cannot perform the request operation (HTTP 403 Forbidden).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuthException(String msg)
AuthException(String msg, Throwable cause)

Method Summary

Modifier and Type	Method and Description
Optional<String>	getAdvice() Advice that the user can follow to acquire authorization to perform the action.
void	setAdvice(String advice)

Methods inherited from class com.google.gerrit.extensions.restapi.RestApiException

caching, caching

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AuthException

public AuthException(String msg)

Parameters:

msg - message to return to the client.

AuthException

public AuthException(String msg,
                     Throwable cause)

Parameters:

msg - message to return to the client.

cause - cause of this exception.

Method Detail

setAdvice

public void setAdvice(String advice)

getAdvice

public Optional<String> getAdvice()

Advice that the user can follow to acquire authorization to perform the action.

This may be long-form text with newlines, and may be printed to a terminal, for example in the message stream in response to a push.