org.glassfish.grizzly.http.multipart.MultipartEntry Maven / Gradle / Ivy
The newest version!
/*
* Copyright (c) 2011, 2020 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.grizzly.http.multipart;
import java.io.IOException;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;
import org.glassfish.grizzly.http.io.NIOInputStream;
import org.glassfish.grizzly.http.io.NIOReader;
import org.glassfish.grizzly.http.server.Request;
import org.glassfish.grizzly.http.util.ContentType;
import org.glassfish.grizzly.http.util.Header;
/**
* Abstraction represents single multipart entry, its functionality is pretty similar to {@link Request}. In order to
* read multipart entry data it's possible to use either {@link #getNIOInputStream()} or {@link #getNIOReader()} depends
* on whether we want to operate with binary or {@link String} data.
*
* @since 2.0.1
*
* @author Alexey Stashok
*/
public class MultipartEntry {
private static final String DEFAULT_CONTENT_TYPE = "text/plain; charset=US-ASCII";
private static final String DEFAULT_CONTENT_ENCODING = "US-ASCII";
private NIOInputStream requestInputStream;
private final MultipartContext multipartContext;
private final MultipartEntryNIOInputStream inputStream;
private final MultipartEntryNIOReader reader;
private final Map headers = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
private String contentType = DEFAULT_CONTENT_TYPE;
private ContentDisposition contentDisposition;
private int availableBytes;
// Previous (processed) line terminator bytes, which we're not sure about,
// whether they are part of section boundary or multipart entry content
private int reservedBytes;
private boolean isFinished;
private boolean isSkipping;
/**
* Using stream flag.
*/
protected boolean usingInputStream = false;
/**
* Using writer flag.
*/
protected boolean usingReader = false;
/**
* Is this entry multipart/mixed
*/
private boolean isMultipart;
/**
* Have we parsed content-type and figured out whether it's multipart/mixed?
*/
private boolean isMultipartParsed;
MultipartEntry(final MultipartContext multipartContext) {
inputStream = new MultipartEntryNIOInputStream(this);
reader = new MultipartEntryNIOReader(this);
this.multipartContext = multipartContext;
}
void initialize(final NIOInputStream parentInputStream) {
this.requestInputStream = parentInputStream;
}
public NIOInputStream getNIOInputStream() {
if (usingReader) {
throw new IllegalStateException("MultipartEntry is in the character mode");
}
if (!usingInputStream) {
inputStream.initialize(requestInputStream);
}
usingInputStream = true;
return inputStream;
}
public NIOReader getNIOReader() {
if (usingInputStream) {
throw new IllegalStateException("MultipartEntry is in the binary mode");
}
if (!usingReader) {
reader.initialize(requestInputStream, getEncoding());
}
usingReader = true;
return reader;
}
/**
* Get multipart processing context.
*
* @return {@link MultipartContext}.
*/
public MultipartContext getMultipartContext() {
return multipartContext;
}
/**
* Returns true if this is "multipart/*" multipart entry, or false otherwise.
*
* @return true if this is "multipart/*" multipart entry, or false otherwise.
*/
public boolean isMultipart() {
if (!isMultipartParsed) {
isMultipartParsed = true;
isMultipart = contentType != null && contentType.toLowerCase().startsWith(MultipartScanner.MULTIPART_CONTENT_TYPE);
}
return isMultipart;
}
/**
* Get the multipart entry content-type.
*
* @return the multipart entry content-type.
*/
public String getContentType() {
return contentType;
}
void setContentType(final String contentType) {
this.contentType = contentType;
}
/**
* Get the multipart entry content-disposition.
*
* @return the multipart entry content-disposition.
*/
public ContentDisposition getContentDisposition() {
return contentDisposition;
}
void setContentDisposition(final ContentDisposition contentDisposition) {
this.contentDisposition = contentDisposition;
}
/**
* Get the multipart entry header names.
*
* @return the multipart entry header names.
*/
public Set getHeaderNames() {
return headers.keySet();
}
/**
* Get the multipart entry header value.
*
* @param name multipart entry header name.
* @return the multipart entry header value.
*/
public String getHeader(final String name) {
return headers.get(name);
}
void setHeader(final String name, final String value) {
headers.put(name, value);
}
/**
* Get the multipart entry header value.
*
* @param header entry header.
* @return the multipart entry header value.
*
* @since 2.1.2
*/
public String getHeader(final Header header) {
return headers.get(header.toString());
}
/**
*
* @param header
* @param value
*
* @since 2.1.2
*/
void setHeader(final Header header, final String value) {
headers.put(header.toString(), value);
}
/**
* Skip the multipart entry processing.
*/
@SuppressWarnings({ "ResultOfMethodCallIgnored" })
public void skip() throws IOException {
isSkipping = true;
requestInputStream.skip(availableBytes);
availableBytes = 0;
}
protected String getEncoding() {
String contentEncoding = ContentType.getCharsetFromContentType(getContentType());
return contentEncoding != null ? contentEncoding : DEFAULT_CONTENT_ENCODING;
}
void reset() {
headers.clear();
contentType = DEFAULT_CONTENT_TYPE;
contentDisposition = null;
availableBytes = 0;
reservedBytes = 0;
isFinished = false;
isSkipping = false;
usingInputStream = false;
usingReader = false;
inputStream.recycle();
reader.recycle();
isMultipartParsed = false;
}
void onFinished() throws Exception {
isFinished = true;
onDataReceived();
}
@SuppressWarnings({ "ResultOfMethodCallIgnored" })
void onDataReceived() throws Exception {
if (isSkipping) {
try {
requestInputStream.skip(availableBytes);
availableBytes = 0;
} catch (IOException e) {
throw new IllegalStateException("Unexpected exception", e);
}
return;
}
if (usingInputStream) {
inputStream.onDataCame();
} else if (usingReader) {
reader.onDataCame();
}
}
boolean isFinished() {
return isFinished;
}
int availableBytes() {
return availableBytes;
}
void addAvailableBytes(final int delta) {
availableBytes += delta;
}
/**
* Get the previous (processed) line terminator bytes, which we're not sure about, whether they are part of section
* boundary or multipart entry content
*
* @return the previous (processed) line terminator bytes, which we're not sure about, whether they are part of section
* boundary or multipart entry content
*/
int getReservedBytes() {
return reservedBytes;
}
/**
* Set the previous (processed) line terminator bytes, which we're not sure about, whether they are part of section
* boundary or multipart entry content
*
* @param reservedBytes the previous (processed) line terminator bytes, which we're not sure about, whether they are
* part of section boundary or multipart entry content
*/
void setReservedBytes(int reservedBytes) {
this.reservedBytes = reservedBytes;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy