Package io.undertow.attribute

Class RequestCookieAttribute

java.lang.Object

io.undertow.attribute.RequestCookieAttribute

All Implemented Interfaces:

ExchangeAttribute

public class RequestCookieAttribute
extends java.lang.Object
implements ExchangeAttribute

A request cookie

Author:

Richard Opalka

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RequestCookieAttribute.Builder

Constructor Summary

Constructors

Constructor	Description
RequestCookieAttribute(java.lang.String cookieName)

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

Constructor Detail

RequestCookieAttribute

public RequestCookieAttribute(java.lang.String cookieName)

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