Modifier and Type	Class and Description
private class	GzipResponseAndCallback.GzipBufferCB
private static enum	GzipResponseAndCallback.GZState

Modifier and Type	Field and Description
private RetainableByteBuffer	_buffer
private final int	_bufferSize
private final Callback	_callback
private final CRC32	_crc
private CompressionPool<Deflater>.Entry	_deflaterEntry
private final GzipFactory	_factory
private boolean	_last
private final AtomicReference<GzipResponseAndCallback.GZState>	_state
private final boolean	_syncFlush
private static final byte[]	GZIP_HEADER
private static final int	GZIP_TRAILER_SIZE
private static final Logger	LOG
private static final byte	OS_UNKNOWN

Access	Constructor and Description
public	GzipResponseAndCallback(GzipHandler handler, Request request, Response response, Callback callback)

Method Summary

Modifier and Type	Method and Description
private void	addTrailer(ByteBuffer outputBuffer)
protected void	commit(boolean last, Callback callback, ByteBuffer content)
private String	etagGzip(String etag)
public void	failed(Throwable the reason for the operation failure x) Overrides default org.eclipse.jetty.util.Callback.failed. Callback invoked when the operation fails.
public Invocable.InvocationType	getInvocationType() Overrides default org.eclipse.jetty.util.thread.Invocable.getInvocationType.
private void	gzip(boolean complete, final Callback callback, ByteBuffer content)
public void	noCompression()
public void	succeeded() Overrides default org.eclipse.jetty.util.Callback.succeeded. Callback invoked when the operation completes.
public void	write(boolean whether the ByteBuffer is the last to write last, ByteBuffer the ByteBuffer to write content, Callback the callback to notify when the write operation is complete callback) Overrides org.eclipse.jetty.server.Response.Wrapper.write. Implements org.eclipse.jetty.server.Response.write. Writes the given `ByteBuffer`, notifying the `Callback` when the write is complete.

Inherited from org.eclipse.jetty.server.Response.Wrapper:: getHeaders getRequest getStatus getTrailersSupplier getWrapped hasLastWrite isCommitted isCompletedSuccessfully reset setStatus setTrailersSupplier writeInterim

Field Detail

_buffer	back to summary
private RetainableByteBuffer _buffer

_bufferSize	back to summary
private final int _bufferSize

_callback	back to summary
private final Callback _callback

_crc	back to summary
private final CRC32 _crc

_deflaterEntry	back to summary
private CompressionPool<Deflater>.Entry _deflaterEntry

_factory	back to summary
private final GzipFactory _factory

_last	back to summary
private boolean _last

_state	back to summary
private final AtomicReference<GzipResponseAndCallback.GZState> _state

_syncFlush	back to summary
private final boolean _syncFlush

GZIP_HEADER	back to summary
private static final byte[] GZIP_HEADER

GZIP_TRAILER_SIZE	back to summary
private static final int GZIP_TRAILER_SIZE

LOG	back to summary
private static final Logger LOG

OS_UNKNOWN	back to summary
private static final byte OS_UNKNOWN

GzipResponseAndCallback	back to summary
public GzipResponseAndCallback(GzipHandler handler, Request request, Response response, Callback callback)

Method Detail

addTrailer	back to summary
private void addTrailer(ByteBuffer outputBuffer)

commit	back to summary
protected void commit(boolean last, Callback callback, ByteBuffer content)

etagGzip	back to summary
private String etagGzip(String etag)

failed	back to summary
public void failed(Throwable x) Overrides default org.eclipse.jetty.util.Callback.failed. Doc from org.eclipse.jetty.util.Callback.failed. Callback invoked when the operation fails. Parameters x:Throwable the reason for the operation failure Annotations @Override

failed

back to summary

public void failed(Throwable x)

Overrides default org.eclipse.jetty.util.Callback.failed.

Doc from org.eclipse.jetty.util.Callback.failed.

Callback invoked when the operation fails.

Parameters

x:Throwable: the reason for the operation failure

Annotations

@Override

getInvocationType	back to summary
public Invocable.InvocationType getInvocationType() Overrides default org.eclipse.jetty.util.thread.Invocable.getInvocationType. Returns:Invocable.InvocationType Doc from org.eclipse.jetty.util.thread.Invocable.getInvocationType. The InvocationType of this object Annotations @Override

getInvocationType

back to summary

public Invocable.InvocationType getInvocationType()

Overrides default org.eclipse.jetty.util.thread.Invocable.getInvocationType.

Returns:Invocable.InvocationType

Doc from org.eclipse.jetty.util.thread.Invocable.getInvocationType.

The InvocationType of this object

Annotations

@Override

