org.glassfish.jersey.media.multipart

Class MultiPartProperties

java.lang.Object

org.glassfish.jersey.media.multipart.MultiPartProperties

public class MultiPartProperties
extends Object

Injectable JavaBean containing the configuration parameters for jersey-multipart as used in this particular application.

Author:

Craig McClanahan, Paul Sandoz, Michal Gajdos

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUFFER_THRESHOLD Name of the resource property for the threshold size (in bytes) above which a body part entity will be buffered to disk instead of being held in memory.
static int	BUFFER_THRESHOLD_MEMORY_ONLY The BUFFER_THRESHOLD property value to keep a body part entity in memory only.
static int	DEFAULT_BUFFER_THRESHOLD Default threshold size for buffer.
static String	MAX_PARTS Limit the maximum number of parts the multipart entity can have.
static String	MULTI_PART_CONFIG_RESOURCE Name of a properties resource that (if found in the classpath for this application) will be used to configure the settings returned by our getter methods.
static String	TEMP_DIRECTORY Name of the resource property for the directory to store temporary files containing body parts of multipart message that extends allowed memory threshold.

Constructor Summary

Constructors

Constructor and Description
MultiPartProperties() Load and customize (if necessary) the configuration values for the jersey-multipart injection binder.

Method Summary

Modifier and Type	Method and Description
MultiPartProperties	bufferThreshold(int threshold) Set the size (in bytes) of the entity of an incoming BodyPart before it will be buffered to disk.
int	getBufferThreshold() Get the size (in bytes) of the entity of an incoming BodyPart before it will be buffered to disk.
int	getMaxParts() Return maximum number of entity parts allowed.
String	getTempDir() Get the directory to store temporary files containing body parts of multipart message that extends allowed memory threshold.
MultiPartProperties	maxParts(int maxParts) Set the maximum number of received parts of a multipart entity.
ContextResolver<MultiPartProperties>	resolver() Create a context resolver for a current state of this MultiPartProperties.
MultiPartProperties	tempDir(String path) Set the path to the directory to store temporary files containing body parts of multipart message that extends allowed memory threshold.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BUFFER_THRESHOLD

public static final int DEFAULT_BUFFER_THRESHOLD

Default threshold size for buffer.

MULTI_PART_CONFIG_RESOURCE

public static final String MULTI_PART_CONFIG_RESOURCE

Name of a properties resource that (if found in the classpath for this application) will be used to configure the settings returned by our getter methods.

The resource name is jersey-multipart-config.properties.

See Also:

Constant Field Values

BUFFER_THRESHOLD

public static final String BUFFER_THRESHOLD

Name of the resource property for the threshold size (in bytes) above which a body part entity will be buffered to disk instead of being held in memory. The default value is DEFAULT_BUFFER_THRESHOLD.

See Also:

Constant Field Values

BUFFER_THRESHOLD_MEMORY_ONLY

public static final int BUFFER_THRESHOLD_MEMORY_ONLY

The BUFFER_THRESHOLD property value to keep a body part entity in memory only.

See Also:

Constant Field Values

MAX_PARTS

public static final String MAX_PARTS

Limit the maximum number of parts the multipart entity can have. If the limit is over, the error response status Response.Status.REQUEST_ENTITY_TOO_LARGE is returned.

By default, the number is unlimited.

Since:

2.44

See Also:

Constant Field Values

TEMP_DIRECTORY

public static final String TEMP_DIRECTORY

Name of the resource property for the directory to store temporary files containing body parts of multipart message that extends allowed memory threshold. The default value is not set (will be taken from java.io.tmpdir system property).

See Also:

Constant Field Values

Constructor Detail

MultiPartProperties

public MultiPartProperties()

Load and customize (if necessary) the configuration values for the jersey-multipart injection binder.

Throws:

IllegalArgumentException - if the configuration resource exists, but there are problems reading it

Method Detail

getBufferThreshold

public int getBufferThreshold()

Get the size (in bytes) of the entity of an incoming BodyPart before it will be buffered to disk. If not customized, the default value is 4096.

Returns:

return threshold size for starting to buffer the incoming entity to disk.

getTempDir

public String getTempDir()

Get the directory to store temporary files containing body parts of multipart message that extends allowed memory threshold.

Returns:

path to the temporary directory.

Since:

2.4.1

getMaxParts

public int getMaxParts()

Return maximum number of entity parts allowed.

Returns:

maximum number of parts.

Since:

2.44

bufferThreshold

public MultiPartProperties bufferThreshold(int threshold)

Set the size (in bytes) of the entity of an incoming BodyPart before it will be buffered to disk.

Parameters:

threshold - size of body part.

Returns:

MultiPartProperties instance.

Since:

2.4.1

tempDir

public MultiPartProperties tempDir(String path)

Set the path to the directory to store temporary files containing body parts of multipart message that extends allowed memory threshold.

Parameters:

path - path to the temporary directory.

Returns:

MultiPartProperties instance.

Since:

2.4.1

maxParts

public MultiPartProperties maxParts(int maxParts)

Set the maximum number of received parts of a multipart entity.

Parameters:

maxParts - The maximum number of entity parts.

Returns:

MultiPartProperties instance.

Since:

2.44

resolver

public ContextResolver<MultiPartProperties> resolver()

Create a context resolver for a current state of this MultiPartProperties.

Returns:

context resolver for this config.

Since:

2.4.1