Package io.undertow.attribute

Class RemoteUserAttribute

java.lang.Object

io.undertow.attribute.RemoteUserAttribute

All Implemented Interfaces:

ExchangeAttribute

public class RemoteUserAttribute
extends java.lang.Object
implements ExchangeAttribute

The remote user

Author:

Stuart Douglas

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RemoteUserAttribute.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static ExchangeAttribute	INSTANCE
static java.lang.String	REMOTE_USER
static java.lang.String	REMOTE_USER_SHORT

Method Summary

Modifier and Type	Method	Description
java.lang.String	readAttribute(HttpServerExchange exchange)	Resolve the attribute from the HTTP server exchange.
java.lang.String	toString()
void	writeAttribute(HttpServerExchange exchange, java.lang.String newValue)	Sets a new value for the attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

REMOTE_USER_SHORT

public static final java.lang.String REMOTE_USER_SHORT

See Also:

Constant Field Values

REMOTE_USER

public static final java.lang.String REMOTE_USER

See Also:

Constant Field Values

INSTANCE

public static final ExchangeAttribute INSTANCE

Method Detail

readAttribute

public java.lang.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,
                           java.lang.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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object