Top Description Inners Fields Constructors Methods
io.undertow.server.handlers.encoding

public Class RequestEncodingHandler

extends Object
implements HttpHandler
Class Inheritance
All Implemented Interfaces
io.undertow.server.HttpHandler
Imports
java.util.Collections, .Map, .Set, org.xnio.conduits.StreamSourceConduit, io.undertow.conduits.GzipStreamSourceConduit, .InflatingStreamSourceConduit, io.undertow.server.ConduitWrapper, .HandlerWrapper, .HttpHandler, .HttpServerExchange, io.undertow.server.handlers.builder.HandlerBuilder, io.undertow.util.CopyOnWriteMap, .Headers
Handler that serves as the basis for request content encoding.

This is not part of the HTTP spec, however there are some applications where it is useful.

It behaves in a similar manner to EncodingHandler, however it deals with the requests content encoding.

Author
Stuart Douglas

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
RequestEncodingHandler.Builder

Field Summary

Modifier and TypeField and Description
private final HttpHandler
next

private final Map<String, ConduitWrapper<StreamSourceConduit>>
requestEncodings

Constructor Summary

AccessConstructor and Description
public
RequestEncodingHandler(final HttpHandler next)

Method Summary

Modifier and TypeMethod and Description
public RequestEncodingHandler
addEncoding(String name, ConduitWrapper<StreamSourceConduit> wrapper)

public HttpHandler
getNext()

public void
handleRequest(final HttpServerExchange
the HTTP request/response exchange
exchange)

Implements io.undertow.server.HttpHandler.handleRequest.

Handle the request.

public RequestEncodingHandler
removeEncoding(String encoding)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

nextback to summary
private final HttpHandler next
requestEncodingsback to summary
private final Map<String, ConduitWrapper<StreamSourceConduit>> requestEncodings

Constructor Detail

RequestEncodingHandlerback to summary
public RequestEncodingHandler(final HttpHandler next)

Method Detail

addEncodingback to summary
public RequestEncodingHandler addEncoding(String name, ConduitWrapper<StreamSourceConduit> wrapper)
getNextback to summary
public HttpHandler getNext()
handleRequestback 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
removeEncodingback to summary
public RequestEncodingHandler removeEncoding(String encoding)
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
io.undertow.server.handlers.encoding back to summary

public Class RequestEncodingHandler.Builder

extends Object
implements HandlerBuilder
Class Inheritance
  • java.lang.Object
  • io.undertow.server.handlers.encoding.RequestEncodingHandler.Builder
All Implemented Interfaces
io.undertow.server.handlers.builder.HandlerBuilder

Constructor Summary

AccessConstructor and Description
public
Builder()

Method Summary

Modifier and TypeMethod 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:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Builderback to summary
public Builder()

Method Detail

buildback 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
defaultParameterback 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
nameback 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
parametersback 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
requiredParametersback 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