Module org.eclipse.jetty.server

Package org.eclipse.jetty.server.handler

Class EagerContentHandler.RetainedContentLoaderFactory

java.lang.Object

org.eclipse.jetty.server.handler.EagerContentHandler.RetainedContentLoaderFactory

All Implemented Interfaces:

EagerContentHandler.ContentLoaderFactory

Enclosing class:

EagerContentHandler

public static class EagerContentHandler.RetainedContentLoaderFactory
extends Object
implements EagerContentHandler.ContentLoaderFactory

An EagerContentHandler.ContentLoaderFactory for any content, that uses Retainable.retain() to eagerly load content with zero copies, until all content is read or a maximum size is exceeded.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EagerContentHandler.RetainedContentLoaderFactory.RetainedContentLoader	Delay dispatch until all content or an effective buffer size is reached

Constructor Summary

Constructors

Constructor	Description
RetainedContentLoaderFactory()	Creates a RetainedContentLoaderFactory with heuristically determined values for the maximum number bytes to retain and the number of bytes to include in the estimated size per Content.Chunk to allow for framing overheads in the transport and no rejection of the request when the maximum number bytes to retain is exceeded.
RetainedContentLoaderFactory(long maxRetainedBytes, int framingOverhead, boolean reject)	Creates a RetainedContentLoaderFactory.

Method Summary

Modifier and Type	Method	Description
String	getApplicableMimeType()
EagerContentHandler.ContentLoader	newContentLoader(String contentType, String mimeType, Handler handler, Request request, Response response, org.eclipse.jetty.util.Callback callback)

Methods inherited from class java.lang.Object

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

Constructor Details

RetainedContentLoaderFactory

public RetainedContentLoaderFactory()

Creates a RetainedContentLoaderFactory with heuristically determined values for the maximum number bytes to retain and the number of bytes to include in the estimated size per Content.Chunk to allow for framing overheads in the transport and no rejection of the request when the maximum number bytes to retain is exceeded.

RetainedContentLoaderFactory

public RetainedContentLoaderFactory(long maxRetainedBytes,
 int framingOverhead,
 boolean reject)

Creates a RetainedContentLoaderFactory.

Parameters:

maxRetainedBytes - the maximum number bytes to retain whilst eagerly loading, which includes the content bytes and any framingOverhead per chunk; or -1 for a heuristically determined value that will not increase memory commitment.

framingOverhead - the number of bytes to include in the estimated size per Content.Chunk to allow for framing overheads in the transport. Since the content is retained rather than copied, any framing data is also retained in the IO buffer; or -1 for a heuristically determined value.

reject - if true, then if maxRetainBytes is exceeded, the request is rejected with a HttpStatus.PAYLOAD_TOO_LARGE_413 response.

Method Details

getApplicableMimeType

public String getApplicableMimeType()

Specified by:

getApplicableMimeType in interface EagerContentHandler.ContentLoaderFactory

Returns:

The mimetype for which this factory is applicable to; or null if applicable to all types.

newContentLoader

public EagerContentHandler.ContentLoader newContentLoader(String contentType,
 String mimeType,
 Handler handler,
 Request request,
 Response response,
 org.eclipse.jetty.util.Callback callback)

Specified by:

newContentLoader in interface EagerContentHandler.ContentLoaderFactory

Parameters:

contentType - The content type of the request

mimeType - The mime type extracted from the request

handler - The next handler to call

request - The request

response - The response

callback - The callback

Returns:

An EagerContentHandler.ContentLoader instance if the content can be loaded eagerly, else null.