net.datenwerke.gf.service.tempfile

Class TempFileServiceImpl

java.lang.Object

net.datenwerke.gf.service.tempfile.TempFileServiceImpl

All Implemented Interfaces:

TempFileService

public class TempFileServiceImpl
extends java.lang.Object
implements TempFileService

Constructor Summary

Constructors

Constructor and Description
TempFileServiceImpl(<any> tempDir)

Method Summary

Modifier and Type	Method and Description
java.nio.file.Path	createTempFile() Creates a temporary file in the temp directory configured.
TempFile	createWebAccessibleTempFile(java.lang.String id, User... permittedUsers) Creates a web-accessible temporary file which can be retrieved by the given id.
TempFile	createWebAccessibleTempFile(User... permittedUsers) Creates a temporary file which can be retrieved by the returned identifier (TempFile.getWebId()) using the TempFileServlet.
TempFile	getTempFileById(java.lang.String id) Given an identifier (web-id), retrieves the corresponding temporary file.
boolean	isTmpFile(java.nio.file.Path path) Checks if the given file is a temporary file, that is, if is located in a temporary file location.
byte[]	readTmpFileIntoByteArray(java.nio.file.Path path) Reads all bytes of a given temporary file into a byte array.
byte[]	readTmpFileIntoByteArray(java.nio.file.Path file, boolean removeFile) Reads all bytes of a given temporary file into a byte array.

Methods inherited from class java.lang.Object

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

Constructor Detail

TempFileServiceImpl

public TempFileServiceImpl(<any> tempDir)

Method Detail

createTempFile

public java.nio.file.Path createTempFile()
                                  throws java.io.IOException

Description copied from interface: TempFileService

Creates a temporary file in the temp directory configured.

Specified by:

createTempFile in interface TempFileService

Returns:

the temporary file

Throws:

java.io.IOException - if an I/O error occurs

createWebAccessibleTempFile

public TempFile createWebAccessibleTempFile(java.lang.String id,
                                            User... permittedUsers)
                                     throws java.io.IOException

Description copied from interface: TempFileService

Creates a web-accessible temporary file which can be retrieved by the given id.

Specified by:

createWebAccessibleTempFile in interface TempFileService

Parameters:

id - the web-id of the temporary file.

permittedUsers - users allowed to access the temporary file

Returns:

the web-accessible temp file

Throws:

java.io.IOException - if an I/O error occurs

createWebAccessibleTempFile

public TempFile createWebAccessibleTempFile(User... permittedUsers)
                                     throws java.io.IOException

Description copied from interface: TempFileService

Creates a temporary file which can be retrieved by the returned identifier (TempFile.getWebId()) using the TempFileServlet.

Specified by:

createWebAccessibleTempFile in interface TempFileService

Parameters:

permittedUsers - users allowed to access the temporary file

Throws:

java.io.IOException - if an I/O error occurs

getTempFileById

public TempFile getTempFileById(java.lang.String id)

Description copied from interface: TempFileService

Given an identifier (web-id), retrieves the corresponding temporary file.

Specified by:

getTempFileById in interface TempFileService

Parameters:

id - the web-id

Returns:

the temporary file corresponding to the given web-id

readTmpFileIntoByteArray

public byte[] readTmpFileIntoByteArray(java.nio.file.Path path)
                                throws java.io.IOException

Description copied from interface: TempFileService

Reads all bytes of a given temporary file into a byte array. Note that this method is intended for simple cases where it is convenient to read all bytes into a byte array. It is not intended for reading in large files.

Specified by:

readTmpFileIntoByteArray in interface TempFileService

Parameters:

path - the temporary file to read

Returns:

the content of the temporary file as a byte array

Throws:

java.io.IOException - if an I/O error occurs

readTmpFileIntoByteArray

public byte[] readTmpFileIntoByteArray(java.nio.file.Path file,
                                       boolean removeFile)
                                throws java.io.IOException

Description copied from interface: TempFileService

Reads all bytes of a given temporary file into a byte array. Note that this method is intended for simple cases where it is convenient to read all bytes into a byte array. It is not intended for reading in large files.

Specified by:

readTmpFileIntoByteArray in interface TempFileService

Parameters:

file - the temporary file to read

removeFile - true if the temporary file should be deleted after reading into a byte array

Returns:

the content of the temporary file as a byte array

Throws:

java.io.IOException - if an I/O error occurs

isTmpFile

public boolean isTmpFile(java.nio.file.Path path)

Description copied from interface: TempFileService

Checks if the given file is a temporary file, that is, if is located in a temporary file location.

Specified by:

isTmpFile in interface TempFileService

Parameters:

path - the file to check

Returns:

true if the given file is a temporary file