/*
* Copyright 2000-2014 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.client.ui;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import com.google.gwt.core.client.JsArrayString;
import com.google.gwt.event.shared.GwtEvent;
import com.google.gwt.event.shared.HandlerManager;
import com.google.web.bindery.event.shared.HandlerRegistration;
import com.vaadin.client.ApplicationConnection;
import com.vaadin.client.FastStringMap;
import com.vaadin.client.FastStringSet;
import com.vaadin.client.JsArrayObject;
import com.vaadin.client.Profiler;
import com.vaadin.client.ServerConnector;
import com.vaadin.client.Util;
import com.vaadin.client.VConsole;
import com.vaadin.client.communication.RpcProxy;
import com.vaadin.client.communication.StateChangeEvent;
import com.vaadin.client.communication.StateChangeEvent.StateChangeHandler;
import com.vaadin.client.metadata.NoDataException;
import com.vaadin.client.metadata.OnStateChangeMethod;
import com.vaadin.client.metadata.Type;
import com.vaadin.client.metadata.TypeData;
import com.vaadin.client.metadata.TypeDataStore;
import com.vaadin.shared.communication.ClientRpc;
import com.vaadin.shared.communication.ServerRpc;
import com.vaadin.shared.communication.SharedState;
import com.vaadin.shared.communication.URLReference;
/**
* An abstract implementation of Connector.
*
* @author Vaadin Ltd
* @since 7.0.0
*
*/
public abstract class AbstractConnector implements ServerConnector,
StateChangeHandler {
private ApplicationConnection connection;
private String id;
private HandlerManager handlerManager;
private FastStringMap<HandlerManager> statePropertyHandlerManagers;
private FastStringMap<Collection<ClientRpc>> rpcImplementations;
private final boolean debugLogging = false;
private SharedState state;
private ServerConnector parent;
/**
* A map from client-to-server RPC interface class to the RPC proxy that
* sends outgoing RPC calls for that interface.
*/
private FastStringMap<ServerRpc> rpcProxyMap = FastStringMap.create();
/**
* Temporary storage for last enabled state to be able to see if it has
* changed. Can be removed once we are able to listen specifically for
* enabled changes in the state. Widget.isEnabled() cannot be used as all
* Widgets do not implement HasEnabled
*/
private boolean lastEnabledState = true;
private List<ServerConnector> children;
/*
* (non-Javadoc)
*
* @see com.vaadin.client.VPaintable#getConnection()
*/
@Override
public final ApplicationConnection getConnection() {
return connection;
}
/*
* (non-Javadoc)
*
* @see com.vaadin.client.Connector#getId()
*/
@Override
public String getConnectorId() {
return id;
}
/**
* Called once by the framework to initialize the connector.
* <p>
* Note that the shared state is not yet available when this method is
* called.
* <p>
* Connector classes should override {@link #init()} instead of this method.
*/
@Override
public final void doInit(String connectorId,
ApplicationConnection connection) {
Profiler.enter("AbstractConnector.doInit");
this.connection = connection;
id = connectorId;
addStateChangeHandler(this);
if (Profiler.isEnabled()) {
Profiler.enter("AbstractConnector.init " + Util.getSimpleName(this));
}
init();
if (Profiler.isEnabled()) {
Profiler.leave("AbstractConnector.init " + Util.getSimpleName(this));
}
Profiler.leave("AbstractConnector.doInit");
}
/**
* Called when the connector has been initialized. Override this method to
* perform initialization of the connector.
*/
// FIXME: It might make sense to make this abstract to force users to
// use init instead of constructor, where connection and id has not yet been
// set.
protected void init() {
}
/**
* Registers an implementation for a server to client RPC interface.
*
* Multiple registrations can be made for a single interface, in which case
* all of them receive corresponding RPC calls.
*
* @param rpcInterface
* RPC interface
* @param implementation
* implementation that should receive RPC calls
* @param <T>
* The type of the RPC interface that is being registered
*/
protected <T extends ClientRpc> void registerRpc(Class<T> rpcInterface,
T implementation) {
String rpcInterfaceId = rpcInterface.getName().replaceAll("\\$", ".");
if (null == rpcImplementations) {
rpcImplementations = FastStringMap.create();
}
if (null == rpcImplementations.get(rpcInterfaceId)) {
rpcImplementations.put(rpcInterfaceId, new ArrayList<ClientRpc>());
}
rpcImplementations.get(rpcInterfaceId).add(implementation);
}
/**
* Unregisters an implementation for a server to client RPC interface.
*
* @param rpcInterface
* RPC interface
* @param implementation
* implementation to unregister
*/
protected <T extends ClientRpc> void unregisterRpc(Class<T> rpcInterface,
T implementation) {
String rpcInterfaceId = rpcInterface.getName().replaceAll("\\$", ".");
if (null != rpcImplementations
&& null != rpcImplementations.get(rpcInterfaceId)) {
rpcImplementations.get(rpcInterfaceId).remove(implementation);
}
}
/**
* Returns an RPC proxy object which can be used to invoke the RPC method on
* the server.
*
* @param <T>
* The type of the ServerRpc interface
* @param rpcInterface
* The ServerRpc interface to retrieve a proxy object for
* @return A proxy object which can be used to invoke the RPC method on the
* server.
*/
protected <T extends ServerRpc> T getRpcProxy(Class<T> rpcInterface) {
String name = rpcInterface.getName();
if (!rpcProxyMap.containsKey(name)) {
rpcProxyMap.put(name, RpcProxy.create(rpcInterface, this));
}
return (T) rpcProxyMap.get(name);
}
@Override
public <T extends ClientRpc> Collection<T> getRpcImplementations(
String rpcInterfaceId) {
if (null == rpcImplementations) {
return Collections.emptyList();
}
return (Collection<T>) rpcImplementations.get(rpcInterfaceId);
}
@Override
public void fireEvent(GwtEvent<?> event) {
String profilerKey = null;
if (Profiler.isEnabled()) {
profilerKey = "Fire " + Util.getSimpleName(event) + " for "
+ Util.getSimpleName(this);
Profiler.enter(profilerKey);
}
if (handlerManager != null) {
handlerManager.fireEvent(event);
}
if (statePropertyHandlerManagers != null
&& event instanceof StateChangeEvent) {
Profiler.enter("AbstractConnector.fireEvent statePropertyHandlerManagers");
StateChangeEvent stateChangeEvent = (StateChangeEvent) event;
JsArrayString keys = statePropertyHandlerManagers.getKeys();
for (int i = 0; i < keys.length(); i++) {
String property = keys.get(i);
if (stateChangeEvent.hasPropertyChanged(property)) {
statePropertyHandlerManagers.get(property).fireEvent(event);
}
}
Profiler.leave("AbstractConnector.fireEvent statePropertyHandlerManagers");
}
if (Profiler.isEnabled()) {
Profiler.leave(profilerKey);
}
}
protected HandlerManager ensureHandlerManager() {
if (handlerManager == null) {
handlerManager = new HandlerManager(this);
}
return handlerManager;
}
@Override
public HandlerRegistration addStateChangeHandler(StateChangeHandler handler) {
return ensureHandlerManager()
.addHandler(StateChangeEvent.TYPE, handler);
}
@Override
public void removeStateChangeHandler(StateChangeHandler handler) {
ensureHandlerManager().removeHandler(StateChangeEvent.TYPE, handler);
}
@Override
public HandlerRegistration addStateChangeHandler(String propertyName,
StateChangeHandler handler) {
return ensureHandlerManager(propertyName).addHandler(
StateChangeEvent.TYPE, handler);
}
@Override
public void removeStateChangeHandler(String propertyName,
StateChangeHandler handler) {
ensureHandlerManager(propertyName).removeHandler(StateChangeEvent.TYPE,
handler);
}
private HandlerManager ensureHandlerManager(String propertyName) {
if (statePropertyHandlerManagers == null) {
statePropertyHandlerManagers = FastStringMap.create();
}
HandlerManager manager = statePropertyHandlerManagers.get(propertyName);
if (manager == null) {
manager = new HandlerManager(this);
statePropertyHandlerManagers.put(propertyName, manager);
}
return manager;
}
@Override
public void onStateChanged(StateChangeEvent stateChangeEvent) {
Profiler.enter("AbstractConnector.onStateChanged");
if (debugLogging) {
VConsole.log("State change event for "
+ Util.getConnectorString(stateChangeEvent.getConnector())
+ " received by " + Util.getConnectorString(this));
}
updateEnabledState(isEnabled());
FastStringMap<JsArrayObject<OnStateChangeMethod>> handlers = TypeDataStore
.getOnStateChangeMethods(getClass());
if (handlers != null) {
Profiler.enter("AbstractConnector.onStateChanged @OnStateChange");
HashSet<OnStateChangeMethod> invokedMethods = new HashSet<OnStateChangeMethod>();
JsArrayString propertyNames = handlers.getKeys();
for (int i = 0; i < propertyNames.length(); i++) {
String propertyName = propertyNames.get(i);
if (stateChangeEvent.hasPropertyChanged(propertyName)) {
JsArrayObject<OnStateChangeMethod> propertyMethods = handlers
.get(propertyName);
for (int j = 0; j < propertyMethods.size(); j++) {
OnStateChangeMethod method = propertyMethods.get(j);
if (invokedMethods.add(method)) {
method.invoke(stateChangeEvent);
}
}
}
}
Profiler.leave("AbstractConnector.onStateChanged @OnStateChange");
}
Profiler.leave("AbstractConnector.onStateChanged");
}
/*
* (non-Javadoc)
*
* @see com.vaadin.client.ServerConnector#onUnregister()
*/
@Override
public void onUnregister() {
if (debugLogging) {
VConsole.log("Unregistered connector "
+ Util.getConnectorString(this));
}
}
/**
* Returns the shared state object for this connector.
*
* Override this method to define the shared state type for your connector.
*
* @return the current shared state (never null)
*/
@Override
public SharedState getState() {
if (state == null) {
Profiler.enter("AbstractConnector.createState()");
state = createState();
Profiler.leave("AbstractConnector.createState()");
}
return state;
}
/**
* Creates a state object with default values for this connector. The
* created state object must be compatible with the return type of
* {@link #getState()}. The default implementation creates a state object
* using GWT.create() using the defined return type of {@link #getState()}.
*
* @return A new state object
*/
protected SharedState createState() {
try {
Type stateType = getStateType(this);
Object stateInstance = stateType.createInstance();
return (SharedState) stateInstance;
} catch (NoDataException e) {
throw new IllegalStateException(
"There is no information about the state for "
+ Util.getSimpleName(this)
+ ". Did you remember to compile the right widgetset?",
e);
}
}
public static Type getStateType(ServerConnector connector) {
try {
return TypeData.getType(connector.getClass()).getMethod("getState")
.getReturnType();
} catch (NoDataException e) {
throw new IllegalStateException(
"There is no information about the state for "
+ Util.getSimpleName(connector)
+ ". Did you remember to compile the right widgetset?",
e);
}
}
@Override
public ServerConnector getParent() {
return parent;
}
@Override
public void setParent(ServerConnector parent) {
this.parent = parent;
}
@Override
public List<ServerConnector> getChildren() {
if (children == null) {
return Collections.emptyList();
}
return children;
}
@Override
public void setChildren(List<ServerConnector> children) {
this.children = children;
}
@Override
public boolean isEnabled() {
if (!getState().enabled) {
return false;
}
if (getParent() == null) {
return true;
} else {
return getParent().isEnabled();
}
}
@Override
public void updateEnabledState(boolean enabledState) {
if (lastEnabledState == enabledState) {
return;
}
Profiler.enter("AbstractConnector.updateEnabledState");
lastEnabledState = enabledState;
for (ServerConnector c : getChildren()) {
// Update children as they might be affected by the enabled state of
// their parent
c.updateEnabledState(c.isEnabled());
}
Profiler.leave("AbstractConnector.updateEnabledState");
}
/**
* Gets the URL for a resource that has been added by the server-side
* connector using
* {@link com.vaadin.terminal.AbstractClientConnector#setResource(String, com.vaadin.terminal.Resource)}
* with the same key. <code>null</code> is returned if no corresponding
* resource is found.
*
* @param key
* a string identifying the resource.
* @return the resource URL as a string, or <code>null</code> if no
* corresponding resource is found.
*/
public String getResourceUrl(String key) {
URLReference urlReference = getState().resources.get(key);
if (urlReference == null) {
return null;
} else {
return urlReference.getURL();
}
}
/*
* (non-Javadoc)
*
* @see com.vaadin.client.ServerConnector#hasEventListener(java.lang.String)
*/
@Override
public boolean hasEventListener(String eventIdentifier) {
Set<String> reg = getState().registeredEventListeners;
return (reg != null && reg.contains(eventIdentifier));
}
/**
* Force the connector to recheck its state variables as the variables or
* their meaning might have changed.
*
* @since 7.3
*/
public void forceStateChange() {
StateChangeEvent event = new FullStateChangeEvent(this);
fireEvent(event);
}
private static class FullStateChangeEvent extends StateChangeEvent {
public FullStateChangeEvent(ServerConnector connector) {
super(connector, FastStringSet.create());
}
@Override
public boolean hasPropertyChanged(String property) {
return true;
}
}
}