com.vaadin.server.
Class GlobalResourceHandler
- java.lang.Object
-
- com.vaadin.server.GlobalResourceHandler
-
All Implemented Interfaces:
public class GlobalResourceHandler extends Object implements RequestHandler
A
RequestHandler
that takes care ofConnectorResource
s that should not be served by the connector.Since:
7.0.0
Version:
Author:
Vaadin Ltd
See Also:
-
-
Constructor Summary
Constructors Constructor Description GlobalResourceHandler()
-
Method Summary
All Methods Modifier and Type Method Description String
getUri(ClientConnector connector, ConnectorResource resource)
Gets a global URI for a resource if it's registered with this handler.
boolean
handleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)
Called when a request needs to be handled.
void
register(Resource resource, ClientConnector ownerConnector)
Registers a resource to be served with a global URL.
void
unregisterConnector(ClientConnector connector)
Notifies this handler that resources registered for the given connector can be released.
-
-
-
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 usingVaadinSession.accessSynchronously(Runnable)
orUI.accessSynchronously(Runnable)
.Specified by:
handleRequest
in interfaceRequestHandler
Parameters:
session
- The session for the requestrequest
- The request to handleresponse
- 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 aLegacyComponent
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 registerownerConnector
- 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.
-
-