ZATS Download

Since 1.1.0

We usually perform the file downloading through the Filedownload when some events occurred. The following is a typical example about downloading a file:

<zk>
	<button id="btn" label="download">
		<attribute name="onClick"><![CDATA[
			org.zkoss.zul.Filedownload.save("foo.txt", "application/octet-stream");
		]]>
		</attribute>
	</button>
</zk>

Actually, the downloaded mechanism is a process with two steps. When you invoke save(), the Filedownload simply notifies ZK client engine of the downloaded URL. Then, the ZK client engine downloads such files according to the received URL.

Notes

Download files in a ZATS Mimic test case

In order to simulate same behavior as ZK client engine doing, ZATS Mimic introduces the Resource interface. It represents a downloadable resource file at server. The typical steps for testing downloading are:

1. perform some operations through operation agents
2. check is there a downloadable resource through desktop agent
3. fetch and verify the information or content of the resource

@Test
public void test() throws Exception {
	Zats.init(".");
	try {
		DesktopAgent desktop = Zats.newClient().connect("/foo.zul");
		Assert.assertNull(desktop.getDownloadable());

		desktop.query("#btn").click();
		Resource resource = desktop.getDownloadable();
		Assert.assertNotNull(resource);
		Assert.assertEquals("hello.txt", resource.getName());
		String content = fetchContent(resource.getInputStream());
		Assert.assertEquals("Hello world!", content);
	} finally {
		Zats.end();
	}
}

More about downloadable resources

Because ZATS Mimic handles the response from ZK application automatically, we can get the current downloadable resource file from the DesktopAgent.getDownloadable(). The method might return null when getting the downloadable resource, it indicates that there is no downloadable resource after the previous operation.

void checkDownloadableResource(DesktopAgent desktopAgent) throws IOException {
	Resource resource = desktopAgent.getDownloadable();
	if (resource != null) {
		// There is a downloadable resource file.
	} else {
		// There is no downloadable resourece file currently.
	}
}

Then, we can get more information from Resource, or just fetch the content of resource file in binary through the input stream.

void doSomething(Resource resource) throws IOException {
	String name = resource.getName();
	InputStream inputStrem = resource.getInputStream();
}