@Response(code=511, description="Network Authentication Required") public class NetworkAuthenticationRequired extends HttpException
The client needs to authenticate to gain network access.
Intended for use by intercepting proxies used to control access to the network (e.g., "captive portals" used to require agreement to Terms of Service before granting full Internet access via a Wi-Fi hotspot).
Modifier and Type | Field and Description |
---|---|
static int |
CODE
HTTP status code
|
static String |
MESSAGE
Default message
|
Constructor and Description |
---|
NetworkAuthenticationRequired()
Constructor.
|
NetworkAuthenticationRequired(String msg)
Constructor.
|
NetworkAuthenticationRequired(String msg,
Object... args)
Constructor.
|
NetworkAuthenticationRequired(Throwable cause)
Constructor.
|
NetworkAuthenticationRequired(Throwable cause,
String msg,
Object... args)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
NetworkAuthenticationRequired |
header(String name,
Object val)
Add an HTTP header to this exception.
|
getFullStackMessage, getHeaders, getRootCause, getStatus, hashCode, setStatus, toString
getCause, getMessage
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
public static final int CODE
public static final String MESSAGE
public NetworkAuthenticationRequired(Throwable cause, String msg, Object... args)
cause
- The cause. Can be msg
- The message. Can be args
- Optional MessageFormat
-style arguments in the message.public NetworkAuthenticationRequired(String msg)
msg
- The message. Can be public NetworkAuthenticationRequired()
public NetworkAuthenticationRequired(String msg, Object... args)
msg
- The message. Can be args
- Optional MessageFormat
-style arguments in the message.public NetworkAuthenticationRequired(Throwable cause)
cause
- The cause. Can be public NetworkAuthenticationRequired header(String name, Object val)
HttpException
header
in class HttpException
name
- The header name.val
- The header value.Copyright © 2016–2020 The Apache Software Foundation. All rights reserved.