gzip	back to summary
private void gzip(boolean complete, final Callback callback, ByteBuffer content)

noCompression	back to summary
public void noCompression()

succeeded	back to summary
public void succeeded() Overrides default org.eclipse.jetty.util.Callback.succeeded. Doc from org.eclipse.jetty.util.Callback.succeeded. Callback invoked when the operation completes. Annotations @Override

succeeded

back to summary

public void succeeded()

Overrides default org.eclipse.jetty.util.Callback.succeeded.

Doc from org.eclipse.jetty.util.Callback.succeeded.

Callback invoked when the operation completes.

Annotations

@Override

write back to summary

write	back to summary
public void write(boolean last, ByteBuffer content, Callback callback) Overrides org.eclipse.jetty.server.Response.Wrapper.write. Implements org.eclipse.jetty.server.Response.write. Doc from org.eclipse.jetty.server.Response.write. Writes the given `ByteBuffer`, notifying the `Callback` when the write is complete. Implementations guarantee that calls to this method are safely reentrant so that stack overflows are avoided in the case of mutual recursion between the execution of the `Callback` and a call to this method. The invocation of the passed `Callback` is serialized with previous calls of this method, so that it is not invoked until any invocation of the callback of a previous call to this method has returned. Thus a `Callback` should not block waiting for a callback of a future call to this method. Parameters last:boolean whether the ByteBuffer is the last to write content:ByteBuffer the ByteBuffer to write callback:Callback the callback to notify when the write operation is complete Annotations @Override

public void write(boolean last, ByteBuffer content, Callback callback)

Overrides org.eclipse.jetty.server.Response.Wrapper.write.

Implements org.eclipse.jetty.server.Response.write.

Doc from org.eclipse.jetty.server.Response.write.

Writes the given ByteBuffer, notifying the Callback when the write is complete.

Implementations guarantee that calls to this method are safely reentrant so that stack overflows are avoided in the case of mutual recursion between the execution of the Callback and a call to this method.

The invocation of the passed Callback is serialized with previous calls of this method, so that it is not invoked until any invocation of the callback of a previous call to this method has returned.

Thus a Callback should not block waiting for a callback of a future call to this method.

Parameters

last:boolean: whether the ByteBuffer is the last to write
content:ByteBuffer: the ByteBuffer to write
callback:Callback: the callback to notify when the write operation is complete

Annotations

@Override

org.eclipse.jetty.server.handler.gzip back to summary

private Class GzipResponseAndCallback.GzipBufferCB

Class Inheritance

extends IteratingNestedCallback

java.lang.Object
org.eclipse.jetty.util.IteratingCallback
org.eclipse.jetty.util.IteratingNestedCallback
org.eclipse.jetty.server.handler.gzip.GzipResponseAndCallback.GzipBufferCB

Field Summary

Modifier and Type	Field and Description
private final ByteBuffer	_content
private final boolean	_last

Constructor Summary

Access	Constructor and Description
public	GzipBufferCB(boolean complete, Callback callback, ByteBuffer content)

Method Summary

Modifier and Type	Method and Description
private void	cleanup()
private IteratingCallback.Action	compressing(Deflater deflater, ByteBuffer outputBuffer) This method is called directly from `process()` to perform the compressing of the content this `GzipBufferCB` represents.
private IteratingCallback.Action	finishing(Deflater deflater, ByteBuffer outputBuffer) This method is called by `compressing(Deflater, ByteBuffer)`, once the last chunk is compressed; or directly from `process()` if an earlier call to this method was unable to complete.
private int	getFlushMode()
protected void	onCompleteFailure(Throwable the throwable to indicate cause of failure x) Overrides org.eclipse.jetty.util.IteratingNestedCallback.onCompleteFailure. Invoked when the overall task has completed with a failure.
protected IteratingCallback.Action	process() Implements abstract org.eclipse.jetty.util.IteratingCallback.process. Method called by `iterate()` to process the asynchronous sub-task.
public String	toString() Overrides org.eclipse.jetty.util.IteratingNestedCallback.toString. Returns a string representation of the object.
private void	write(boolean last, ByteBuffer outputBuffer)

Inherited from org.eclipse.jetty.util.IteratingNestedCallback:: getInvocationType onCompleteSuccess

Field Detail

_content	back to summary
private final ByteBuffer _content

_last	back to summary
private final boolean _last

Constructor Detail

GzipBufferCB	back to summary
public GzipBufferCB(boolean complete, Callback callback, ByteBuffer content)

Method Detail

cleanup	back to summary
private void cleanup()

compressing	back to summary
private IteratingCallback.Action compressing(Deflater deflater, ByteBuffer outputBuffer) This method is called directly from `process()` to perform the compressing of the content this `GzipBufferCB` represents.

