io.undertow.attribute

public Interface ExchangeAttribute

Known Direct Implementers: io.undertow.attribute.HostAndPortAttribute, io.undertow.attribute.IdentUsernameAttribute, io.undertow.attribute.LocalIPAttribute, io.undertow.attribute.LocalPortAttribute, io.undertow.attribute.LocalServerNameAttribute, io.undertow.attribute.NullAttribute, io.undertow.attribute.PathParameterAttribute, io.undertow.attribute.PredicateContextAttribute, io.undertow.attribute.QueryParameterAttribute, io.undertow.attribute.QueryStringAttribute, io.undertow.attribute.QuotingExchangeAttribute, io.undertow.attribute.RelativePathAttribute, io.undertow.attribute.RemoteHostAttribute, io.undertow.attribute.RemoteObfuscatedIPAttribute, io.undertow.attribute.RemoteUserAttribute, io.undertow.attribute.RequestCookieAttribute, io.undertow.attribute.RequestHeaderAttribute, io.undertow.attribute.RequestLineAttribute, io.undertow.attribute.RequestMethodAttribute, io.undertow.attribute.RequestPathAttribute, io.undertow.attribute.RequestProtocolAttribute, io.undertow.attribute.RequestSchemeAttribute, io.undertow.attribute.RequestURLAttribute, io.undertow.attribute.ResolvedPathAttribute, io.undertow.attribute.ResponseCodeAttribute, io.undertow.attribute.ResponseCookieAttribute, io.undertow.attribute.ResponseHeaderAttribute, io.undertow.attribute.ResponseReasonPhraseAttribute, io.undertow.attribute.ResponseTimeAttribute, io.undertow.attribute.SecureExchangeAttribute, io.undertow.attribute.SslCipherAttribute, io.undertow.attribute.SslClientCertAttribute, io.undertow.attribute.SslSessionIdAttribute, io.undertow.attribute.StoredResponse, io.undertow.attribute.SubstituteEmptyWrapper.SubstituteEmptyAttribute, io.undertow.attribute.ThreadNameAttribute, io.undertow.attribute.TransportProtocolAttribute, io.undertow.attribute.RemoteIPAttribute, io.undertow.attribute.AuthenticationTypeExchangeAttribute, io.undertow.attribute.BytesSentAttribute, io.undertow.attribute.CompositeExchangeAttribute, io.undertow.attribute.ConstantExchangeAttribute, io.undertow.attribute.CookieAttribute, io.undertow.attribute.DateTimeAttribute
Imports: io.undertow.server.HttpServerExchange

Representation of a string attribute from a HTTP server exchange.

Author: Stuart Douglas

Method Summary

Modifier and Type	Method and Description
public String	Returns: The attribute readAttribute(final HttpServerExchange The exchange exchange) Resolve the attribute from the HTTP server exchange.
public void	writeAttribute(final HttpServerExchange The exchange exchange, final String The new value for the attribute newValue) Sets a new value for the attribute.

Method Detail

readAttribute	back to summary
public String readAttribute(final HttpServerExchange exchange) Resolve the attribute from the HTTP server exchange. This may return null if the attribute is not present. Parameters exchange:HttpServerExchange The exchange Returns:String The attribute

readAttribute

back to summary

public String readAttribute(final HttpServerExchange exchange)

Resolve the attribute from the HTTP server exchange. This may return null if the attribute is not present.

Parameters

exchange:HttpServerExchange: The exchange

Returns:String

The attribute

writeAttribute	back to summary
public void writeAttribute(final HttpServerExchange exchange, final String newValue) throws ReadOnlyAttributeException Sets a new value for the attribute. Not all attributes are writable. Parameters exchange:HttpServerExchange The exchange newValue:String The new value for the attribute Exceptions ReadOnlyAttributeException: when attribute cannot be written

writeAttribute

back to summary

public void writeAttribute(final HttpServerExchange exchange, final String newValue) throws ReadOnlyAttributeException

Sets a new value for the attribute. Not all attributes are writable.

Parameters

exchange:HttpServerExchange: The exchange
newValue:String: The new value for the attribute

Exceptions

ReadOnlyAttributeException:: when attribute cannot be written