pekko/akka-docs/rst/java/http/routing-dsl/directives/file-upload-directives/uploadedFile.rst
gosubpl 06aaa273f1 doc #20466 akka http java dsl examples - file upload directives (#20859)
* #20466 file upload - first example test done

* #20466 second test from FileUploadDirectivesExample passing in Java

* #20466 FileUploadDirectives examples file rename plus docs

*  #20466 post-review changes - adding better JAVA Multipart API

* #20466 Multipart Java conversions fix and added spec for the Java side of the model
2016-07-05 10:26:27 +02:00

24 lines
No EOL
984 B
ReStructuredText

.. _-uploadedFile-java-:
uploadedFile
============
Description
-----------
Streams the contents of a file uploaded as a multipart form into a temporary file on disk and provides the file and
metadata about the upload as extracted value.
If there is an error writing to disk the request will be failed with the thrown exception, if there is no field
with the given name the request will be rejected, if there are multiple file parts with the same name, the first
one will be used and the subsequent ones ignored.
.. note::
This directive will stream contents of the request into a file, however one can not start processing these
until the file has been written completely. For streaming APIs it is preferred to use the :ref:`-fileUpload-java-`
directive, as it allows for streaming handling of the incoming data bytes.
Example
-------
.. includecode2:: ../../../../code/docs/http/javadsl/server/directives/FileUploadDirectivesExamplesTest.java
:snippet: uploadedFile