01: /*
02: * Created on Oct 25, 2005
03: */
04: package uk.org.ponder.rsf.viewstate;
05:
06: /** Encodes information about the local URL structure to this servlet.
07: * Upstream from here is the {@link ViewStateHandler} which takes input from
08: * the BaseURLProvider for this request, but in addition can funnel in any
09: * ConsumerRequestInfo relevant for a more complex, portlet-style request.
10: * @author Antranig Basman (amb26@ponder.org.uk)
11: *
12: */
13:
14: public interface BaseURLProvider {
15: /** Get the base URL that will be used to operate the ViewParameters
16: * system - in general this will be the URL to which the ReasonableServlet
17: * is mapped in web.xml. This URL DOES include a trailing slash. As
18: * an invariant, if this servlet is not being remapped or redespatched in
19: * any way, it will be the value returned by
20: * ServletUtil.getBaseURL2(), as implemented by AutoBaseURLProvider.
21: */
22: public String getBaseURL();
23:
24: /** Get the base URL that will be used to map the base of the static resources
25: * served by this webapp. Without support from the URLRewriteSCR, this will
26: * have to be the base path of the entire Servlet context. This URL DOES
27: * include a trailing slash.
28: * As
29: * an invariant, if this servlet is not being remapped or redespatched in
30: * any way, it will be the value returned by
31: * ServletUtil.getContextBaseURL2(), as implemented by AutoBaseURLProvider.
32: */
33: public String getResourceBaseURL();
34: }
|