io.undertow.attribute

Interface ExchangeAttribute

All Known Implementing Classes:

BytesSentAttribute, CompositeExchangeAttribute, ConstantExchangeAttribute, CookieAttribute, DateTimeAttribute, IdentUsernameAttribute, LocalIPAttribute, LocalPortAttribute, LocalServerNameAttribute, PredicateContextAttribute, QueryParameterAttribute, QueryStringAttribute, RelativePathAttribute, RemoteIPAttribute, RemoteUserAttribute, RequestHeaderAttribute, RequestLineAttribute, RequestMethodAttribute, RequestProtocolAttribute, RequestURLAttribute, ResponseCodeAttribute, ResponseHeaderAttribute, SslCipherAttribute, SslClientCertAttribute, SslSessionIdAttribute, ThreadNameAttribute

public interface ExchangeAttribute

Representation of a string attribute from a HTTP server exchange.

Author:

Stuart Douglas

Method Summary

Methods

Modifier and Type	Method and Description
String	readAttribute(HttpServerExchange exchange) Resolve the attribute from the HTTP server exchange.
void	writeAttribute(HttpServerExchange exchange, String newValue)

Method Detail

readAttribute

String readAttribute(HttpServerExchange 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(HttpServerExchange exchange,
                  String newValue)
                    throws ReadOnlyAttributeException

Parameters:

exchange -

newValue -

Throws:

ReadOnlyAttributeException