de.innovationgate.webgate.api.templates

Interface SimpleFileContainer

public interface SimpleFileContainer

Interface that should be implemented by objects that are to be used as file containers by SimpleFileRepository.

Method Summary

Methods

Modifier and Type	Method and Description
void	attachFile(java.io.File file) Called to attach a file to the container
java.util.Date	getCreated() Returns the creation data of the container
java.io.InputStream	getFileData(java.lang.String fileName) Returns the data of a file in this container as stream
java.util.List	getFileNames() Returns the names of all files in this container
long	getFileSize(java.lang.String fileName) Returns the size of a file in bytes
java.util.Date	getLastModified() Returns the date of the last modification of this container
java.lang.String	getName() Returns the name of this container
boolean	hasFile(java.lang.String file) Returns if a file of the given name is available
void	removeFile(java.lang.String fileName) Tells the container to remove a file

Method Detail

getName

java.lang.String getName()

Returns the name of this container

getFileNames

java.util.List getFileNames()

Returns the names of all files in this container

hasFile

boolean hasFile(java.lang.String file)

Returns if a file of the given name is available

removeFile

void removeFile(java.lang.String fileName)
                throws WGAPIException

Tells the container to remove a file

Parameters:

fileName - The file to remove

Throws:

WGAPIException

attachFile

void attachFile(java.io.File file)
                throws WGAPIException

Called to attach a file to the container

Parameters:

file - The file to attach.

Throws:

WGAPIException

getFileData

java.io.InputStream getFileData(java.lang.String fileName)
                                throws WGAPIException

Returns the data of a file in this container as stream

Parameters:

fileName - The file to server

Returns:

Data stream containing file data

Throws:

WGAPIException

getFileSize

long getFileSize(java.lang.String fileName)
                 throws WGAPIException

Returns the size of a file in bytes

Parameters:

fileName - The file

Returns:

file size in bytes.

Throws:

WGAPIException

getCreated

java.util.Date getCreated()

Returns the creation data of the container

getLastModified

java.util.Date getLastModified()

Returns the date of the last modification of this container