Package io.undertow.attribute
Class RelativePathAttribute
- java.lang.Object
-
- io.undertow.attribute.RelativePathAttribute
-
- All Implemented Interfaces:
ExchangeAttribute
public class RelativePathAttribute extends java.lang.Object implements ExchangeAttribute
The relative path- Author:
- Stuart Douglas
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RelativePathAttribute.Builder
-
Field Summary
Fields Modifier and Type Field Description static ExchangeAttribute
INSTANCE
static java.lang.String
RELATIVE_PATH
static java.lang.String
RELATIVE_PATH_SHORT
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
readAttribute(HttpServerExchange exchange)
Resolve the attribute from the HTTP server exchange.void
writeAttribute(HttpServerExchange exchange, java.lang.String newValue)
Sets a new value for the attribute.
-
-
-
Field Detail
-
RELATIVE_PATH_SHORT
public static final java.lang.String RELATIVE_PATH_SHORT
- See Also:
- Constant Field Values
-
RELATIVE_PATH
public static final java.lang.String RELATIVE_PATH
- 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 interfaceExchangeAttribute
- 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 interfaceExchangeAttribute
- Parameters:
exchange
- The exchangenewValue
- The new value for the attribute- Throws:
ReadOnlyAttributeException
- when attribute cannot be written
-
-