Package io.undertow.attribute
Interface ExchangeAttribute
- All Known Implementing Classes:
AuthenticationTypeExchangeAttribute
,BytesSentAttribute
,CompositeExchangeAttribute
,ConstantExchangeAttribute
,CookieAttribute
,DateTimeAttribute
,HostAndPortAttribute
,IdentUsernameAttribute
,LocalIPAttribute
,LocalPortAttribute
,LocalServerNameAttribute
,NullAttribute
,PathParameterAttribute
,PredicateContextAttribute
,QueryParameterAttribute
,QueryStringAttribute
,QuotingExchangeAttribute
,RelativePathAttribute
,RemoteHostAttribute
,RemoteIPAttribute
,RemoteObfuscatedIPAttribute
,RemoteUserAttribute
,RequestCookieAttribute
,RequestHeaderAttribute
,RequestLineAttribute
,RequestMethodAttribute
,RequestPathAttribute
,RequestProtocolAttribute
,RequestSchemeAttribute
,RequestURLAttribute
,ResolvedPathAttribute
,ResponseCodeAttribute
,ResponseCookieAttribute
,ResponseHeaderAttribute
,ResponseReasonPhraseAttribute
,ResponseTimeAttribute
,SecureExchangeAttribute
,SslCipherAttribute
,SslClientCertAttribute
,SslSessionIdAttribute
,StoredResponse
,SubstituteEmptyWrapper.SubstituteEmptyAttribute
,ThreadNameAttribute
,TransportProtocolAttribute
public interface ExchangeAttribute
Representation of a string attribute from a HTTP server exchange.
- Author:
- Stuart Douglas
-
Method Summary
Modifier and TypeMethodDescriptionreadAttribute
(HttpServerExchange exchange) Resolve the attribute from the HTTP server exchange.void
writeAttribute
(HttpServerExchange exchange, String newValue) Sets a new value for the attribute.
-
Method Details
-
readAttribute
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
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
-