FormDataParamValueParamProvider.java
/*
* Copyright (c) 2012, 2024 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package org.glassfish.jersey.media.multipart.internal;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.lang.annotation.Annotation;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.function.Function;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.stream.Collectors;
import javax.ws.rs.BadRequestException;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.ext.MessageBodyReader;
import javax.inject.Provider;
import org.glassfish.jersey.internal.inject.ExtractorException;
import org.glassfish.jersey.internal.util.ReflectionHelper;
import org.glassfish.jersey.internal.util.collection.MultivaluedStringMap;
import org.glassfish.jersey.media.multipart.BodyPartEntity;
import org.glassfish.jersey.media.multipart.FormDataBodyPart;
import org.glassfish.jersey.media.multipart.FormDataContentDisposition;
import org.glassfish.jersey.media.multipart.FormDataMultiPart;
import org.glassfish.jersey.media.multipart.FormDataParam;
import org.glassfish.jersey.media.multipart.FormDataParamException;
import org.glassfish.jersey.message.MessageBodyWorkers;
import org.glassfish.jersey.message.MessageUtils;
import org.glassfish.jersey.message.internal.Utils;
import org.glassfish.jersey.server.ContainerRequest;
import org.glassfish.jersey.server.internal.inject.AbstractValueParamProvider;
import org.glassfish.jersey.server.internal.inject.MultivaluedParameterExtractor;
import org.glassfish.jersey.server.internal.inject.MultivaluedParameterExtractorProvider;
import org.glassfish.jersey.server.model.Parameter;
import org.jvnet.mimepull.MIMEParsingException;
/**
* Value supplier provider supporting the {@link FormDataParam} injection annotation and entity ({@link FormDataMultiPart})
* injection.
*
* @author Craig McClanahan
* @author Paul Sandoz
* @author Michal Gajdos
*/
final class FormDataParamValueParamProvider extends AbstractValueParamProvider {
private static final Logger LOGGER = Logger.getLogger(FormDataParamValueParamProvider.class.getName());
private abstract class ValueProvider<T> implements Function<ContainerRequest, T> {
/**
* Returns a {@code FormDataMultiPart} entity from the request and stores it in the request context properties.
*
* @return a form data multi part entity.
*/
FormDataMultiPart getEntity(ContainerRequest request) {
final String requestPropertyName = FormDataMultiPart.class.getName();
Object entity = request.getProperty(requestPropertyName);
if (entity == null) {
entity = request.readEntity(FormDataMultiPart.class);
if (entity == null) {
throw new BadRequestException(LocalizationMessages.ENTITY_IS_EMPTY());
}
request.setProperty(requestPropertyName, entity);
}
return (FormDataMultiPart) entity;
}
}
/**
* Provider supplier for entity of {@code FormDataMultiPart} type.
*/
private final class FormDataMultiPartProvider extends ValueProvider<FormDataMultiPart> {
@Override
public FormDataMultiPart apply(ContainerRequest request) {
return getEntity(request);
}
}
/**
* Provider supplier for list of {@link org.glassfish.jersey.media.multipart.FormDataBodyPart} types injected via
* {@link FormDataParam} annotation.
*/
private final class ListFormDataBodyPartValueProvider extends ValueProvider<List<FormDataBodyPart>> {
private final String name;
public ListFormDataBodyPartValueProvider(final String name) {
this.name = name;
}
@Override
public List<FormDataBodyPart> apply(ContainerRequest request) {
return getEntity(request).getFields(name);
}
}
/**
* Provider supplier for list of {@link org.glassfish.jersey.media.multipart.FormDataContentDisposition} types injected via
* {@link FormDataParam} annotation.
*/
private final class ListFormDataContentDispositionProvider extends ValueProvider<List<FormDataContentDisposition>> {
private final String name;
public ListFormDataContentDispositionProvider(final String name) {
this.name = name;
}
@Override
public List<FormDataContentDisposition> apply(ContainerRequest request) {
final List<FormDataBodyPart> parts = getEntity(request).getFields(name);
return parts == null ? null : parts.stream()
.map(FormDataBodyPart::getFormDataContentDisposition)
.collect(Collectors.toList());
}
}
/**
* Provider supplier for {@link org.glassfish.jersey.media.multipart.FormDataBodyPart} types injected via
* {@link FormDataParam} annotation.
*/
private final class FormDataBodyPartProvider extends ValueProvider<FormDataBodyPart> {
private final String name;
public FormDataBodyPartProvider(final String name) {
this.name = name;
}
@Override
public FormDataBodyPart apply(ContainerRequest request) {
return getEntity(request).getField(name);
}
}
/**
* Provider supplier for {@link org.glassfish.jersey.media.multipart.FormDataContentDisposition} types injected via
* {@link FormDataParam} annotation.
*/
private final class FormDataContentDispositionProvider extends ValueProvider<FormDataContentDisposition> {
private final String name;
public FormDataContentDispositionProvider(final String name) {
this.name = name;
}
@Override
public FormDataContentDisposition apply(ContainerRequest request) {
final FormDataBodyPart part = getEntity(request).getField(name);
return part == null ? null : part.getFormDataContentDisposition();
}
}
/**
* Provider supplier for {@link java.io.File} types injected via {@link FormDataParam} annotation.
*/
private final class FileProvider extends ValueProvider<File> {
private final String name;
public FileProvider(final String name) {
this.name = name;
}
@Override
public File apply(ContainerRequest request) {
final FormDataBodyPart part = getEntity(request).getField(name);
final BodyPartEntity entity = part != null ? part.getEntityAs(BodyPartEntity.class) : null;
if (entity != null) {
try {
// Create a temporary file.
final File file = Utils.createTempFile();
// Move the part (represented either via stream or file) to the specific temporary file.
entity.moveTo(file);
return file;
} catch (final IOException | MIMEParsingException cannotMove) {
// Unable to create a temporary file or move the file.
LOGGER.log(Level.WARNING, LocalizationMessages.CANNOT_INJECT_FILE(), cannotMove);
}
}
return null;
}
}
/**
* Provider supplier for generic types injected via {@link FormDataParam} annotation.
*/
private final class FormDataParamValueProvider extends ValueProvider<Object> {
private final MultivaluedParameterExtractor<?> extractor;
private final Parameter parameter;
public FormDataParamValueProvider(Parameter parameter, MultivaluedParameterExtractor<?> extractor) {
this.parameter = parameter;
this.extractor = extractor;
}
@Override
public Object apply(ContainerRequest request) {
// Return the field value for the field specified by the sourceName property.
final String sourceName = parameter.getAnnotations().length == 1
? parameter.getSourceName()
: Arrays.stream(parameter.getAnnotations())
.filter(ann -> FormDataParam.class.isInstance(ann))
.map(ann -> FormDataParam.class.cast(ann))
.findFirst().get().value();
final List<FormDataBodyPart> parts = getEntity(request).getFields(sourceName);
final FormDataBodyPart part = parts != null ? parts.get(0) : null;
final MediaType mediaType = part != null ? part.getMediaType() : MediaType.TEXT_PLAIN_TYPE;
final MessageBodyWorkers messageBodyWorkers = request.getWorkers();
MessageBodyReader reader = messageBodyWorkers.getMessageBodyReader(
parameter.getRawType(),
parameter.getType(),
parameter.getAnnotations(),
mediaType);
// Transform non-primitive part entity into an instance.
if (reader != null
&& !isPrimitiveType(parameter.getRawType())) {
// Get input stream of the body part.
final InputStream stream;
if (part == null) {
if (parameter.getDefaultValue() != null) {
// Convert default value to bytes.
stream = new ByteArrayInputStream(parameter.getDefaultValue()
.getBytes(MessageUtils.getCharset(mediaType)));
} else {
return null;
}
} else {
stream = part.getEntityAs(BodyPartEntity.class).getInputStream();
}
// Transform input stream into instance of desired Java type.
try {
//noinspection unchecked
return reader.readFrom(
parameter.getRawType(),
parameter.getType(),
parameter.getAnnotations(),
mediaType,
request.getHeaders(),
stream);
} catch (final IOException e) {
throw new FormDataParamException(e, parameter.getSourceName(), parameter.getDefaultValue());
}
}
// If no reader was found or a primitive type is being transformed use extractor instead.
if (extractor != null) {
final MultivaluedMap<String, String> map = new MultivaluedStringMap();
try {
if (part != null) {
for (final FormDataBodyPart p : parts) {
reader = messageBodyWorkers.getMessageBodyReader(
String.class,
String.class,
parameter.getAnnotations(),
p.getMediaType());
@SuppressWarnings("unchecked") final String value = (String) reader.readFrom(
String.class,
String.class,
parameter.getAnnotations(),
mediaType,
request.getHeaders(),
((BodyPartEntity) p.getEntity()).getInputStream());
map.add(parameter.getSourceName(), value);
}
}
return extractor.extract(map);
} catch (final IOException | ExtractorException ex) {
throw new FormDataParamException(ex, extractor.getName(), extractor.getDefaultValueString());
}
}
return null;
}
}
private static final Set<Class<?>> TYPES = initializeTypes();
private static Set<Class<?>> initializeTypes() {
final Set<Class<?>> newSet = new HashSet<>();
newSet.add(Byte.class);
newSet.add(byte.class);
newSet.add(Short.class);
newSet.add(short.class);
newSet.add(Integer.class);
newSet.add(int.class);
newSet.add(Long.class);
newSet.add(long.class);
newSet.add(Float.class);
newSet.add(float.class);
newSet.add(Double.class);
newSet.add(double.class);
newSet.add(Boolean.class);
newSet.add(boolean.class);
newSet.add(Character.class);
newSet.add(char.class);
return Collections.unmodifiableSet(newSet);
}
private static boolean isPrimitiveType(final Class<?> type) {
return TYPES.contains(type);
}
/**
* Injection constructor.
*
* @param extractorProvider multi-valued map parameter extractor provider.
*/
public FormDataParamValueParamProvider(Provider<MultivaluedParameterExtractorProvider> extractorProvider) {
super(extractorProvider, Parameter.Source.ENTITY, Parameter.Source.UNKNOWN);
}
@Override
protected Function<ContainerRequest, ?> createValueProvider(Parameter parameter) {
final Class<?> rawType = parameter.getRawType();
if (Parameter.Source.ENTITY == parameter.getSource()) {
if (FormDataMultiPart.class.isAssignableFrom(rawType)) {
return new FormDataMultiPartProvider();
} else {
return null;
}
} else {
for (Annotation sourceAnnotation : parameter.getAnnotations()) {
if (sourceAnnotation.annotationType() == FormDataParam.class) {
final String paramName = ((FormDataParam) sourceAnnotation).value(); // sourceName refers to the last anno
if (paramName == null || paramName.isEmpty()) {
// Invalid query parameter name
return null;
}
if (Collection.class == rawType || List.class == rawType) {
final Class clazz = ReflectionHelper.getGenericTypeArgumentClasses(parameter.getType()).get(0);
if (FormDataBodyPart.class == clazz) {
// Return a collection of form data body part.
return new ListFormDataBodyPartValueProvider(paramName);
} else if (FormDataContentDisposition.class == clazz) {
// Return a collection of form data content disposition.
return new ListFormDataContentDispositionProvider(paramName);
} else {
// Return a collection of specific type.
return new FormDataParamValueProvider(parameter, get(parameter));
}
} else if (FormDataBodyPart.class == rawType) {
return new FormDataBodyPartProvider(paramName);
} else if (FormDataContentDisposition.class == rawType) {
return new FormDataContentDispositionProvider(paramName);
} else if (File.class == rawType) {
return new FileProvider(paramName);
} else {
return new FormDataParamValueProvider(parameter, get(parameter));
}
}
}
}
return null;
}
@Override
public PriorityType getPriority() {
return Priority.HIGH;
}
}