Please wait. This can take some minutes ...
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.apache.cxf.jaxrs.utils.multipart.AttachmentUtils Maven / Gradle / Ivy
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.cxf.jaxrs.utils.multipart;
import java.io.IOException;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.ResourceBundle;
import java.util.logging.Logger;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import org.apache.cxf.attachment.AttachmentDeserializer;
import org.apache.cxf.common.i18n.BundleUtils;
import org.apache.cxf.common.logging.LogUtils;
import org.apache.cxf.helpers.CastUtils;
import org.apache.cxf.jaxrs.ext.MessageContext;
import org.apache.cxf.jaxrs.ext.multipart.Attachment;
import org.apache.cxf.jaxrs.ext.multipart.ContentDisposition;
import org.apache.cxf.jaxrs.ext.multipart.Multipart;
import org.apache.cxf.jaxrs.ext.multipart.MultipartBody;
import org.apache.cxf.jaxrs.ext.multipart.MultipartInputFilter;
import org.apache.cxf.jaxrs.ext.multipart.MultipartOutputFilter;
import org.apache.cxf.jaxrs.impl.MetadataMap;
import org.apache.cxf.jaxrs.utils.ExceptionUtils;
import org.apache.cxf.jaxrs.utils.FormUtils;
import org.apache.cxf.jaxrs.utils.JAXRSUtils;
import org.apache.cxf.message.Message;
import org.apache.cxf.phase.PhaseInterceptorChain;
public final class AttachmentUtils {
public static final String OUT_FILTERS = "multipart.output.filters";
public static final String IN_FILTERS = "multipart.input.filters";
private static final Logger LOG = LogUtils.getL7dLogger(JAXRSUtils.class);
private static final ResourceBundle BUNDLE = BundleUtils.getBundle(JAXRSUtils.class);
private AttachmentUtils() {
}
public static void addMultipartOutFilter(MultipartOutputFilter filter) {
Message m = JAXRSUtils.getCurrentMessage();
List outFilters = CastUtils.cast((List>)m.get(OUT_FILTERS));
if (outFilters == null) {
outFilters = new ArrayList<>();
m.put(OUT_FILTERS, outFilters);
}
outFilters.add(filter);
}
public static void addMultipartInFilter(MultipartInputFilter filter) {
Message m = JAXRSUtils.getCurrentMessage();
List inFilters = CastUtils.cast((List>)m.get(IN_FILTERS));
if (inFilters == null) {
inFilters = new ArrayList<>();
m.put(IN_FILTERS, inFilters);
}
inFilters.add(filter);
}
public static MultipartBody getMultipartBody(MessageContext mc) {
return (MultipartBody)mc.get(MultipartBody.INBOUND_MESSAGE_ATTACHMENTS);
}
public static Map getChildAttachmentsMap(MessageContext mc,
boolean preferContentDisposition) {
return fromListToMap(getChildAttachments(mc), preferContentDisposition);
}
public static Map getChildAttachmentsMap(MessageContext mc) {
return fromListToMap(getChildAttachments(mc), false);
}
public static List getChildAttachments(MessageContext mc) {
return getMultipartBody(mc).getChildAttachments();
}
public static Map getAttachmentsMap(MessageContext mc,
boolean preferContentDisposition) {
return fromListToMap(getAttachments(mc), preferContentDisposition);
}
public static Map getAttachmentsMap(MessageContext mc) {
return fromListToMap(getAttachments(mc), false);
}
public static List getAttachments(MessageContext mc) {
return getMultipartBody(mc).getAllAttachments();
}
public static Attachment getFirstMatchingPart(MessageContext mc, Multipart id) {
return getFirstMatchingPart(mc, id.value());
}
public static Attachment getFirstMatchingPart(MessageContext mc, String id) {
return getFirstMatchingPart(mc, id, null);
}
public static Attachment getFirstMatchingPart(MessageContext mc, String id, String mediaType) {
List all = getAttachments(mc);
List matching = getMatchingAttachments(id, mediaType, all);
return matching.isEmpty() ? null : matching.get(0);
}
public static MultipartBody getMultipartBody(MessageContext mc,
String attachmentDir, String attachmentThreshold, String attachmentMaxSize) {
if (attachmentDir != null) {
mc.put(AttachmentDeserializer.ATTACHMENT_DIRECTORY, attachmentDir);
}
if (attachmentThreshold != null) {
mc.put(AttachmentDeserializer.ATTACHMENT_MEMORY_THRESHOLD, attachmentThreshold);
}
if (attachmentMaxSize != null) {
mc.put(AttachmentDeserializer.ATTACHMENT_MAX_SIZE, attachmentMaxSize);
}
boolean embeddedAttachment = mc.get("org.apache.cxf.multipart.embedded") != null;
String propertyName = embeddedAttachment ? MultipartBody.INBOUND_MESSAGE_ATTACHMENTS + ".embedded"
: MultipartBody.INBOUND_MESSAGE_ATTACHMENTS;
MultipartBody body = (MultipartBody)mc.get(propertyName);
if (!embeddedAttachment && mc.get(IN_FILTERS) != null) {
List filters = CastUtils.cast((List>)mc.get(IN_FILTERS));
for (MultipartInputFilter filter : filters) {
filter.filter(body.getAllAttachments());
}
}
return body;
}
public static List getAttachments(MessageContext mc,
String attachmentDir, String attachmentThreshold, String attachmentMaxSize) {
return getMultipartBody(mc,
attachmentDir,
attachmentThreshold,
attachmentMaxSize).getAllAttachments();
}
public static Attachment getMultipart(Multipart id,
MediaType mt,
List infos) throws IOException {
if (id != null) {
for (Attachment a : infos) {
if (matchAttachmentId(a, id)) {
checkMediaTypes(a.getContentType(), id.type());
return a;
}
}
if (id.required()) {
org.apache.cxf.common.i18n.Message errorMsg =
new org.apache.cxf.common.i18n.Message("MULTTIPART_ID_NOT_FOUND",
BUNDLE,
id.value(),
mt.toString());
LOG.warning(errorMsg.toString());
throw ExceptionUtils.toBadRequestException(
new MultipartReadException(id.value(), id.type(), errorMsg.toString()), null);
}
return null;
}
return !infos.isEmpty() ? infos.get(0) : null;
}
public static List getMatchingAttachments(Multipart id,
List infos) {
return getMatchingAttachments(id.value(), id.type(), infos);
}
public static List getMatchingAttachments(String id,
List infos) {
return getMatchingAttachments(id, null, infos);
}
public static List getMatchingAttachments(String id,
String mediaType,
List infos) {
List all = new LinkedList<>();
for (Attachment a : infos) {
if (matchAttachmentId(a, id)) {
if (mediaType != null) {
checkMediaTypes(a.getContentType(), mediaType);
}
all.add(a);
}
}
return all;
}
public static boolean matchAttachmentId(Attachment at, Multipart mid) {
return matchAttachmentId(at, mid.value());
}
public static boolean matchAttachmentId(Attachment at, String value) {
if (value.isEmpty()) {
return true;
}
if (at.getContentId().equals(value)) {
return true;
}
ContentDisposition cd = at.getContentDisposition();
return cd != null && value.equals(cd.getParameter("name"));
}
public static MultivaluedMap populateFormMap(MessageContext mc,
boolean errorIfMissing) {
MultivaluedMap data = new MetadataMap<>();
FormUtils.populateMapFromMultipart(data,
AttachmentUtils.getMultipartBody(mc),
PhaseInterceptorChain.getCurrentMessage(),
true);
return data;
}
public static MultivaluedMap populateFormMap(MessageContext mc) {
return populateFormMap(mc, true);
}
private static Map fromListToMap(List atts,
boolean preferContentDisposition) {
Map map = new LinkedHashMap<>();
for (Attachment a : atts) {
String contentId = null;
if (preferContentDisposition) {
ContentDisposition cd = a.getContentDisposition();
if (cd != null) {
contentId = cd.getParameter("name");
}
}
if (contentId == null) {
contentId = a.getContentId();
}
map.put(contentId, a);
}
return map;
}
private static void checkMediaTypes(MediaType mt1, String mt2) {
if (!mt1.isCompatible(JAXRSUtils.toMediaType(mt2))) {
throw ExceptionUtils.toNotSupportedException(null, null);
}
}
}