finishing	back to summary
private IteratingCallback.Action finishing(Deflater deflater, ByteBuffer outputBuffer) This method is called by `compressing(Deflater, ByteBuffer)`, once the last chunk is compressed; or directly from `process()` if an earlier call to this method was unable to complete.

getFlushMode	back to summary
private int getFlushMode()

onCompleteFailure	back to summary
protected void onCompleteFailure(Throwable x) Overrides org.eclipse.jetty.util.IteratingNestedCallback.onCompleteFailure. Doc from org.eclipse.jetty.util.IteratingCallback.onCompleteFailure. Invoked when the overall task has completed with a failure. Parameters x:Throwable the throwable to indicate cause of failure Annotations @Override

onCompleteFailure

back to summary

protected void onCompleteFailure(Throwable x)

Overrides org.eclipse.jetty.util.IteratingNestedCallback.onCompleteFailure.

Doc from org.eclipse.jetty.util.IteratingCallback.onCompleteFailure.

Invoked when the overall task has completed with a failure.

Parameters

x:Throwable: the throwable to indicate cause of failure

Annotations

@Override

process back to summary

process	back to summary
protected IteratingCallback.Action process() throws Exception Implements abstract org.eclipse.jetty.util.IteratingCallback.process. Doc from org.eclipse.jetty.util.IteratingCallback.process. Method called by `iterate()` to process the asynchronous sub-task. Implementations must initiate the asynchronous execution of the sub-task (if any) and return an appropriate action: `Action#IDLE` when no sub tasks are available for execution but the overall job is not completed yet `Action#SCHEDULED` when the sub task asynchronous execution has been started `Action#SUCCEEDED` when the overall job is completed Returns:IteratingCallback.Action the appropriate Action Annotations @Override

protected IteratingCallback.Action process() throws Exception

Implements abstract org.eclipse.jetty.util.IteratingCallback.process.

Doc from org.eclipse.jetty.util.IteratingCallback.process.

Method called by iterate() to process the asynchronous sub-task.

Implementations must initiate the asynchronous execution of the sub-task (if any) and return an appropriate action:

Action#IDLE when no sub tasks are available for execution but the overall job is not completed yet
Action#SCHEDULED when the sub task asynchronous execution has been started
Action#SUCCEEDED when the overall job is completed

Returns:IteratingCallback.Action

the appropriate Action

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides org.eclipse.jetty.util.IteratingNestedCallback.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 org.eclipse.jetty.util.IteratingNestedCallback.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

write	back to summary
private void write(boolean last, ByteBuffer outputBuffer)

org.eclipse.jetty.server.handler.gzip back to summary

private final Enum GzipResponseAndCallback.GZState

Class Inheritance

extends Enum<GzipResponseAndCallback.GZState>

java.lang.Object
java.lang.Enum
org.eclipse.jetty.server.handler.gzip.GzipResponseAndCallback.GZState

Field Summary

Modifier and Type	Field and Description
public static final GzipResponseAndCallback.GZState	COMMITTING
public static final GzipResponseAndCallback.GZState	COMPRESSING
public static final GzipResponseAndCallback.GZState	FINISHED
public static final GzipResponseAndCallback.GZState	FINISHING
public static final GzipResponseAndCallback.GZState	MIGHT_COMPRESS
public static final GzipResponseAndCallback.GZState	NOT_COMPRESSING

Constructor Summary

Access	Constructor and Description
private	GZState()

Method Summary

Modifier and Type	Method and Description
public static GzipResponseAndCallback.GZState	valueOf(String name)
public static GzipResponseAndCallback.GZState[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

COMMITTING	back to summary
public static final GzipResponseAndCallback.GZState COMMITTING

COMPRESSING	back to summary
public static final GzipResponseAndCallback.GZState COMPRESSING

FINISHED	back to summary
public static final GzipResponseAndCallback.GZState FINISHED

FINISHING	back to summary
public static final GzipResponseAndCallback.GZState FINISHING

MIGHT_COMPRESS	back to summary
public static final GzipResponseAndCallback.GZState MIGHT_COMPRESS

NOT_COMPRESSING	back to summary
public static final GzipResponseAndCallback.GZState NOT_COMPRESSING

Constructor Detail

GZState	back to summary
private GZState()

Method Detail

valueOf	back to summary
public static GzipResponseAndCallback.GZState valueOf(String name)

values	back to summary
public static GzipResponseAndCallback.GZState[] values()

public Class GzipResponseAndCallback

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class GzipResponseAndCallback.GzipBufferCB

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum GzipResponseAndCallback.GZState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail