Class GlobalResourceHandler

Constructor Detail

• GlobalResourceHandler

  public GlobalResourceHandler()

Method Detail

• handleRequest

  public boolean handleRequest​(VaadinSession session,
                               VaadinRequest request,
                               VaadinResponse response)
                        throws IOException

  Description copied from interface: RequestHandler

  Called when a request needs to be handled. If a response is written, this method should return true to indicate that no more request handlers should be invoked for the request.

  Note that request handlers by default do not lock the session. If you are using VaadinSession or anything inside the VaadinSession you must ensure the session is locked. This can be done by extending SynchronizedRequestHandler or by using VaadinSession.accessSynchronously(Runnable) or UI.accessSynchronously(Runnable).

  Specified by:

  handleRequest in interface RequestHandler

  Parameters:

  session - The session for the request

  request - The request to handle

  response - The response object to which a response can be written.

  Returns:

  true if a response has been written and no further request handlers should be called, otherwise false

  Throws:

  IOException - If an IO error occurred

• register

  public void register​(Resource resource,
                       ClientConnector ownerConnector)

  Registers a resource to be served with a global URL.

  A ConnectorResource registered for a LegacyComponent will be set to be served with a global URL. Other resource types will be ignored and thus not served by this handler.

  Parameters:

  resource - the resource to register

  ownerConnector - the connector to which the resource belongs

• getUri

  public String getUri​(ClientConnector connector,
                       ConnectorResource resource)

  Gets a global URI for a resource if it's registered with this handler.

  Parameters:

  connector - the connector for which the uri should be generated.

  resource - the resource for which the uri should be generated.

  Returns:

  an URI string, or null if the resource is not registered.

• unregisterConnector

  public void unregisterConnector​(ClientConnector connector)

  Notifies this handler that resources registered for the given connector can be released.

  Parameters:

  connector - the connector for which any registered resources can be released.