summaryrefslogtreecommitdiffstats
path: root/src/com/itmill/toolkit/terminal/URIHandler.java
blob: ef1fc76e069efc20a49ba14657371caf541e9c28 (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
/* 
@ITMillApache2LicenseForJavaFiles@
 */

package com.itmill.toolkit.terminal;

import java.net.URL;

/**
 * Interface implemented by all the classes capable of handling URI:s.
 * 
 * <p>
 * <code>URIHandler</code> can provide <code>DownloadStream</code> for
 * transferring data for client.
 * </p>
 * 
 * @author IT Mill Ltd.
 * @version
 * @VERSION@
 * @since 3.0
 */
public interface URIHandler {

    /**
     * Handles a given relative URI. If the URI handling wants to emit a
     * downloadable stream it can return download stream object. If no emitting
     * stream is necessary, null should be returned instead.
     * 
     * @param context
     *                the URl.
     * @param relativeUri
     *                the relative uri.
     * @return the download stream object.
     */
    public DownloadStream handleURI(URL context, String relativeUri);

    /**
     * URIHandler error event.
     */
    public interface ErrorEvent extends Terminal.ErrorEvent {

        /**
         * Gets the source URIHandler.
         * 
         * @return the URIHandler.
         */
        public URIHandler getURIHandler();

    }
}