io.undertow.attribute

Class RemoteHostAttribute

java.lang.Object

io.undertow.attribute.RemoteHostAttribute

All Implemented Interfaces:

ExchangeAttribute

public class RemoteHostAttribute
extends Object
implements ExchangeAttribute

The remote Host address (if resolved)

Author:

Stuart Douglas

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RemoteHostAttribute.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static ExchangeAttribute	INSTANCE
static String	REMOTE_HOST
static String	REMOTE_HOST_NAME_SHORT

Method Summary

Modifier and Type	Method and Description
String	readAttribute(HttpServerExchange exchange) Resolve the attribute from the HTTP server exchange.
void	writeAttribute(HttpServerExchange 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

REMOTE_HOST_NAME_SHORT

public static final String REMOTE_HOST_NAME_SHORT

See Also:

Constant Field Values

REMOTE_HOST

public static final String REMOTE_HOST

See Also:

Constant Field Values

INSTANCE

public static final ExchangeAttribute INSTANCE

Method Detail

readAttribute

public String readAttribute(HttpServerExchange 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(HttpServerExchange 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