com.itmill.toolkit.terminal
Class FileResource

java.lang.Object
  com.itmill.toolkit.terminal.FileResource

All Implemented Interfaces:

ApplicationResource, Resource

public class FileResource
extends Object
implements ApplicationResource

FileResources are files or directories on local filesystem. The files and directories are served through URI:s to the client terminal and thus must be registered to an URI context before they can be used. The resource is automatically registered to the application when it is created.

Since:

3.0

Version:

4.1.4

Author:

IT Mill Ltd.

Field Summary

Fields inherited from interface com.itmill.toolkit.terminal.ApplicationResource

DEFAULT_CACHETIME

Constructor Summary

FileResource(File sourceFile, Application application)
Creates a new file resource for providing given file for client terminals.

Method Summary

Application	getApplication() Gets the application of the resource.
int	getBufferSize() Gets the size of the download buffer used for this resource.
long	getCacheTime() Gets the length of cache expiration time.
String	getFilename() Gets the virtual filename for this resource.
String	getMIMEType() Gets the MIME type of the resource.
File	getSourceFile() Gets the source file.
DownloadStream	getStream() Gets the resource as stream.
void	setBufferSize(int bufferSize) Sets the size of the download buffer used for this resource.
void	setCacheTime(long cacheTime) Sets the length of cache expiration time.
void	setSourceFile(File sourceFile) Sets the source file.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileResource

public FileResource(File sourceFile,
                    Application application)

Creates a new file resource for providing given file for client terminals.

Method Detail

getStream

public DownloadStream getStream()

Gets the resource as stream.

Specified by:

getStream in interface ApplicationResource

See Also:

ApplicationResource.getStream()

getSourceFile

public File getSourceFile()

Gets the source file.

Returns:

the source File.

setSourceFile

public void setSourceFile(File sourceFile)

Sets the source file.

Parameters:

sourceFile - the source file to set.

getApplication

public Application getApplication()

Description copied from interface: ApplicationResource

Gets the application of the resource.

Specified by:

getApplication in interface ApplicationResource

See Also:

ApplicationResource.getApplication()

getFilename

public String getFilename()

Description copied from interface: ApplicationResource

Gets the virtual filename for this resource.

Specified by:

getFilename in interface ApplicationResource

Returns:

the file name associated to this resource.

See Also:

ApplicationResource.getFilename()

getMIMEType

public String getMIMEType()

Description copied from interface: Resource

Gets the MIME type of the resource.

Specified by:

getMIMEType in interface Resource

Returns:

the MIME type of the resource.

See Also:

Resource.getMIMEType()

getCacheTime

public long getCacheTime()

Gets the length of cache expiration time. This gives the adapter the possibility cache streams sent to the client. The caching may be made in adapter or at the client if the client supports caching. Default is DownloadStream.DEFAULT_CACHETIME.

Specified by:

getCacheTime in interface ApplicationResource

Returns:

Cache time in milliseconds.

setCacheTime

public void setCacheTime(long cacheTime)

Sets the length of cache expiration time. This gives the adapter the possibility cache streams sent to the client. The caching may be made in adapter or at the client if the client supports caching. Zero or negavive value disbales the caching of this stream.

Parameters:

cacheTime - the cache time in milliseconds.

getBufferSize

public int getBufferSize()

Description copied from interface: ApplicationResource

Gets the size of the download buffer used for this resource.

If the buffer size is 0, the buffer size is decided by the terminal adapter. The default value is 0.

Specified by:

getBufferSize in interface ApplicationResource

Returns:

int the size of the buffer in bytes.

setBufferSize

public void setBufferSize(int bufferSize)

Sets the size of the download buffer used for this resource.

Parameters:

bufferSize - the size of the buffer in bytes.