Package com.vaadin.flow.server.communication

Class PwaHandler

java.lang.Object

com.vaadin.flow.server.communication.PwaHandler

All Implemented Interfaces:

RequestHandler, Serializable

public class PwaHandler
extends Object
implements RequestHandler

Handles serving of PWA resources. Resources include:

• manifest
• offline fallback page
• icons

For internal use only. May be renamed or removed in a future release.

Since:

1.2

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_OFFLINE_STUB_PATH
static final String	SW_RUNTIME_PRECACHE_PATH

Constructor Summary

Constructors

Constructor	Description
PwaHandler(SerializableSupplier<PwaRegistry> pwaRegistryGetter)	Creates PwaHandler from PwaRegistry getter.

Method Summary

Modifier and Type	Method	Description
boolean	handleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)	Called when a request needs to be handled.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SW_RUNTIME_PRECACHE_PATH

public static final String SW_RUNTIME_PRECACHE_PATH

See Also:

• Constant Field Values

DEFAULT_OFFLINE_STUB_PATH

public static final String DEFAULT_OFFLINE_STUB_PATH

See Also:

• Constant Field Values

Constructor Details

PwaHandler

public PwaHandler(SerializableSupplier<PwaRegistry> pwaRegistryGetter)

Creates PwaHandler from PwaRegistry getter.

Parameters:

pwaRegistryGetter - PWA registry getter

Method Details

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(Command) or UI.accessSynchronously(Command).

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