SecureExchangeAttribute (Quarkus - Vert.x - HTTP - Runtime 2.15.0.Final API)

java.lang.Object
- io.quarkus.vertx.http.runtime.attribute.SecureExchangeAttribute

All Implemented Interfaces:: ExchangeAttribute

public class SecureExchangeAttribute
extends Object
implements ExchangeAttribute

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SecureExchangeAttribute.Builder

Field Summary

Fields
Modifier and Type Field Description

static ExchangeAttribute INSTANCE

static String LEGACY_INCORRECT_TOKEN

static String TOKEN

Constructor Summary

Constructors
Constructor Description

SecureExchangeAttribute()

Method Summary

All Methods Instance Methods Concrete Methods
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 Detail
  - TOKEN
```
public static final String TOKEN
```
    See Also:
    
    Constant Field Values
  - LEGACY_INCORRECT_TOKEN
```
public static final String LEGACY_INCORRECT_TOKEN
```
    See Also:
    
    Constant Field Values
  - INSTANCE
```
public static final ExchangeAttribute INSTANCE
```
- Constructor Detail
  - SecureExchangeAttribute
```
public SecureExchangeAttribute()
```
- 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