Top Description Inners Fields Constructors Methods
io.undertow.attribute

public Class HostAndPortAttribute

extends Object
implements ExchangeAttribute
Class Inheritance
All Implemented Interfaces
io.undertow.attribute.ExchangeAttribute
Imports
io.undertow.server.HttpServerExchange
The request scheme
Author
Stuart Douglas

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
HostAndPortAttribute.Builder

Field Summary

Modifier and TypeField and Description
public static final String
HOST_AND_PORT

public static final ExchangeAttribute
INSTANCE

Constructor Summary

AccessConstructor and Description
private
HostAndPortAttribute()

Method Summary

Modifier and TypeMethod and Description
public String
readAttribute(final HttpServerExchange
The exchange
exchange)

Implements io.undertow.attribute.ExchangeAttribute.readAttribute.

Resolve the attribute from the HTTP server exchange.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public void
writeAttribute(final HttpServerExchange
The exchange
exchange, final String
The new value for the attribute
newValue)

Implements io.undertow.attribute.ExchangeAttribute.writeAttribute.

Sets a new value for the attribute.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

HOST_AND_PORTback to summary
public static final String HOST_AND_PORT
INSTANCEback to summary
public static final ExchangeAttribute INSTANCE

Constructor Detail

HostAndPortAttributeback to summary
private HostAndPortAttribute()

Method Detail

readAttributeback to summary
public String readAttribute(final HttpServerExchange exchange)

Implements io.undertow.attribute.ExchangeAttribute.readAttribute.

Doc from io.undertow.attribute.ExchangeAttribute.readAttribute.

Resolve the attribute from the HTTP server exchange. This may return null if the attribute is not present.

Parameters
exchange:HttpServerExchange

The exchange

Returns:String

The attribute

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
writeAttributeback to summary
public void writeAttribute(final HttpServerExchange exchange, final String newValue) throws ReadOnlyAttributeException

Implements io.undertow.attribute.ExchangeAttribute.writeAttribute.

Doc from io.undertow.attribute.ExchangeAttribute.writeAttribute.

Sets a new value for the attribute. Not all attributes are writable.

Parameters
exchange:HttpServerExchange

The exchange

newValue:String

The new value for the attribute

Annotations
@Override
Exceptions
ReadOnlyAttributeException:
when attribute cannot be written
io.undertow.attribute back to summary

public final Class HostAndPortAttribute.Builder

extends Object
implements ExchangeAttributeBuilder
Class Inheritance
All Implemented Interfaces
io.undertow.attribute.ExchangeAttributeBuilder

Constructor Summary

AccessConstructor and Description
public
Builder()

Method Summary

Modifier and TypeMethod and Description
public ExchangeAttribute
build(final String
The string token
token)

Implements io.undertow.attribute.ExchangeAttributeBuilder.build.

Build the attribute from a text based representation.

public String
name()

Implements io.undertow.attribute.ExchangeAttributeBuilder.name.

The string representation of the attribute name.

public int
priority()

Implements io.undertow.attribute.ExchangeAttributeBuilder.priority.

The priority of the builder.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Builderback to summary
public Builder()

Method Detail

buildback to summary
public ExchangeAttribute build(final String token)

Implements io.undertow.attribute.ExchangeAttributeBuilder.build.

Doc from io.undertow.attribute.ExchangeAttributeBuilder.build.

Build the attribute from a text based representation. If the attribute does not understand this representation then it will just return null.

Parameters
token:String

The string token

Returns:ExchangeAttribute

The exchange attribute, or null

Annotations
@Override
nameback to summary
public String name()

Implements io.undertow.attribute.ExchangeAttributeBuilder.name.

Doc from io.undertow.attribute.ExchangeAttributeBuilder.name.

The string representation of the attribute name. This is used solely for debugging / informational purposes

Returns:String

The attribute name

Annotations
@Override
priorityback to summary
public int priority()

Implements io.undertow.attribute.ExchangeAttributeBuilder.priority.

Doc from io.undertow.attribute.ExchangeAttributeBuilder.priority.

The priority of the builder. Builders will be tried in priority builder. Built in builders use the priority range 0-100,

Returns:int

The priority

Annotations
@Override