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.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    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 final int
    The BUFFER_THRESHOLD property value to keep a body part entity in memory only.
    private int
    The threshold size (in bytes) above which a body part entity will be buffered to disk instead of being held in memory.
    static final int
    Default threshold size for buffer.
    static final String
    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 final String
    Name of the resource property for the directory to store temporary files containing body parts of multipart message that extends allowed memory threshold..
    private String
    Directory to store temporary files containing body parts of multipart message that extends allowed memory threshold.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Load and customize (if necessary) the configuration values for the jersey-multipart injection binder.
  • Method Summary

    Modifier and Type
    Method
    Description
    bufferThreshold(int threshold)
    Set the size (in bytes) of the entity of an incoming BodyPart before it will be buffered to disk.
    private void
    Configure the values returned by this instance's getters based on the contents of a properties resource, if it exists on the classpath for this application.
    int
    Get the size (in bytes) of the entity of an incoming BodyPart before it will be buffered to disk.
    Get the directory to store temporary files containing body parts of multipart message that extends allowed memory threshold.
    javax.ws.rs.ext.ContextResolver<MultiPartProperties>
    Create a context resolver for a current state of this MultiPartProperties.
    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 Details

    • DEFAULT_BUFFER_THRESHOLD

      public static final int DEFAULT_BUFFER_THRESHOLD
      Default threshold size for buffer.
      See Also:
    • 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.
      See Also:
    • 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 4096.
      See Also:
    • 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:
    • 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:
    • bufferThreshold

      private int bufferThreshold
      The threshold size (in bytes) above which a body part entity will be buffered to disk instead of being held in memory.
    • tempDir

      private String tempDir
      Directory to store temporary files containing body parts of multipart message that extends allowed memory threshold.
  • Constructor Details

    • 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 Details

    • 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
    • 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
    • configure

      private void configure()
      Configure the values returned by this instance's getters based on the contents of a properties resource, if it exists on the classpath for this application.
      Throws:
      IllegalArgumentException - if the configuration resource exists, but there are problems reading it
    • resolver

      public javax.ws.rs.ext.ContextResolver<MultiPartProperties> resolver()
      Create a context resolver for a current state of this MultiPartProperties.
      Returns:
      context resolver for this config.
      Since:
      2.4.1