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

Class ExchangeDataAttribute

java.lang.Object

io.quarkus.vertx.http.runtime.attribute.ExchangeDataAttribute

All Implemented Interfaces:

ExchangeAttribute

public class ExchangeDataAttribute
extends Object
implements ExchangeAttribute

Provide entries from the "user data" section of the RoutingContext

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExchangeDataAttribute.Builder

Constructor Summary

Constructors

Constructor	Description
ExchangeDataAttribute(String dataKey)

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

Constructor Detail

ExchangeDataAttribute

public ExchangeDataAttribute(String dataKey)

Method Detail

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