io.micronaut.http.server.types.files

Class AttachedFile

java.lang.Object

io.micronaut.http.server.types.files.SystemFileCustomizableResponseType

io.micronaut.http.server.types.files.AttachedFile

All Implemented Interfaces:

CustomizableResponseType, FileCustomizableResponseType

Deprecated.

Use instead. This class conflates the source of the data with the type of response being sent. This assumes the file should be sent as an attachment while StreamedFile does not. The SystemFile class now behaves the same as StreamedFile by defaulting to inline with a method to call to set it to be attached. new AttachedFile(file, name) -> new SystemFile(file).attach(name) new AttachedFile(file) -> new SystemFile(file).attach(file.getName())

@Deprecated
public class AttachedFile
extends SystemFileCustomizableResponseType

Used as the return value of a route execution to indicate the given file should be downloaded by the client instead of displayed.

Since:

1.0

Author:

James Kleeh

Field Summary

Fields inherited from class io.micronaut.http.server.types.files.SystemFileCustomizableResponseType

file

Fields inherited from interface io.micronaut.http.server.types.files.FileCustomizableResponseType

ATTACHMENT_HEADER

Constructor Summary

Constructors

Constructor and Description
AttachedFile(File file) Deprecated.
AttachedFile(File file, String filename) Deprecated.

Method Summary

Modifier and Type	Method and Description
String	getName() Deprecated.
AttachedFile	inline() Deprecated. If called, the file will not be sent as an attachment.
void	process(MutableHttpResponse response) Deprecated. Modify the response before it is written to the client.

Methods inherited from class io.micronaut.http.server.types.files.SystemFileCustomizableResponseType

getFile, getLastModified, getLength, getMediaType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AttachedFile

public AttachedFile(File file)

Deprecated.

Parameters:

file - The file

AttachedFile

public AttachedFile(File file,
                    String filename)

Deprecated.

Parameters:

file - The file

filename - The filename

Method Detail

inline

public AttachedFile inline()

Deprecated.

If called, the file will not be sent as an attachment.

Returns:

The same AttachedFile instance

process

public void process(MutableHttpResponse response)

Deprecated.

Description copied from interface: CustomizableResponseType

Modify the response before it is written to the client.

Parameters:

response - The response to modify

getName

public String getName()

Deprecated.

Specified by:

getName in interface FileCustomizableResponseType

Overrides:

getName in class SystemFileCustomizableResponseType

Returns:

The name of the file