aboutsummaryrefslogtreecommitdiffstats
path: root/src/com/itmill/toolkit/terminal/URIHandler.java
blob: 2f73956abaa415ce644443cbaaa03da9a6b9baf4 (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
/* *************************************************************************
 
                               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.net.URL;

/** Interface implemented by all the classes capable of handling URI:s.
 * 
 * <p>URI handlers can provide <code>DownloadStream</code>
 * for transferring data for client.</p>
 *
 * @author IT Mill Ltd.
 * @version @VERSION@
 * @since 3.0
 */
public interface URIHandler {
    
    /** Handle uri. 
     * 
     * Handle the 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.
     * 
     */
    public DownloadStream handleURI(URL context, String relativeUri);

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

		/** Get the source URIHandler. */
		public URIHandler getURIHandler();

	}
}