aboutsummaryrefslogtreecommitdiffstats
path: root/src/com/itmill/toolkit/terminal/FileResource.java
blob: 8d5a1625d00c5966e32dc30c82f5cd8eb594459d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/* *************************************************************************
 
                               IT Mill Toolkit 

               Development of Browser User Interfaces Made Easy

                    Copyright (C) 2000-2006 IT Mill Ltd
                     
   *************************************************************************

   This product is distributed under commercial license that can be found
   from the product package on license/license.txt. Use of this product might 
   require purchasing a commercial license from IT Mill Ltd. For guidelines 
   on usage, see license/licensing-guidelines.html

   *************************************************************************
   
   For more information, contact:
   
   IT Mill Ltd                           phone: +358 2 4802 7180
   Ruukinkatu 2-4                        fax:   +358 2 4802 7181
   20540, Turku                          email:  info@itmill.com
   Finland                               company www: www.itmill.com
   
   Primary source for information and releases: www.itmill.com

   ********************************************************************** */

package com.itmill.toolkit.terminal;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;

import com.itmill.toolkit.Application;
import com.itmill.toolkit.service.FileTypeResolver;

/** File resources are files or directories on local filesystem. The files and directories
 * are served trough 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.
 *
 * @author IT Mill Ltd.
 * @version @VERSION@
 * @since 3.0
 */
public class FileResource implements ApplicationResource {

	/** Default buffer size for this stream resource */
	private int bufferSize = 0;

	/** File where the downloaded content is fetched from. */
	private File sourceFile;

	/** Application */
	private Application application;

	/** Default cache time for this stream resource */
	private long cacheTime = DownloadStream.DEFAULT_CACHETIME;		

	/** Create new file resource for providing given file for
	 * client terminals.
	 */
	public FileResource(File sourceFile, Application application) {
		this.application = application;
		setSourceFile(sourceFile);
		application.addResource(this);
	}

	public DownloadStream getStream() {
		try {
			DownloadStream ds = new DownloadStream(
				new FileInputStream(this.sourceFile),
				getMIMEType(),
				getFilename());
			ds.setCacheTime(cacheTime);
			return ds;
		} catch (FileNotFoundException e) {
			// No logging for non-existing files at this level. 
			return null;
		}
	}

	/** Returns the source file.
	 * @return File
	 */
	public File getSourceFile() {
		return sourceFile;
	}

	/** Sets the source file.
	 * @param sourceFile The source file to set
	 */
	public void setSourceFile(File sourceFile) {
		this.sourceFile = sourceFile;
	}

	/**
	 * @see com.itmill.toolkit.terminal.ApplicationResource#getApplication()
	 */
	public Application getApplication() {
		return application;
	}

	/**
	 * @see com.itmill.toolkit.terminal.ApplicationResource#getFilename()
	 */
	public String getFilename() {
		return sourceFile.getName();
	}

	/**
	 * @see com.itmill.toolkit.terminal.Resource#getMIMEType()
	 */
	public String getMIMEType() {
		return FileTypeResolver.getMIMEType(sourceFile);
	}
	
	/** Get lenght of cache expiracy 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.
	 * @return Cache time in milliseconds
	 */
	public long getCacheTime() {
		return cacheTime;
	}

	/** Set lenght of cache expiracy 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.
	 * @param cacheTime The cache time in milliseconds.
	 */
	public void setCacheTime(long cacheTime) {
		this.cacheTime = cacheTime;
	}	
	
	/* documented in superclass */
	public int getBufferSize() {
		return bufferSize;
	}

	/** Set the size of the download buffer used for this resource.
	 * @param bufferSize The size of the buffer in bytes.
	 */
	public void setBufferSize(int bufferSize) {
		this.bufferSize = bufferSize;
	}

}