com.vaadin.server.ClientConnector Maven / Gradle / Ivy
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.server;
import java.io.IOException;
import java.lang.reflect.Method;
import java.util.Collection;
import java.util.List;
import com.vaadin.event.ConnectorEvent;
import com.vaadin.event.ConnectorEventListener;
import com.vaadin.shared.Connector;
import com.vaadin.shared.Registration;
import com.vaadin.shared.communication.SharedState;
import com.vaadin.ui.Component;
import com.vaadin.ui.HasComponents;
import com.vaadin.ui.UI;
import com.vaadin.util.ReflectTools;
import elemental.json.JsonObject;
/**
* Interface implemented by all connectors that are capable of communicating
* with the client side.
*
* @author Vaadin Ltd
* @since 7.0.0
*
*/
public interface ClientConnector extends Connector {
/**
* Event fired after a connector is attached to the application.
*/
public static class AttachEvent extends ConnectorEvent {
public static final String ATTACH_EVENT_IDENTIFIER = "clientConnectorAttach";
public AttachEvent(ClientConnector source) {
super(source);
}
}
/**
* Interface for listening {@link AttachEvent connector attach events}.
*
*/
@FunctionalInterface
public static interface AttachListener extends ConnectorEventListener {
public static final Method attachMethod = ReflectTools
.findMethod(AttachListener.class, "attach", AttachEvent.class);
/**
* Called when a AttachListener is notified of a AttachEvent.
*
* @param event
* The attach event that was fired.
*/
public void attach(AttachEvent event);
}
/**
* Event fired before a connector is detached from the application.
*/
public static class DetachEvent extends ConnectorEvent {
public static final String DETACH_EVENT_IDENTIFIER = "clientConnectorDetach";
public DetachEvent(ClientConnector source) {
super(source);
}
}
/**
* Interface for listening {@link DetachEvent connector detach events}.
*
*/
@FunctionalInterface
public static interface DetachListener extends ConnectorEventListener {
public static final Method detachMethod = ReflectTools
.findMethod(DetachListener.class, "detach", DetachEvent.class);
/**
* Called when a DetachListener is notified of a DetachEvent.
*
* @param event
* The detach event that was fired.
*/
public void detach(DetachEvent event);
}
/**
* Add a listener for connector attach events.
*
* @since 8.0
*
* @param listener an AttachListener implementation
* @return Registration for unregistering the listener
*/
public Registration addAttachListener(AttachListener listener);
@Deprecated
public void removeAttachListener(AttachListener listener);
/**
* Add a listener for connector detach events.
*
* @since 8.0
*
* @param listener an AttachListener implementation
* @return Registration for unregistering the listener
*/
public Registration addDetachListener(DetachListener listener);
@Deprecated
public void removeDetachListener(DetachListener listener);
/**
* An error event for connector related errors. Use {@link #getConnector()}
* to find the connector where the error occurred.
*/
public static class ConnectorErrorEvent
extends com.vaadin.server.ErrorEvent {
private final Connector connector;
public ConnectorErrorEvent(Connector connector, Throwable t) {
super(t);
this.connector = connector;
}
/**
* Gets the connector for which this error occurred.
*
* @return The connector for which the error occurred
*/
public Connector getConnector() {
return connector;
}
}
/**
* Returns the list of pending server to client RPC calls and clears the
* list.
*
* @return an unmodifiable ordered list of pending server to client method
* calls (not null)
*/
public List retrievePendingRpcCalls();
/**
* Checks if the communicator is enabled. An enabled communicator is allowed
* to receive messages from its counter-part.
*
* @return true if the connector can receive messages, false otherwise
*/
public boolean isConnectorEnabled();
/**
* Returns the type of the shared state for this connector.
*
* @return The type of the state. Must never return null.
*/
public Class getStateType();
@Override
public ClientConnector getParent();
/**
* @deprecated As of 7.0, use {@link #markAsDirty()} instead
*/
@Deprecated
public void requestRepaint();
/**
* Marks that this connector's state might have changed. When the framework
* is about to send new data to the client-side, it will run
* {@link #beforeClientResponse(boolean)} followed by {@link #encodeState()}
* for all connectors that are marked as dirty and send any updated state
* info to the client.
*
* @since 7.0.0
*/
public void markAsDirty();
/**
* @deprecated As of 7.0, use {@link #markAsDirtyRecursive()} instead
*/
@Deprecated
public void requestRepaintAll();
/**
* Causes this connector and all connectors below it to be marked as dirty.
*
* This should only be used in special cases, e.g when the state of a
* descendant depends on the state of an ancestor.
*
* @see #markAsDirty()
*
* @since 7.0.0
*/
public void markAsDirtyRecursive();
/**
* Checks if the connector is attached to a VaadinSession.
*
* @since 7.1
* @return true if the connector is attached to a session, false otherwise
*/
public boolean isAttached();
/**
* Notifies the connector that it is connected to a VaadinSession (and
* therefore also to a UI).
*
* The caller of this method is {@link Component#setParent(HasComponents)}
* if the parent is itself already attached to the session. If not, the
* parent will call the {@link #attach()} for all its children when it is
* attached to the session. This method is always called before the
* connector's data is sent to the client-side for the first time.
*
*
*
* The attachment logic is implemented in {@link AbstractClientConnector}.
*
*/
public void attach();
/**
* Notifies the connector that it is detached from its VaadinSession.
*
*
* The caller of this method is {@link Component#setParent(HasComponents)} if the
* parent is in the session. When the parent is detached from the session it
* is its responsibility to call {@link #detach()} for each of its children.
*
*
*/
public void detach();
/**
* Get a read-only collection of all extensions attached to this connector.
*
* @return a collection of extensions
*/
public Collection getExtensions();
/**
* Remove an extension from this connector.
*
* @param extension
* the extension to remove.
*/
public void removeExtension(Extension extension);
/**
* Returns the UI this connector is attached to.
*
* @return The UI this connector is attached to or null if it is not
* attached to any UI
*/
public UI getUI();
/**
* Called before the shared state and RPC invocations are sent to the
* client. Gives the connector an opportunity to set computed/dynamic state
* values or to invoke last minute RPC methods depending on other component
* features.
*
* @param initial
* true if the client-side connector will be created
* and initialized after this method has been invoked.
* false if there is already an initialized
* client-side connector.
*
* @since 7.0
*/
public void beforeClientResponse(boolean initial);
/**
* Called by the framework to encode the state to a JSONObject. This is
* typically done by calling the static method
* {@link LegacyCommunicationManager#encodeState(ClientConnector, SharedState)}
* .
*
* @return a JSON object with the encoded connector state
*/
public JsonObject encodeState();
/**
* Handle a request directed to this connector. This can be used by
* connectors to dynamically generate a response and it is also used
* internally when serving {@link ConnectorResource}s.
*
* Requests to /APP/connector/[ui id]/[connector id]/ are
* routed to this method with the remaining part of the requested path
* available in the path parameter.
*
* NOTE that the session is not locked when this method is called. It is the
* responsibility of the connector to ensure that the session is locked
* while handling state or other session related data. For best performance
* the session should be unlocked before writing a large response to the
* client.
*
*
* @param request
* the request that should be handled
* @param response
* the response object to which the response should be written
* @param path
* the requested relative path
* @return true if the request has been handled,
* false if no response has been written.
* @throws IOException
* if there is a problem generating a response.
*/
public boolean handleConnectorRequest(VaadinRequest request,
VaadinResponse response, String path) throws IOException;
/**
* Returns the RPC manager instance to use when receiving calls for an RPC
* interface.
*
* @param rpcInterfaceName
* name of the interface for which the call was made
* @return ServerRpcManager or null if none found for the interface
*/
public ServerRpcManager getRpcManager(String rpcInterfaceName);
/**
* Gets the error handler for the connector.
*
* The error handler is dispatched whenever there is an error processing the
* data coming from the client to this connector.
*
* @return The error handler or null if not set
*/
public ErrorHandler getErrorHandler();
/**
* Sets the error handler for the connector.
*
* The error handler is dispatched whenever there is an error processing the
* data coming from the client for this connector.
*
* @param errorHandler
* The error handler for this connector
*/
public void setErrorHandler(ErrorHandler errorHandler);
}