io.undertow.servlet.attribute

Class ServletRequestAttribute

java.lang.Object

io.undertow.servlet.attribute.ServletRequestAttribute

All Implemented Interfaces:

ExchangeAttribute

public class ServletRequestAttribute
extends Object
implements ExchangeAttribute

An attribute in the servlet request

Author:

Stuart Douglas

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServletRequestAttribute.Builder

Constructor Summary

Constructors

Constructor and Description
ServletRequestAttribute(String attributeName)

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

Constructor Detail

ServletRequestAttribute

public ServletRequestAttribute(String attributeName)

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