Top Description Fields Constructors Methods

io.undertow.server.handlers.encoding

public Class AllowedContentEncodings

Class Inheritance

extends Object
implements ConduitWrapper<StreamSinkConduit>

java.lang.Object
io.undertow.server.handlers.encoding.AllowedContentEncodings

All Implemented Interfaces

io.undertow.server.ConduitWrapper

Imports

java.util.List, io.undertow.server.ConduitWrapper, .HttpServerExchange, io.undertow.util.AttachmentKey, .ConduitFactory, .Headers, .Methods, .StatusCodes, org.xnio.conduits.StreamSinkConduit

An attachment that provides information about the current content encoding that will be chosen for the response

Author: Stuart Douglas

Field Summary

Modifier and Type	Field and Description
public static final AttachmentKey<AllowedContentEncodings>	ATTACHMENT_KEY
private final List<EncodingMapping>	encodings
private final HttpServerExchange	exchange

Constructor Summary

Access	Constructor and Description
public	AllowedContentEncodings(final HttpServerExchange exchange, final List<EncodingMapping> encodings)

Method Summary

Modifier and Type	Method and Description
public String	Returns: The content encoding that will be set, given the current state of the HttpServerExchange getCurrentContentEncoding()
public EncodingMapping	getEncoding()
public boolean	isIdentity()
public boolean	isNoEncodingsAllowed() If the list of allowed encodings was empty then it means that no encodings were allowed, and identity was explicitly prohibited with a q value of 0.
public StreamSinkConduit	wrap(final ConduitFactory<StreamSinkConduit> the original conduit factory, final HttpServerExchange the in-flight HTTP exchange exchange) Implements io.undertow.server.ConduitWrapper.wrap. Wrap the conduit.

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

Field Detail

ATTACHMENT_KEY	back to summary
public static final AttachmentKey<AllowedContentEncodings> ATTACHMENT_KEY

encodings	back to summary
private final List<EncodingMapping> encodings

exchange	back to summary
private final HttpServerExchange exchange

Constructor Detail

AllowedContentEncodings	back to summary
public AllowedContentEncodings(final HttpServerExchange exchange, final List<EncodingMapping> encodings)

Method Detail

getCurrentContentEncoding	back to summary
public String getCurrentContentEncoding() Returns:String The content encoding that will be set, given the current state of the HttpServerExchange

getEncoding	back to summary
public EncodingMapping getEncoding()

isIdentity	back to summary
public boolean isIdentity()

isNoEncodingsAllowed	back to summary
public boolean isNoEncodingsAllowed() If the list of allowed encodings was empty then it means that no encodings were allowed, and identity was explicitly prohibited with a q value of 0.

wrap back to summary

public StreamSinkConduit wrap(final ConduitFactory<StreamSinkConduit> factory, final HttpServerExchange exchange)

Implements io.undertow.server.ConduitWrapper.wrap.

Doc from io.undertow.server.ConduitWrapper.wrap.

Wrap the conduit. The wrapper should not return null. If no wrapping is desired, the original conduit should be returned.

Parameters

factory:ConduitFactory<StreamSinkConduit>: the original conduit
exchange:HttpServerExchange: the in-flight HTTP exchange

Returns:StreamSinkConduit

the replacement conduit

Annotations

@Override