import com.vaadin.server.StreamVariable.StreamingErrorEvent;
import com.vaadin.server.Terminal.ErrorEvent;
import com.vaadin.server.Terminal.ErrorListener;
-import com.vaadin.server.VaadinRequest.BrowserDetails;
import com.vaadin.shared.ApplicationConstants;
import com.vaadin.shared.Connector;
import com.vaadin.shared.JavaScriptConnectorState;
import com.vaadin.ui.UI;
import com.vaadin.ui.UI.LegacyWindow;
import com.vaadin.ui.Window;
-import com.vaadin.util.CurrentInstance;
/**
* This is a common base class for the server-side implementations of the
try {
assert UI.getCurrent() == null;
- CombinedRequest combinedRequest = new CombinedRequest(request);
- CurrentInstance.set(VaadinRequest.class, combinedRequest);
-
response.setContentType("application/json; charset=UTF-8");
- UI uI = getBrowserDetailsUI(combinedRequest);
+ UI uI = getBrowserDetailsUI(request);
JSONObject params = new JSONObject();
params.put(UIConstants.UI_ID_PARAMETER, uI.getUIId());
- String initialUIDL = getInitialUIDL(combinedRequest, uI);
+ String initialUIDL = getInitialUIDL(request, uI);
params.put("uidl", initialUIDL);
// NOTE! GateIn requires, for some weird reason, getOutputStream
}
// Check for an existing UI based on window.name
- BrowserDetails browserDetails = request.getBrowserDetails();
- boolean hasBrowserDetails = browserDetails != null
- && browserDetails.getLocation() != null;
+
+ // Special parameter sent by vaadinBootstrap.js
+ String windowName = request.getParameter("wn");
Map<String, Integer> retainOnRefreshUIs = session
.getPreserveOnRefreshUIs();
- if (hasBrowserDetails && !retainOnRefreshUIs.isEmpty()) {
+ if (windowName != null && !retainOnRefreshUIs.isEmpty()) {
// Check for a known UI
- @SuppressWarnings("null")
- String windowName = browserDetails.getWindowName();
Integer retainedUIId = retainOnRefreshUIs.get(windowName);
if (retainedUIId != null) {
// Remember if it should be remembered
if (vaadinService.preserveUIOnRefresh(provider, event)) {
// Remember this UI
- String windowName = request.getBrowserDetails().getWindowName();
if (windowName == null) {
getLogger().warning(
"There is no window.name available for UI " + uiClass
+++ /dev/null
-/*
- * Copyright 2011 Vaadin Ltd.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License. You may obtain a copy of
- * the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- * License for the specific language governing permissions and limitations under
- * the License.
- */
-
-package com.vaadin.server;
-
-import java.io.IOException;
-import java.io.InputStream;
-import java.net.URI;
-import java.net.URISyntaxException;
-import java.util.Locale;
-import java.util.Map;
-
-import org.json.JSONException;
-
-/**
- * A {@link VaadinRequest} with path and parameters from one request and
- * {@link VaadinRequest.BrowserDetails} extracted from another request.
- *
- * This class is intended to be used for a two request initialization where the
- * first request fetches the actual application page and the second request
- * contains information extracted from the browser using javascript.
- *
- */
-public class CombinedRequest implements VaadinRequest {
-
- private final VaadinRequest secondRequest;
-
- /**
- * Creates a new combined request based on the second request and some
- * details from the first request.
- *
- * @param secondRequest
- * the second request which will be used as the foundation of the
- * combined request
- * @throws JSONException
- * if the initialParams parameter can not be decoded
- */
- public CombinedRequest(VaadinRequest secondRequest) throws JSONException {
- this.secondRequest = secondRequest;
- }
-
- @Override
- public String getParameter(String parameter) {
- return secondRequest.getParameter(parameter);
- }
-
- @Override
- public Map<String, String[]> getParameterMap() {
- return secondRequest.getParameterMap();
- }
-
- @Override
- public int getContentLength() {
- return secondRequest.getContentLength();
- }
-
- @Override
- public InputStream getInputStream() throws IOException {
- return secondRequest.getInputStream();
- }
-
- @Override
- public Object getAttribute(String name) {
- return secondRequest.getAttribute(name);
- }
-
- @Override
- public void setAttribute(String name, Object value) {
- secondRequest.setAttribute(name, value);
- }
-
- @Override
- public String getRequestPathInfo() {
- return secondRequest.getRequestPathInfo();
- }
-
- @Override
- public WrappedSession getWrappedSession() {
- return getWrappedSession(true);
- }
-
- @Override
- public WrappedSession getWrappedSession(boolean allowSessionCreation) {
- return secondRequest.getWrappedSession(allowSessionCreation);
- }
-
- @Override
- public String getContentType() {
- return secondRequest.getContentType();
- }
-
- @Override
- public BrowserDetails getBrowserDetails() {
- return new BrowserDetails() {
- @Override
- public URI getLocation() {
- String location = secondRequest.getParameter("loc");
- if (location == null) {
- return null;
- } else {
- try {
- return new URI(location);
- } catch (URISyntaxException e) {
- throw new RuntimeException(
- "Invalid location URI received from client", e);
- }
- }
- }
-
- @Override
- public String getWindowName() {
- return secondRequest.getParameter("wn");
- }
-
- @Override
- public WebBrowser getWebBrowser() {
- return VaadinServiceSession.getCurrent().getBrowser();
- }
- };
- }
-
- /**
- * Gets the original second request. This can be used e.g. if a request
- * parameter from the second request is required.
- *
- * @return the original second Vaadin request
- */
- public VaadinRequest getSecondRequest() {
- return secondRequest;
- }
-
- @Override
- public Locale getLocale() {
- return secondRequest.getLocale();
- }
-
- @Override
- public String getRemoteAddr() {
- return secondRequest.getRemoteAddr();
- }
-
- @Override
- public boolean isSecure() {
- return secondRequest.isSecure();
- }
-
- @Override
- public String getHeader(String name) {
- return secondRequest.getHeader(name);
- }
-
- @Override
- public VaadinService getService() {
- return secondRequest.getService();
- }
-
- @Override
- public String getContextPath() {
- return secondRequest.getContextPath();
- }
-}
throws ServiceException {
try {
onVaadinSessionStarted(
- VaadinPortletRequest.cast(event.getRequest()),
+ (VaadinPortletRequest) event.getRequest(),
(VaadinPortletSession) event.getSession());
} catch (PortletException e) {
throw new ServiceException(e);
import java.util.List;
import com.vaadin.event.EventRouter;
-import com.vaadin.server.VaadinRequest.BrowserDetails;
import com.vaadin.shared.ui.BorderStyle;
import com.vaadin.shared.ui.ui.PageClientRpc;
import com.vaadin.shared.ui.ui.UIConstants;
}
public void init(VaadinRequest request) {
- BrowserDetails browserDetails = request.getBrowserDetails();
- if (browserDetails != null) {
- location = browserDetails.getLocation();
+ // Extract special parameter sent by vaadinBootstrap.js
+ String loc = request.getParameter("loc");
+ if (loc != null) {
+ try {
+ location = new URI(loc);
+ } catch (URISyntaxException e) {
+ throw new RuntimeException(
+ "Invalid location URI received from client", e);
+ }
}
}
public boolean handleRequest(VaadinServiceSession session,
VaadinRequest request, VaadinResponse response)
throws IOException {
- PortletRequest portletRequest = VaadinPortletRequest.cast(
- request).getPortletRequest();
+ PortletRequest portletRequest = ((VaadinPortletRequest) request)
+ .getPortletRequest();
if (portletRequest instanceof RenderRequest) {
return super.handleRequest(session, request, response);
} else {
throws JSONException, IOException {
// fixed base theme to use - all portal pages with Vaadin
// applications will load this exactly once
- String portalTheme = VaadinPortletRequest.cast(
- context.getRequest()).getPortalProperty(
- VaadinPortlet.PORTAL_PARAMETER_VAADIN_THEME);
+ String portalTheme = ((VaadinPortletRequest) context
+ .getRequest())
+ .getPortalProperty(VaadinPortlet.PORTAL_PARAMETER_VAADIN_THEME);
if (portalTheme != null
&& !portalTheme.equals(context.getThemeName())) {
String portalThemeUri = getThemeUri(context, portalTheme);
public boolean handleRequest(VaadinServiceSession session,
VaadinRequest request, VaadinResponse response) throws IOException {
- if (request.getBrowserDetails() != null) {
- // Check if the browser is supported
- // If Chrome Frame is available we'll assume it's ok
- WebBrowser b = request.getBrowserDetails().getWebBrowser();
- if (b.isTooOldToFunctionProperly() && !b.isChromeFrameCapable()) {
- // bypass if cookie set
- String c = request.getHeader("Cookie");
- if (c == null || !c.contains(FORCE_LOAD_COOKIE)) {
- writeBrowserTooOldPage(request, response);
- return true; // request handled
- }
+ // Check if the browser is supported
+ // If Chrome Frame is available we'll assume it's ok
+ WebBrowser b = session.getBrowser();
+ if (b.isTooOldToFunctionProperly() && !b.isChromeFrameCapable()) {
+ // bypass if cookie set
+ String c = request.getHeader("Cookie");
+ if (c == null || !c.contains(FORCE_LOAD_COOKIE)) {
+ writeBrowserTooOldPage(request, response);
+ return true; // request handled
}
}
protected void writeBrowserTooOldPage(VaadinRequest request,
VaadinResponse response) throws IOException {
Writer page = response.getWriter();
- WebBrowser b = request.getBrowserDetails().getWebBrowser();
+ WebBrowser b = VaadinServiceSession.getCurrent().getBrowser();
page.write("<html><body><h1>I'm sorry, but your browser is not supported</h1>"
+ "<p>The version ("
public void criticalNotification(VaadinRequest request,
VaadinResponse response, String cap, String msg,
String details, String outOfSyncURL) throws IOException {
- portlet.criticalNotification(VaadinPortletRequest.cast(request),
+ portlet.criticalNotification((VaadinPortletRequest) request,
(VaadinPortletResponse) response, cap, msg, details,
outOfSyncURL);
}
import java.io.IOException;
import java.io.InputStream;
-import java.net.URI;
import java.util.Locale;
import java.util.Map;
}
}
- @Override
- public BrowserDetails getBrowserDetails() {
- return new BrowserDetails() {
- @Override
- public URI getLocation() {
- return null;
- }
-
- @Override
- public String getWindowName() {
- return null;
- }
-
- @Override
- public WebBrowser getWebBrowser() {
- VaadinPortletSession context = (VaadinPortletSession) VaadinServiceSession
- .getCurrent();
- return context.getBrowser();
- }
- };
- }
-
@Override
public Locale getLocale() {
return request.getLocale();
return vaadinService;
}
- /**
- * Helper method to get a {@link VaadinPortletRequest} from a
- * {@link VaadinRequest}. Aside from casting, this method also takes care of
- * situations where there's another level of wrapping.
- *
- * @param request
- * a Vaadin request
- * @return a Vaadin portlet request
- * @throws ClassCastException
- * if the Vaadin request doesn't wrap a portlet request
- */
- public static VaadinPortletRequest cast(VaadinRequest request) {
- if (request instanceof CombinedRequest) {
- CombinedRequest combinedRequest = (CombinedRequest) request;
- request = combinedRequest.getSecondRequest();
- }
- return (VaadinPortletRequest) request;
- }
-
@Override
public String getContextPath() {
return request.getContextPath();
return portlet;
}
+ private static String getPortalProperty(VaadinRequest request,
+ String portalParameterVaadinWidgetset) {
+ return ((VaadinPortletRequest) request)
+ .getPortalProperty(portalParameterVaadinWidgetset);
+ }
+
@Override
public String getConfiguredWidgetset(VaadinRequest request) {
if (widgetset == null) {
// If no widgetset defined for the application, check the
// portal property
- widgetset = VaadinPortletRequest.cast(request).getPortalProperty(
+ widgetset = getPortalProperty(request,
VaadinPortlet.PORTAL_PARAMETER_VAADIN_WIDGETSET);
if ("com.vaadin.portal.gwt.PortalDefaultWidgetSet"
.equals(widgetset)) {
public String getConfiguredTheme(VaadinRequest request) {
// is the default theme defined by the portal?
- String themeName = VaadinPortletRequest.cast(request)
- .getPortalProperty(Constants.PORTAL_PARAMETER_VAADIN_THEME);
+ String themeName = getPortalProperty(request,
+ Constants.PORTAL_PARAMETER_VAADIN_THEME);
if (themeName == null) {
// no, using the default theme defined by Vaadin
@Override
public String getStaticFileLocation(VaadinRequest request) {
- String staticFileLocation = VaadinPortletRequest.cast(request)
- .getPortalProperty(
- Constants.PORTAL_PARAMETER_VAADIN_RESOURCE_PATH);
+ String staticFileLocation = getPortalProperty(request,
+ Constants.PORTAL_PARAMETER_VAADIN_RESOURCE_PATH);
if (staticFileLocation != null) {
// remove trailing slash if any
while (staticFileLocation.endsWith(".")) {
RequestType type = (RequestType) request.getAttribute(RequestType.class
.getName());
if (type == null) {
- type = getPortlet().getRequestType(
- VaadinPortletRequest.cast(request));
+ type = getPortlet().getRequestType((VaadinPortletRequest) request);
request.setAttribute(RequestType.class.getName(), type);
}
return type;
public static PortletRequest getCurrentPortletRequest() {
VaadinRequest currentRequest = VaadinService.getCurrentRequest();
- try {
- VaadinPortletRequest request = VaadinPortletRequest
- .cast(currentRequest);
- if (request != null) {
- return request.getPortletRequest();
- } else {
- return null;
- }
- } catch (ClassCastException e) {
+ if (currentRequest instanceof VaadinPortletRequest) {
+ return ((VaadinPortletRequest) currentRequest).getPortletRequest();
+ } else {
return null;
}
}
@Override
public String getMainDivId(VaadinServiceSession session,
VaadinRequest request, Class<? extends UI> uiClass) {
- PortletRequest portletRequest = VaadinPortletRequest.cast(request)
+ PortletRequest portletRequest = ((VaadinPortletRequest) request)
.getPortletRequest();
/*
* We need to generate a unique ID because some portals already create a
import java.io.IOException;
import java.io.InputStream;
import java.io.Serializable;
-import java.net.URI;
import java.util.Locale;
import java.util.Map;
import javax.servlet.ServletRequest;
import javax.servlet.http.HttpServletRequest;
-import com.vaadin.ui.UI;
-
/**
* A generic request to the server, wrapping a more specific request type, e.g.
* HttpServletReqest or PortletRequest.
* @since 7.0.0
*/
public interface VaadinRequest extends Serializable {
-
- /**
- * Detailed information extracted from the browser.
- *
- * @see VaadinRequest#getBrowserDetails()
- * @deprecated might be refactored or removed before 7.0.0
- */
- @Deprecated
- public interface BrowserDetails extends Serializable {
- /**
- * Gets the URI in the browser address bar, including the fragment
- * (Javascript window.location)
- *
- * @return the browser location URI
- */
- public URI getLocation();
-
- /**
- * 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 a reference to the {@link WebBrowser} object containing
- * additional information, e.g. screen size and the time zone offset.
- *
- * @return the web browser object
- */
- public WebBrowser getWebBrowser();
- }
-
/**
* Gets the named request parameter This is typically a HTTP GET or POST
* parameter, though other request types might have other ways of
*/
public String getContentType();
- /**
- * 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 in {@link UI#init(VaadinRequest)}.
- *
- * @return the browser details, or <code>null</code> if details are not
- * available
- *
- * @see BrowserDetails
- * @deprecated might be refactored or removed before 7.0.0
- */
- @Deprecated
- public BrowserDetails getBrowserDetails();
-
/**
* Gets locale information from the query, e.g. using the Accept-Language
* header.
public void criticalNotification(VaadinRequest request,
VaadinResponse response, String cap, String msg,
String details, String outOfSyncURL) throws IOException {
- servlet.criticalNotification(VaadinServletRequest.cast(request),
+ servlet.criticalNotification((VaadinServletRequest) request,
((VaadinServletResponse) response), cap, msg, details,
outOfSyncURL);
}
package com.vaadin.server;
-import java.net.URI;
-
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import javax.servlet.http.HttpSession;
public VaadinServletService getService() {
return vaadinService;
}
-
- @Override
- public BrowserDetails getBrowserDetails() {
- return new BrowserDetails() {
- @Override
- public URI getLocation() {
- return null;
- }
-
- @Override
- public String getWindowName() {
- return null;
- }
-
- @Override
- public WebBrowser getWebBrowser() {
- return VaadinServiceSession.getCurrent().getBrowser();
- }
- };
- }
-
- /**
- * Helper method to get a {@link VaadinServletRequest} from a
- * {@link VaadinRequest}. Aside from casting, this method also takes care of
- * situations where there's another level of wrapping.
- *
- * @param request
- * a Vaadin request
- * @return a Vaadin http servlet request
- * @throws ClassCastException
- * if the Vaadin request doesn't wrap a http servlet request
- */
- public static VaadinServletRequest cast(VaadinRequest request) {
- if (request instanceof CombinedRequest) {
- CombinedRequest combinedRequest = (CombinedRequest) request;
- request = combinedRequest.getSecondRequest();
- }
- return (VaadinServletRequest) request;
- }
-
}
\ No newline at end of file
@Override
public String getStaticFileLocation(VaadinRequest request) {
- HttpServletRequest servletRequest = VaadinServletRequest.cast(request);
+ VaadinServletRequest servletRequest = (VaadinServletRequest) request;
String staticFileLocation;
// if property is defined in configurations, use that
staticFileLocation = getDeploymentConfiguration()
RequestType type = (RequestType) request.getAttribute(RequestType.class
.getName());
if (type == null) {
- type = getServlet().getRequestType(
- VaadinServletRequest.cast(request));
+ type = getServlet().getRequestType((VaadinServletRequest) request);
request.setAttribute(RequestType.class.getName(), type);
}
return type;
@Override
protected URL getApplicationUrl(VaadinRequest request)
throws MalformedURLException {
- return getServlet().getApplicationUrl(
- VaadinServletRequest.cast(request));
+ return getServlet().getApplicationUrl((VaadinServletRequest) request);
}
@Override
public static HttpServletRequest getCurrentServletRequest() {
VaadinRequest currentRequest = VaadinService.getCurrentRequest();
- try {
- VaadinServletRequest request = VaadinServletRequest
- .cast(currentRequest);
- if (request != null) {
- return request.getHttpServletRequest();
- } else {
- return null;
- }
- } catch (ClassCastException e) {
+ if (currentRequest instanceof VaadinServletRequest) {
+ return (VaadinServletRequest) currentRequest;
+ } else {
return null;
}
}
String appId = null;
try {
URL appUrl = getServlet().getApplicationUrl(
- VaadinServletRequest.cast(request));
+ (VaadinServletRequest) request);
appId = appUrl.getPath();
} catch (MalformedURLException e) {
// Just ignore problem here
import com.vaadin.server.Resource;
import com.vaadin.server.UIProvider;
import com.vaadin.server.VaadinRequest;
-import com.vaadin.server.VaadinRequest.BrowserDetails;
import com.vaadin.server.VaadinService;
import com.vaadin.server.VaadinServiceSession;
import com.vaadin.server.VaadinServlet;
* state of the UI is not properly set up when the constructor is invoked.
* <p>
* The {@link VaadinRequest} can be used to get information about the
- * request that caused this UI to be created. {@link BrowserDetails} will be
- * available in the request.
+ * request that caused this UI to be created.
* </p>
*
* @param request
throw new ServiceException(
new InstantiationException(
"Failed to load application class: "
- + getApplicationRunnerApplicationClassName(VaadinServletRequest
- .cast(request))));
+ + getApplicationRunnerApplicationClassName((VaadinServletRequest) request)));
}
}
@Override
protected void setup(VaadinRequest request) {
- addComponent(new Label("window.name: "
- + request.getBrowserDetails().getWindowName()));
+ // Internal parameter sent by vaadinBootstrap.js,
+ addComponent(new Label("window.name: " + request.getParameter("wn")));
addComponent(new Label("UI id: " + getUIId()));
}
package com.vaadin.tests.components.ui;
import com.vaadin.server.ExternalResource;
+import com.vaadin.server.Page;
import com.vaadin.server.UIClassSelectionEvent;
import com.vaadin.server.UICreateEvent;
import com.vaadin.server.UIProviderEvent;
info += "<br />pathInfo: " + request.getRequestPathInfo();
info += "<br />parameters: " + request.getParameterMap().keySet();
info += "<br />uri fragment: "
- + request.getBrowserDetails().getLocation().getFragment();
+ + Page.getCurrent().getLocation().getFragment();
return new Label(info, ContentMode.HTML);
}
class TouchRoot extends UI {
@Override
protected void init(VaadinRequest request) {
- WebBrowser webBrowser = request.getBrowserDetails().getWebBrowser();
+ WebBrowser webBrowser = getSession().getBrowser();
String screenSize = "" + webBrowser.getScreenWidth() + "x"
+ webBrowser.getScreenHeight();
getContent().addComponent(
@Override
protected void init(VaadinRequest request) {
Label label = new Label("Hello, your fragment is "
- + request.getBrowserDetails().getLocation().getFragment());
+ + getPage().getLocation().getFragment());
getContent().addComponent(label);
// React to fragment changes
});
// Handle the fragment received in the initial request
- handleFragment(request.getBrowserDetails().getLocation().getFragment());
+ handleFragment(getPage().getLocation().getFragment());
addComponent(new Button("Show and set fragment",
new Button.ClickListener() {
projects / vaadin-framework.git / commitdiff