degroff/0.3.5.maintenance file manager

build.savant

@@ -17,7 +17,7 @@ jackson5Version = "3.0.1"
 restifyVersion = "4.2.1"
 testngVersion = "7.10.2"
 
-project(group: "io.fusionauth", name: "java-http", version: "0.3.6", licenses: ["ApacheV2_0"]) {
+project(group: "io.fusionauth", name: "java-http", version: "0.3.7", licenses: ["ApacheV2_0"]) {
   workflow {
     fetch {
       // Dependency resolution order:

java-http.ipr

@@ -346,12 +346,14 @@
       </HTMLCodeStyleSettings>
       <JavaCodeStyleSettings>
         <option name="DO_NOT_WRAP_AFTER_SINGLE_ANNOTATION" value="true" />
+        <option name="BLANK_LINES_AROUND_FIELD_WITH_ANNOTATIONS" value="1" />
         <option name="CLASS_NAMES_IN_JAVADOC" value="3" />
         <option name="INSERT_INNER_CLASS_IMPORTS" value="true" />
         <option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="9999" />
         <option name="NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND" value="9999" />
         <option name="IMPORT_LAYOUT_TABLE">
           <value>
+            <package name="" withSubpackages="true" static="false" module="true" />
             <package name="javax" withSubpackages="true" static="false" />
             <package name="java" withSubpackages="true" static="false" />
             <emptyLine />
@@ -1394,7 +1396,45 @@
   <component name="ProjectRootManager" version="2" languageLevel="JDK_17" default="true" project-jdk-name="Java 17" project-jdk-type="JavaSDK">
     <output url="file://$PROJECT_DIR$/out" />
   </component>
+  <component name="ProjectRunConfigurationManager">
+    <configuration default="true" type="TestNG">
+      <shortenClasspath name="NONE" />
+      <useClassPathOnly />
+      <option name="SUITE_NAME" value="" />
+      <option name="PACKAGE_NAME" value="" />
+      <option name="MAIN_CLASS_NAME" value="" />
+      <option name="GROUP_NAME" value="" />
+      <option name="TEST_OBJECT" value="CLASS" />
+      <option name="VM_PARAMETERS" value="-ea --add-exports java.base/sun.security.x509=ALL-UNNAMED --add-exports java.base/sun.security.util=ALL-UNNAMED --add-opens java.base/java.net=ALL-UNNAMED" />
+      <option name="PARAMETERS" value="" />
+      <option name="OUTPUT_DIRECTORY" value="" />
+      <option name="TEST_SEARCH_SCOPE">
+        <value defaultName="moduleWithDependencies" />
+      </option>
+      <option name="PROPERTIES_FILE" value="" />
+      <properties />
+      <listeners>
+        <listener class="io.fusionauth.http.BaseTest$TestListener" />
+      </listeners>
+      <method v="2">
+        <option name="Make" enabled="true" />
+      </method>
+    </configuration>
+  </component>
   <component name="VcsDirectoryMappings">
     <mapping directory="$PROJECT_DIR$" vcs="Git" />
   </component>
+  <component name="libraryTable">
+    <library name=".kts definition dependencies">
+      <CLASSES>
+        <root url="jar://$KOTLIN_BUNDLED$/lib/kotlin-reflect.jar!/" />
+        <root url="jar://$KOTLIN_BUNDLED$/lib/kotlin-script-runtime.jar!/" />
+        <root url="jar://$KOTLIN_BUNDLED$/lib/kotlin-stdlib.jar!/" />
+      </CLASSES>
+      <JAVADOC />
+      <SOURCES>
+        <root url="jar://$KOTLIN_BUNDLED$/lib/kotlin-stdlib-sources.jar!/" />
+      </SOURCES>
+    </library>
+  </component>
 </project>

src/main/java/io/fusionauth/http/ContentTooLarge.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2025, FusionAuth, All Rights Reserved
+ *
+ * Licensed 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 io.fusionauth.http;
+
+/**
+ * Thrown when a request exceeds the total configured maximum size.
+ *
+ * @author Daniel DeGroff
+ */
+public class ContentTooLarge extends HTTPProcessingException {
+  public long maximumRequestSize;
+
+  public ContentTooLarge(long maximumRequestSize, String detailedMessage) {
+    super(413, "Content Too Large", detailedMessage);
+    this.maximumRequestSize = maximumRequestSize;
+  }
+}

src/main/java/io/fusionauth/http/HTTPProcessingException.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2025, FusionAuth, All Rights Reserved
+ *
+ * Licensed 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 io.fusionauth.http;
+
+/**
+ * A base HTTP processing exception that is able to suggest a status code to return the client.
+ */
+public abstract class HTTPProcessingException extends RuntimeException {
+  protected final int status;
+
+  protected final String statusMessage;
+
+  protected HTTPProcessingException(int status, String statusMessage) {
+    this.status = status;
+    this.statusMessage = statusMessage;
+  }
+
+  protected HTTPProcessingException(int status, String statusMessage, String detailedMessage) {
+    super(detailedMessage);
+    this.status = status;
+    this.statusMessage = statusMessage;
+  }
+
+  public int getStatus() {
+    return status;
+  }
+
+  public String getStatusMessage() {
+    return statusMessage;
+  }
+}

src/main/java/io/fusionauth/http/UnprocessableContentException.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2025, FusionAuth, All Rights Reserved
+ *
+ * Licensed 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 io.fusionauth.http;
+
+/**
+ * Thrown when a multipart request cannot be parsed because a processor was not specified.
+ *
+ * @author Daniel DeGroff
+ */
+public class UnprocessableContentException extends HTTPProcessingException {
+  public UnprocessableContentException(String message) {
+    super(422, "Unprocessable Content", message);
+  }
+}

src/main/java/io/fusionauth/http/io/DefaultMultipartFileManager.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2025, FusionAuth, All Rights Reserved
+ *
+ * Licensed 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 io.fusionauth.http.io;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Manage file creation for multipart streams.
+ *
+ * @author Daniel DeGroff
+ */
+public class DefaultMultipartFileManager implements MultipartFileManager {
+  private final List<Path> tempFiles = new ArrayList<>(0);
+
+  public Path createTemporaryFile(Path tempDir, String optionalPrefix, String optionalSuffix) throws IOException {
+    Path tempFile = Files.createTempFile(tempDir, optionalPrefix, optionalSuffix);
+    tempFiles.add(tempFile);
+    return tempFile;
+  }
+
+  public List<Path> getTemporaryFiles() {
+    return List.copyOf(tempFiles);
+  }
+}

src/main/java/io/fusionauth/http/io/MultipartConfiguration.java

@@ -0,0 +1,141 @@
+/*
+ * Copyright (c) 2025, FusionAuth, All Rights Reserved
+ *
+ * Licensed 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 io.fusionauth.http.io;
+
+import java.util.Objects;
+
+/**
+ * Provides configuration to control the behavior of the {@link MultipartStream} parser, specifically around file uploads.
+ *
+ * @author Daniel DeGroff
+ */
+public class MultipartConfiguration {
+  private boolean deleteTemporaryFiles = true;
+
+  private boolean fileUploadEnabled;
+
+  private long maxFileSize = 1024 * 1024; // 1 Megabyte
+
+  private long maxRequestSize = 10 * 1024 * 1024; // 10 Megabyte
+
+  // TODO : Daniel : Review : This was 1k, that seemed really small?
+  private int multipartBufferSize = 8 * 1024; // 8 Kilobyte
+
+  private String temporaryFileLocation = System.getProperty("java.io.tmpdir");
+
+  private String temporaryFilenamePrefix = "java-http";
+
+  private String temporaryFilenameSuffix = "file-upload";
+
+  public MultipartConfiguration() {
+  }
+
+  public MultipartConfiguration(MultipartConfiguration other) {
+    this.fileUploadEnabled = other.fileUploadEnabled;
+    this.maxFileSize = other.maxFileSize;
+    this.maxRequestSize = other.maxRequestSize;
+    this.multipartBufferSize = other.multipartBufferSize;
+    this.temporaryFileLocation = other.temporaryFileLocation;
+    this.temporaryFilenamePrefix = other.temporaryFilenamePrefix;
+    this.temporaryFilenameSuffix = other.temporaryFilenameSuffix;
+  }
+
+  public boolean deleteTemporaryFiles() {
+    return deleteTemporaryFiles;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (o == null || getClass() != o.getClass()) {
+      return false;
+    }
+    MultipartConfiguration that = (MultipartConfiguration) o;
+    return fileUploadEnabled == that.fileUploadEnabled && maxFileSize == that.maxFileSize && maxRequestSize == that.maxRequestSize && multipartBufferSize == that.multipartBufferSize && Objects.equals(temporaryFileLocation, that.temporaryFileLocation) && Objects.equals(temporaryFilenamePrefix, that.temporaryFilenamePrefix) && Objects.equals(temporaryFilenameSuffix, that.temporaryFilenameSuffix);
+  }
+
+  public long getMaxFileSize() {
+    return maxFileSize;
+  }
+
+  public long getMaxRequestSize() {
+    return maxRequestSize;
+  }
+
+  public int getMultipartBufferSize() {
+    return multipartBufferSize;
+  }
+
+  public String getTemporaryFileLocation() {
+    return temporaryFileLocation;
+  }
+
+  public String getTemporaryFilenamePrefix() {
+    return temporaryFilenamePrefix;
+  }
+
+  public String getTemporaryFilenameSuffix() {
+    return temporaryFilenameSuffix;
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(fileUploadEnabled, maxFileSize, maxRequestSize, multipartBufferSize, temporaryFileLocation, temporaryFilenamePrefix, temporaryFilenameSuffix);
+  }
+
+  public boolean isFileUploadEnabled() {
+    return fileUploadEnabled;
+  }
+
+  public MultipartConfiguration withDeleteTemporaryFiles(boolean deleteTemporaryFiles) {
+    this.deleteTemporaryFiles = deleteTemporaryFiles;
+    return this;
+  }
+
+  public MultipartConfiguration withFileUploadEnabled(boolean fileUploadEnabled) {
+    this.fileUploadEnabled = fileUploadEnabled;
+    return this;
+  }
+
+  public MultipartConfiguration withMaxFileSize(long maxFileSize) {
+    this.maxFileSize = maxFileSize;
+    return this;
+  }
+
+  public MultipartConfiguration withMaxRequestSize(long maxRequestSize) {
+    this.maxRequestSize = maxRequestSize;
+    return this;
+  }
+
+  public MultipartConfiguration withMultipartBufferSize(int multipartBufferSize) {
+    this.multipartBufferSize = multipartBufferSize;
+    return this;
+  }
+
+  public MultipartConfiguration withTemporaryFileLocation(String temporaryFileLocation) {
+    this.temporaryFileLocation = temporaryFileLocation;
+    return this;
+  }
+
+  public MultipartConfiguration withTemporaryFilenamePrefix(String temporaryFilenamePrefix) {
+    this.temporaryFilenamePrefix = temporaryFilenamePrefix;
+    return this;
+  }
+
+  public MultipartConfiguration withTemporaryFilenameSuffix(String temporaryFilenameSuffix) {
+    this.temporaryFilenameSuffix = temporaryFilenameSuffix;
+    return this;
+  }
+}

src/main/java/io/fusionauth/http/io/MultipartFileManager.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2025, FusionAuth, All Rights Reserved
+ *
+ * Licensed 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 io.fusionauth.http.io;
+
+import java.io.IOException;
+import java.nio.file.Path;
+import java.util.List;
+
+public interface MultipartFileManager {
+  /**
+   * Create a temporary file for use when processing files in multipart form data.
+   *
+   * @param tempDir the path to the temporary directory
+   * @param optionalPrefix the optional prefix used to create the temporary file
+   * @param optionalSuffix the optional suffix used to create the temporary file
+   * @return the path to the temporary file
+   */
+  Path createTemporaryFile(Path tempDir, String optionalPrefix, String optionalSuffix) throws IOException;
+
+  /**
+   * @return a list of the temporary files created by this file manager.
+   */
+  List<Path> getTemporaryFiles();
+}