Package org.salespointframework.files

Interface FileStorage

@Service
public interface FileStorage

An application service to store NamedBinary instances and obtain them as Resources.

Since:

7.5

Author:

Oliver Drotbohm

Method Summary

Modifier and Type	Method	Description
void	deleteAll()	Deletes all files currently contained in the FileStorage.
void	deleteByName(String filename)	Deletes the file with the given name.
FileStorage	forUser(UserAccount.UserAccountIdentifier userAccountIdentifier)	Returns the FileStorage for the UserAccount identified by the given UserAccount.UserAccountIdentifier.
Streamable<Resource>	getAllResources()	Returns all stored Resources.
Optional<Resource>	getResource(String filename)	Returns the Resource for the given file name.
Resource	store(NamedBinary binary)	Stores the given NamedBinary.

Method Details

store

Resource store(NamedBinary binary)

Stores the given NamedBinary. Publishes a FileStored event for other interested parties to react to just stored files.

Parameters:

binary - must not be null.

Returns:

will never be null.

getAllResources

Streamable<Resource> getAllResources()

Returns all stored Resources.

Returns:

will never be null.

getResource

Optional<Resource> getResource(String filename)

Returns the Resource for the given file name.

Parameters:

filename - must not be null or empty.

Returns:

will never be null.

deleteAll

void deleteAll()

Deletes all files currently contained in the FileStorage.

deleteByName

void deleteByName(String filename)

Deletes the file with the given name.

Parameters:

filename - must not be null or empty.

Since:

9.0

forUser

FileStorage forUser(UserAccount.UserAccountIdentifier userAccountIdentifier)

Returns the FileStorage for the UserAccount identified by the given UserAccount.UserAccountIdentifier.

Parameters:

userAccountIdentifier - must not be null.

Returns:

will never be null.