Handler that serves as the basis for content encoding implementations.

Encoding handlers are added as delegates to this handler, with a specified server side priority.

If a request comes in with no q value then then server will pick the handler with the highest priority as the encoding to use, otherwise the q value will be used to determine the correct handler.

If no handler matches then the identity encoding is assumed. If the identity encoding has been specifically disallowed due to a q value of 0 then the handler will set the response code 406 (Not Acceptable) and return.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	EncodingHandler.Builder

Modifier and Type	Field and Description
private final ContentEncodingRepository	contentEncodingRepository
private volatile HttpHandler	next
private volatile HttpHandler	noEncodingHandler

Constructor Summary

Access	Constructor and Description
public	EncodingHandler(final HttpHandler next, ContentEncodingRepository contentEncodingRepository)
public	EncodingHandler(ContentEncodingRepository contentEncodingRepository)

Method Summary

Modifier and Type	Method and Description
public HttpHandler	getNext()
public HttpHandler	getNoEncodingHandler()
public void	handleRequest(final HttpServerExchange the HTTP request/response exchange exchange) Implements io.undertow.server.HttpHandler.handleRequest. Handle the request.
public EncodingHandler	setNext(final HttpHandler next)
public EncodingHandler	setNoEncodingHandler(HttpHandler noEncodingHandler)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

contentEncodingRepository	back to summary
private final ContentEncodingRepository contentEncodingRepository

next	back to summary
private volatile HttpHandler next

noEncodingHandler	back to summary
private volatile HttpHandler noEncodingHandler

Constructor Detail

EncodingHandler	back to summary
public EncodingHandler(final HttpHandler next, ContentEncodingRepository contentEncodingRepository)

EncodingHandler	back to summary
public EncodingHandler(ContentEncodingRepository contentEncodingRepository)

Method Detail

getNext	back to summary
public HttpHandler getNext()

getNoEncodingHandler	back to summary
public HttpHandler getNoEncodingHandler()

handleRequest	back to summary
public void handleRequest(final HttpServerExchange exchange) throws Exception Implements io.undertow.server.HttpHandler.handleRequest. Doc from io.undertow.server.HttpHandler.handleRequest. Handle the request. Parameters exchange:HttpServerExchange the HTTP request/response exchange Annotations @Override

handleRequest

back to summary

public void handleRequest(final HttpServerExchange exchange) throws Exception

Implements io.undertow.server.HttpHandler.handleRequest.

Doc from io.undertow.server.HttpHandler.handleRequest.

Handle the request.

Parameters

exchange:HttpServerExchange: the HTTP request/response exchange

Annotations

@Override

setNext	back to summary
public EncodingHandler setNext(final HttpHandler next)

setNoEncodingHandler	back to summary
public EncodingHandler setNoEncodingHandler(HttpHandler noEncodingHandler)

toString back to summary

toString	back 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

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

io.undertow.server.handlers.encoding back to summary

public Class EncodingHandler.Builder

Class Inheritance

extends Object
implements HandlerBuilder

java.lang.Object
io.undertow.server.handlers.encoding.EncodingHandler.Builder

All Implemented Interfaces

io.undertow.server.handlers.builder.HandlerBuilder

Constructor Summary

Access	Constructor and Description
public	Builder()

Method Summary

Modifier and Type	Method and Description
public HandlerWrapper	build(Map<String, Object> The handler config config) Implements io.undertow.server.handlers.builder.HandlerBuilder.build. Creates the handler
public String	defaultParameter() Implements io.undertow.server.handlers.builder.HandlerBuilder.defaultParameter.
public String	name() Implements io.undertow.server.handlers.builder.HandlerBuilder.name. The string representation of the handler name.
public Map<String, Class<?>>	parameters() Implements io.undertow.server.handlers.builder.HandlerBuilder.parameters. Returns a map of parameters and their types.
public Set<String>	requiredParameters() Implements io.undertow.server.handlers.builder.HandlerBuilder.requiredParameters.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

Builder	back to summary
public Builder()

Method Detail

build	back to summary
public HandlerWrapper build(Map<String, Object> config) Implements io.undertow.server.handlers.builder.HandlerBuilder.build. Doc from io.undertow.server.handlers.builder.HandlerBuilder.build. Creates the handler Parameters config:Map<String, Object> The handler config Returns:HandlerWrapper The new predicate Annotations @Override

build

back to summary

public HandlerWrapper build(Map<String, Object> config)

Implements io.undertow.server.handlers.builder.HandlerBuilder.build.

Doc from io.undertow.server.handlers.builder.HandlerBuilder.build.

Creates the handler

Parameters

config:Map<String, Object>: The handler config

Returns:HandlerWrapper

The new predicate

Annotations

@Override

defaultParameter	back to summary
public String defaultParameter() Implements io.undertow.server.handlers.builder.HandlerBuilder.defaultParameter. Returns:String Doc from io.undertow.server.handlers.builder.HandlerBuilder.defaultParameter. The default parameter name, or null if it does not have a default parameter Annotations @Override

defaultParameter

back to summary

public String defaultParameter()

Implements io.undertow.server.handlers.builder.HandlerBuilder.defaultParameter.

Returns:String

Doc from io.undertow.server.handlers.builder.HandlerBuilder.defaultParameter.

The default parameter name, or null if it does not have a default parameter

Annotations

@Override

name	back to summary
public String name() Implements io.undertow.server.handlers.builder.HandlerBuilder.name. Doc from io.undertow.server.handlers.builder.HandlerBuilder.name. The string representation of the handler name. Returns:String The handler name Annotations @Override

name

back to summary

public String name()

Implements io.undertow.server.handlers.builder.HandlerBuilder.name.

Doc from io.undertow.server.handlers.builder.HandlerBuilder.name.

The string representation of the handler name.

Returns:String

The handler name

Annotations

@Override

parameters	back to summary
public Map<String, Class<?>> parameters() Implements io.undertow.server.handlers.builder.HandlerBuilder.parameters. Doc from io.undertow.server.handlers.builder.HandlerBuilder.parameters. Returns a map of parameters and their types. Annotations @Override

parameters

back to summary

public Map<String, Class<?>> parameters()

Implements io.undertow.server.handlers.builder.HandlerBuilder.parameters.

Doc from io.undertow.server.handlers.builder.HandlerBuilder.parameters.

Returns a map of parameters and their types.

Annotations

@Override

requiredParameters	back to summary
public Set<String> requiredParameters() Implements io.undertow.server.handlers.builder.HandlerBuilder.requiredParameters. Returns:Set<String> Doc from io.undertow.server.handlers.builder.HandlerBuilder.requiredParameters. The required parameters Annotations @Override

requiredParameters

back to summary

public Set<String> requiredParameters()

Implements io.undertow.server.handlers.builder.HandlerBuilder.requiredParameters.

Returns:Set<String>

Doc from io.undertow.server.handlers.builder.HandlerBuilder.requiredParameters.

The required parameters

Annotations