1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21 package org.apache.struts2.components;
22
23 import com.opensymphony.xwork2.util.ValueStack;
24
25 import javax.servlet.http.HttpServletRequest;
26 import javax.servlet.http.HttpServletResponse;
27 import java.util.Map;
28
29 /***
30 * Implemntations of this interface can be used to build a URL
31 */
32 public interface UrlProvider {
33 /***
34 * The includeParams attribute may have the value 'none', 'get' or 'all'.
35 * It is used when the url tag is used without a value attribute.
36 * Its value is looked up on the ValueStack
37 * If no includeParams is specified then 'get' is used.
38 * none - include no parameters in the URL
39 * get - include only GET parameters in the URL (default)
40 * all - include both GET and POST parameters in the URL
41 */
42 public static final String NONE = "none";
43 public static final String GET = "get";
44 public static final String ALL = "all";
45
46 boolean isPutInContext();
47
48 String getVar();
49
50 String getValue();
51
52 String findString(String value);
53
54 void setValue(String string);
55
56 String getUrlIncludeParams();
57
58 String getIncludeParams();
59
60 Map getParameters();
61
62 HttpServletRequest getHttpServletRequest();
63
64 String getAction();
65
66 ExtraParameterProvider getExtraParameterProvider();
67
68 String getScheme();
69
70 String getNamespace();
71
72 String getMethod();
73
74 HttpServletResponse getHttpServletResponse();
75
76 boolean isIncludeContext();
77
78 boolean isEncode();
79
80 boolean isForceAddSchemeHostAndPort();
81
82 boolean isEscapeAmp();
83
84 String getPortletMode();
85
86 String getWindowState();
87
88 String determineActionURL(String action, String namespace, String method, HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Map parameters, String scheme, boolean includeContext, boolean encode, boolean forceAddSchemeHostAndPort, boolean escapeAmp);
89
90 String determineNamespace(String namespace, ValueStack stack, HttpServletRequest req);
91
92 String getAnchor();
93
94 String getPortletUrlType();
95
96 ValueStack getStack();
97
98 void setUrlIncludeParams(String urlIncludeParams);
99
100 void setHttpServletRequest(HttpServletRequest req);
101
102 void setHttpServletResponse(HttpServletResponse res);
103
104 void setUrlRenderer(UrlRenderer urlRenderer);
105
106 void setExtraParameterProvider(ExtraParameterProvider provider);
107
108 void setIncludeParams(String includeParams);
109
110 void setScheme(String scheme);
111
112 void setAction(String action);
113
114 void setPortletMode(String portletMode);
115
116 void setNamespace(String namespace);
117
118 void setMethod(String method);
119
120 void setEncode(boolean encode);
121
122 void setIncludeContext(boolean includeContext);
123
124 void setWindowState(String windowState);
125
126 void setPortletUrlType(String portletUrlType);
127
128 void setAnchor(String anchor);
129
130 void setEscapeAmp(boolean escapeAmp);
131
132 void setForceAddSchemeHostAndPort(boolean forceAddSchemeHostAndPort);
133
134 void putInContext(String result);
135 }