Package org.apache.juneau.console.bus

Class BusRefusal

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.apache.juneau.console.bus.BusRefusal

All Implemented Interfaces:

Serializable

public final class BusRefusal
extends Exception

A named refusal from the bus: the session POST's 400/403/429/501 answers and the codec's bus:bad-frame. The message is fixed server text; denied() lists the topic names the caller requested, which is the only caller input in a refusal.

Example:

try { BusSession s = bus.openSession(req, body); ... } catch (BusRefusal e) { res.setStatus(e.status()); e.retryAfterSeconds().ifPresent(s -> res.setHeader("Retry-After", String.valueOf(s))); return e.toJson(); // {"code":"bus:topic-denied","message":"...","denied":["ops.secret"]} }

Since:

10.0.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TOO_MANY_SESSIONS_RETRY_AFTER_SECONDS	Retry-After seconds sent with bus:too-many-sessions.

Constructor Summary

Constructors

Constructor	Description
BusRefusal(int status, String code, String message, List<String> denied, int retryAfterSeconds)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	code()
List<String>	denied()
OptionalInt	retryAfterSeconds()
int	status()
JsonMap	toJson()	The refusal body: {code, message, denied?}.

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

Field Details

TOO_MANY_SESSIONS_RETRY_AFTER_SECONDS

public static final int TOO_MANY_SESSIONS_RETRY_AFTER_SECONDS

Retry-After seconds sent with bus:too-many-sessions.

See Also:

• Constant Field Values

Constructor Details

BusRefusal

public BusRefusal(int status,
 String code,
 String message,
 List<String> denied,
 int retryAfterSeconds)

Constructor.

Parameters:

status - The HTTP status.

code - The bus:* code.

message - Fixed server text.

denied - The denied topics, for bus:topic-denied. Can be null.

retryAfterSeconds - Retry-After seconds, or 0 for none.

Method Details

status

public int status()

Returns:

The HTTP status.

code

public String code()

Returns:

The bus:* code.

denied

public List<String> denied()

Returns:

The denied topics (empty unless bus:topic-denied).

retryAfterSeconds

public OptionalInt retryAfterSeconds()

Returns:

The Retry-After seconds, if any.

toJson

public JsonMap toJson()

The refusal body: {code, message, denied?}.

Returns:

A new map.