org.glassfish.jersey.media.multipart.MultiPartProperties Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jersey-min Show documentation
Show all versions of jersey-min Show documentation
jersey-min is a rebundled (minmal) verison of Jersey as one OSGi bundle.
The newest version!
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2015 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.jersey.media.multipart;
import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;
import javax.ws.rs.ext.ContextResolver;
import org.glassfish.jersey.internal.util.PropertiesClass;
/**
* Injectable JavaBean containing the configuration parameters for
* {@code jersey-multipart} as used in this particular application.
*
* @author Craig McClanahan
* @author Paul Sandoz
* @author Michal Gajdos
*/
@PropertiesClass
public class MultiPartProperties {
/**
* Default threshold size for buffer.
*/
public static final int DEFAULT_BUFFER_THRESHOLD = 4096;
/**
* 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.
*/
public static final String MULTI_PART_CONFIG_RESOURCE = "jersey-multipart-config.properties";
/**
* 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 {@value #DEFAULT_BUFFER_THRESHOLD}.
*/
public static final String BUFFER_THRESHOLD = "jersey.config.multipart.bufferThreshold";
/**
* The {@link #BUFFER_THRESHOLD} property value to keep a body part entity in memory only.
*/
public static final int BUFFER_THRESHOLD_MEMORY_ONLY = -1;
/**
* 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 {@code java.io.tmpdir} system property).
*/
public static final String TEMP_DIRECTORY = "jersey.config.multipart.tempDir";
/**
* The threshold size (in bytes) above which a body part entity will be
* buffered to disk instead of being held in memory.
*/
private int bufferThreshold = DEFAULT_BUFFER_THRESHOLD;
/**
* Directory to store temporary files containing body parts of multipart message that extends allowed memory threshold.
*/
private String tempDir = null;
/**
* Load and customize (if necessary) the configuration values for the
* {@code jersey-multipart} injection binder.
*
* @throws IllegalArgumentException if the configuration resource
* exists, but there are problems reading it
*/
public MultiPartProperties() {
configure();
}
/**
* Get the size (in bytes) of the entity of an incoming
* {@link BodyPart} before it will be buffered to disk. If not
* customized, the default value is 4096.
*
* @return return threshold size for starting to buffer the incoming entity
* to disk.
*/
public int getBufferThreshold() {
return bufferThreshold;
}
/**
* Get the directory to store temporary files containing body parts of multipart message that extends allowed memory
* threshold.
*
* @return path to the temporary directory.
* @since 2.4.1
*/
public String getTempDir() {
return tempDir;
}
/**
* Set the size (in bytes) of the entity of an incoming {@link BodyPart} before it will be buffered to disk.
*
* @param threshold size of body part.
* @return {@code MultiPartProperties} instance.
* @since 2.4.1
*/
public MultiPartProperties bufferThreshold(final int threshold) {
this.bufferThreshold = threshold < BUFFER_THRESHOLD_MEMORY_ONLY ? BUFFER_THRESHOLD_MEMORY_ONLY : threshold;
return this;
}
/**
* Set the path to the directory to store temporary files containing body parts of multipart message that extends allowed
* memory threshold.
*
* @param path path to the temporary directory.
* @return {@code MultiPartProperties} instance.
* @since 2.4.1
*/
public MultiPartProperties tempDir(final String path) {
this.tempDir = path;
return this;
}
/**
* 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
*/
private void configure() {
// Identify the class loader we will use
ClassLoader loader = Thread.currentThread().getContextClassLoader();
if (loader == null) {
loader = this.getClass().getClassLoader();
}
// Attempt to find our properties resource
InputStream stream = null;
try {
stream = loader.getResourceAsStream(MULTI_PART_CONFIG_RESOURCE);
if (stream == null) {
return;
}
final Properties props = new Properties();
props.load(stream);
if (props.containsKey(BUFFER_THRESHOLD)) {
this.bufferThreshold = Integer.parseInt(props.getProperty(BUFFER_THRESHOLD));
}
if (props.containsKey(TEMP_DIRECTORY)) {
this.tempDir = props.getProperty(TEMP_DIRECTORY);
}
} catch (final IOException e) {
throw new IllegalArgumentException(e);
} finally {
if (stream != null) {
try {
stream.close();
} catch (final IOException e) {
// Pass through
}
}
}
}
/**
* Create a {@link ContextResolver context resolver} for a current state of this {@code MultiPartProperties}.
*
* @return context resolver for this config.
* @since 2.4.1
*/
public ContextResolver resolver() {
return new ContextResolver() {
@Override
public MultiPartProperties getContext(final Class type) {
return MultiPartProperties.this;
}
};
}
}