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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
/*
@ITMillApache2LicenseForJavaFiles@
*/
package com.vaadin.terminal;
import java.io.IOException;
import java.io.InputStream;
import java.io.Serializable;
import java.util.Map;
import com.vaadin.Application;
import com.vaadin.RootRequiresMoreInformation;
import com.vaadin.annotations.RootInitRequiresBrowserDetals;
import com.vaadin.ui.Root;
/**
* A generic request to the server, wrapping a more specific request type, e.g.
* HttpServletReqest or PortletRequest.
*
* @since 7.0
*/
public interface WrappedRequest extends Serializable {
/**
* Detailed information extracted from the browser.
*
* @see WrappedRequest#getBrowserDetails()
*/
public interface BrowserDetails extends Serializable {
/**
* Gets the URI hash fragment for the request. This is typically used to
* encode navigation within an application.
*
* @return the URI hash fragment
*/
public String getUriFragmet();
/**
* Gets the value of window.name from the browser. This can be used to
* keep track of the specific window between browser reloads.
*
* @return the string value of window.name in the browser
*/
public String getWindowName();
}
/**
* Gets the named request parameter This is typically a HTTP GET or POST
* parameter, though other request types might have other ways of
* representing parameters.
*
* @see javax.servlet.ServletRequest#getParameter(String)
* @see javax.portlet.PortletRequest#getParameter(String)
*
* @param parameter
* the name of the parameter
* @return The paramter value, or <code>null</code> if no parameter with the
* given name is present
*/
public String getParameter(String parameter);
/**
* Gets all the parameters of the request.
*
* @see #getParameter(String)
*
* @see javax.servlet.ServletRequest#getParameterMap()
* @see javax.portlet.PortletRequest#getParameter(String)
*
* @return A mapping of parameter names to arrays of parameter values
*/
public Map<String, String[]> getParameterMap();
/**
* Returns the length of the request content that can be read from the input
* stream returned by {@link #getInputStream()}.
*
* @see javax.servlet.ServletRequest#getContentLength()
* @see javax.portlet.ClientDataRequest#getContentLength()
*
* @return content length in bytes
*/
public int getContentLength();
/**
* Returns an input stream from which the request content can be read. The
* request content length can be obtained with {@link #getContentLength()}
* without reading the full stream contents.
*
* @see javax.servlet.ServletRequest#getInputStream()
* @see javax.portlet.ClientDataRequest#getPortletInputStream()
*
* @return the input stream from which the contents of the request can be
* read
* @throws IOException
*/
public InputStream getInputStream() throws IOException;
/**
* Gets a request attribute.
*
* @param name
* the name of the attribute
* @return the value of the attribute, or <code>null</code> if there is no
* attribute with the given name
*
* @see javax.servlet.ServletRequest#getAttribute(String)
* @see javax.portlet.PortletRequest#getAttribute(String)
*/
public Object getAttribute(String name);
/**
* Defines a request attribute.
*
* @param name
* the name of the attribute
* @param value
* the attribute value
*
* @see javax.servlet.ServletRequest#setAttribute(String, Object)
* @see javax.portlet.PortletRequest#setAttribute(String, Object)
*/
public void setAttribute(String name, Object value);
/**
* Gets the path of the requested resource relative to the application. The
* path be <code>null</code> if no path information is available. Does
* always start with / if the path isn't <code>null</code>.
*
* @return a string with the path relative to the application.
*
* @see javax.servlet.http.HttpServletRequest#getPathInfo()
*/
public String getRequestPathInfo();
/**
* Returns the maximum time interval, in seconds, that the session
* associated with this request will be kept open between client accesses.
*
* @return an integer specifying the number of seconds the session
* associated with this request remains open between client requests
*
* @see javax.servlet.http.HttpSession#getMaxInactiveInterval()
* @see javax.portlet.PortletSession#getMaxInactiveInterval()
*/
public int getSessionMaxInactiveInterval();
/**
* Gets an attribute from the session associated with this request.
*
* @param name
* the name of the attribute
* @return the attribute value, or <code>null</code> if the attribute is not
* defined in the session
*
* @see javax.servlet.http.HttpSession#getAttribute(String)
* @see javax.portlet.PortletSession#getAttribute(String)
*/
public Object getSessionAttribute(String name);
/**
* Saves an attribute value in the session associated with this request.
*
* @param name
* the name of the attribute
* @param attribute
* the attribute value
*
* @see javax.servlet.http.HttpSession#setAttribute(String, Object)
* @see javax.portlet.PortletSession#setAttribute(String, Object)
*/
public void setSessionAttribute(String name, Object attribute);
/**
* Returns the MIME type of the body of the request, or null if the type is
* not known.
*
* @return a string containing the name of the MIME type of the request, or
* null if the type is not known
*
* @see javax.servlet.ServletRequest#getContentType()
* @see javax.portlet.ResourceRequest#getContentType()
*
*/
public String getContentType();
/**
* Gets the base URL of the location of Vaadin's static files.
*
* @return a string with the base URL for static files
*/
// TODO Method would be more logical in WrappedResponse
public String getStaticFileLocation();
/**
* Gets detailed information about the browser from which the request
* originated. This consists of information that is not available from
* normal HTTP requests, but requires additional information to be extracted
* for instance using javascript in the browser.
*
* This information is only guaranteed to be available in some special
* cases, for instance when {@link Application#getRoot} is called again
* after throwing {@link RootRequiresMoreInformation} or in
* {@link Root#init(WrappedRequest)} if the Root class is annotated with
* {@link RootInitRequiresBrowserDetals}
*
* @return the browser details, or <code>null</code> if details are not
* available
*
* @see BrowserDetails
*/
public BrowserDetails getBrowserDetails();
}
|
