Interface ExchangeAttribute
-
- All Known Implementing Classes:
AllRequestHeadersAttribute
,BytesSentAttribute
,CompositeExchangeAttribute
,ConstantExchangeAttribute
,CookieAttribute
,DateTimeAttribute
,ExchangeDataAttribute
,IdentUsernameAttribute
,LocalIPAttribute
,LocalPortAttribute
,LocalServerNameAttribute
,NullAttribute
,QueryParameterAttribute
,QueryStringAttribute
,QuotingExchangeAttribute
,RemoteHostAttribute
,RemoteIPAttribute
,RemoteUserAttribute
,RequestHeaderAttribute
,RequestLineAttribute
,RequestMethodAttribute
,RequestPathAttribute
,RequestProtocolAttribute
,RequestSchemeAttribute
,RequestURLAttribute
,ResponseCodeAttribute
,ResponseHeaderAttribute
,ResponseTimeAttribute
,SecureExchangeAttribute
,SslCipherAttribute
,SslClientCertAttribute
,SslSessionIdAttribute
,SubstituteEmptyWrapper.SubstituteEmptyAttribute
,ThreadNameAttribute
,TransportProtocolAttribute
,VertxMDCDataAttribute
public interface ExchangeAttribute
Representation of a string attribute from a HTTP server exchange.
-
-
Method Summary
All Methods Instance Methods Abstract 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.
-
-
-
Method Detail
-
readAttribute
String readAttribute(io.vertx.ext.web.RoutingContext exchange)
Resolve the attribute from the HTTP server exchange. This may return null if the attribute is not present.- Parameters:
exchange
- The exchange- Returns:
- The attribute
-
writeAttribute
void writeAttribute(io.vertx.ext.web.RoutingContext exchange, String newValue) throws ReadOnlyAttributeException
Sets a new value for the attribute. Not all attributes are writable.- Parameters:
exchange
- The exchangenewValue
- The new value for the attribute- Throws:
ReadOnlyAttributeException
- when attribute cannot be written
-
-