Class CompressionConfig

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.compression.server.CompressionConfig

All Implemented Interfaces:

LifeCycle

@ManagedObject("Compression Configuration")
public class CompressionConfig
extends AbstractLifeCycle

Configuration for a specific compression behavior per matching path from the CompressionHandler.

Configuration is split between compression (of responses) and decompression (of requests).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CompressionConfig.Builder	The builder of CompressionConfig immutable instances.

Nested classes/interfaces inherited from class AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopException

Nested classes/interfaces inherited from interface LifeCycle

LifeCycle.Listener

Field Summary

Fields inherited from class AbstractLifeCycle

FAILED, STARTED, STARTING, STOPPED, STOPPING

Method Summary

Modifier and Type	Method	Description
static CompressionConfig.Builder	builder()
Set<String>	getCompressExcludeEncodings()
Set<String>	getCompressExcludeMethods()
Set<String>	getCompressExcludeMimeTypes()
Set<String>	getCompressExcludePaths()
Set<String>	getCompressIncludeEncodings()
Set<String>	getCompressIncludeMethods()
Set<String>	getCompressIncludeMimeTypes()
Set<String>	getCompressIncludePaths()
List<String>	getCompressPreferredEncodings()
Set<String>	getDecompressExcludeMethods()
Set<String>	getDecompressExcludePaths()
Set<String>	getDecompressIncludeMethods()
Set<String>	getDecompressIncludePaths()
boolean	isCompressMethodSupported(String method)
boolean	isCompressMimeTypeSupported(String mimeType)
boolean	isDecompressMethodSupported(String method)
boolean	isDecompressMimeTypeSupported(String mimeType)

Methods inherited from class AbstractLifeCycle

addEventListener, doStart, doStop, getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeEventListener, setEventListeners, start, stop, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

builder

public static CompressionConfig.Builder builder()

Returns:

a new CompressionConfig.Builder to configure a CompressionConfig instance

getCompressExcludeEncodings

@ManagedAttribute("Encodings that disable response compression")
public Set<String> getCompressExcludeEncodings()

Returns:

the encodings that disable response compression

See Also:

• getCompressIncludeEncodings()

getCompressExcludeMethods

@ManagedAttribute("HTTP methods that disable response compression")
public Set<String> getCompressExcludeMethods()

Returns:

the HTTP methods that disable response compression

See Also:

• getCompressIncludeMethods()

getCompressExcludeMimeTypes

@ManagedAttribute("MIME types that disable response compression")
public Set<String> getCompressExcludeMimeTypes()

Returns:

the MIME types that disable response compression

See Also:

• getCompressIncludeMimeTypes()

getCompressExcludePaths

@ManagedAttribute("Path specs that exclude response compression")
public Set<String> getCompressExcludePaths()

Returns:

the path specs that exclude response compression

See Also:

• getCompressIncludePaths()

getCompressIncludeEncodings

@ManagedAttribute("Encodings that enable response compression")
public Set<String> getCompressIncludeEncodings()

Returns:

the encodings that enable response compression

See Also:

• getCompressExcludeEncodings()

getCompressIncludeMethods

@ManagedAttribute("HTTP methods that enable response compression")
public Set<String> getCompressIncludeMethods()

Returns:

HTTP methods that enable response compression

See Also:

• getCompressExcludeMethods()

getCompressIncludeMimeTypes

@ManagedAttribute("MIME types that enable response compression")
public Set<String> getCompressIncludeMimeTypes()

Returns:

the MIME types that enable response compression

See Also:

• getCompressExcludeMimeTypes()

getCompressIncludePaths

@ManagedAttribute("Path specs that enable response compression")
public Set<String> getCompressIncludePaths()

Returns:

the path specs that enable response compression

See Also:

• getCompressExcludePaths()

getCompressPreferredEncodings

@ManagedAttribute("Encodings for response compression in preferred order")
public List<String> getCompressPreferredEncodings()

Returns:

the encodings for response compression in preferred order

getDecompressExcludeMethods

@ManagedAttribute("HTTP methods that disable request decompression")
public Set<String> getDecompressExcludeMethods()

Returns:

the HTTP methods that disable request decompression

See Also:

• getDecompressIncludeMethods()

getDecompressExcludePaths

@ManagedAttribute("Path specs that disable request decompression")
public Set<String> getDecompressExcludePaths()

Returns:

the path specs that disable request decompression

See Also:

• getDecompressIncludePaths()

getDecompressIncludeMethods

@ManagedAttribute("HTTP methods that enable request decompression")
public Set<String> getDecompressIncludeMethods()

Returns:

the HTTP methods that enable request decompression

See Also:

• getDecompressExcludeMethods()

getDecompressIncludePaths

@ManagedAttribute("Path specs that enable request decompression")
public Set<String> getDecompressIncludePaths()

Returns:

the path specs that enable request decompression

See Also:

• getDecompressExcludePaths()

isCompressMethodSupported

public boolean isCompressMethodSupported(String method)

isCompressMimeTypeSupported

public boolean isCompressMimeTypeSupported(String mimeType)

isDecompressMethodSupported

public boolean isDecompressMethodSupported(String method)

isDecompressMimeTypeSupported

public boolean isDecompressMimeTypeSupported(String mimeType)