blob: b3fea0e3bffcbb63ae4d2b95141b1a7f4bafe27d (
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
|
/*
@VaadinApache2LicenseForJavaFiles@
*/
package com.vaadin.terminal;
import java.io.Serializable;
import java.net.URL;
/**
* A URIHandler is used for handling URI:s requested by the user and can
* optionally provide a {@link DownloadStream}. If a {@link DownloadStream} is
* returned by {@link #handleURI(URL, String)}, the stream is sent to the
* client.
*
* @author Vaadin Ltd.
* @version
* @VERSION@
* @since 3.0
*/
public interface URIHandler extends Serializable {
/**
* Handles a given URI. If the URI handler to emit a downloadable stream it
* should return a {@code DownloadStream} object.
*
* @param context
* the base URL
* @param relativeUri
* a URI relative to {@code context}
* @return A downloadable stream or null if no stream is provided
*/
public DownloadStream handleURI(URL context, String relativeUri);
/**
* An {@code ErrorEvent} implementation for URIHandler.
*/
public interface ErrorEvent extends Terminal.ErrorEvent {
/**
* Gets the URIHandler that caused this error.
*
* @return the URIHandler that caused the error
*/
public URIHandler getURIHandler();
}
}
|
