Package io.quarkus.vertx.http.runtime.attribute

Class RemoteUserAttribute

java.lang.Object

io.quarkus.vertx.http.runtime.attribute.RemoteUserAttribute

All Implemented Interfaces:

ExchangeAttribute

public class RemoteUserAttribute
extends Object
implements ExchangeAttribute

The remote user

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RemoteUserAttribute.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final ExchangeAttribute	INSTANCE
static final String	REMOTE_USER
static final String	REMOTE_USER_SHORT

Method Summary

Modifier and Type	Method	Description
String	readAttribute(io.vertx.ext.web.RoutingContext exchange)	Resolve the attribute from the HTTP server exchange.
void	writeAttribute(io.vertx.ext.web.RoutingContext exchange, String newValue)	Sets a new value for the attribute.

Methods inherited from class java.lang.Object

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

Field Details

REMOTE_USER_SHORT

public static final String REMOTE_USER_SHORT

See Also:

• Constant Field Values

REMOTE_USER

public static final String REMOTE_USER

See Also:

• Constant Field Values

INSTANCE

public static final ExchangeAttribute INSTANCE

Method Details

readAttribute

public String readAttribute(io.vertx.ext.web.RoutingContext exchange)

Description copied from interface: ExchangeAttribute

Resolve the attribute from the HTTP server exchange. This may return null if the attribute is not present.

Specified by:

readAttribute in interface ExchangeAttribute

Parameters:

exchange - The exchange

Returns:

The attribute

writeAttribute

public void writeAttribute(io.vertx.ext.web.RoutingContext exchange,
 String newValue)
                    throws ReadOnlyAttributeException

Description copied from interface: ExchangeAttribute

Sets a new value for the attribute. Not all attributes are writable.

Specified by:

writeAttribute in interface ExchangeAttribute

Parameters:

exchange - The exchange

newValue - The new value for the attribute

Throws:

ReadOnlyAttributeException - when attribute cannot be written