We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.server.dau.
Package com.vaadin.flow.server.dau
Class DAUUtils
java.lang.Object
com.vaadin.flow.server.dau.DAUUtils
A utility class for various daily active users collecting methods.
For internal use only. May be renamed or removed in a future release.
Since:
24.5
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final recordRecord to hold the DAU enforcement check result with the messages and the action to be run at the end of the request.
static enumA helper to mark operations that might be eligible for DAU tracking
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptiongetEnforcementNotificationMessages(VaadinRequest vaadinRequest) Gets the enforcement messages for the given request.
static Optional<jakarta.servlet.http.Cookie>getTrackingCookie(VaadinRequest request) Looks up for a daily active user tracking cookie in a given http request from browser.
static booleanisDauEnabled(VaadinService service) Checks if Daily Active User integration is enabled for the application.
static StringjsonEnforcementResponse(VaadinRequest vaadinRequest, DauEnforcementException enforcementException) Creates a JSON message which, when sent to client as-is, will cause a critical error to be shown with the given details.
static DAUUtils.EnforcementResulttrackDAU(VaadinService defaultVaadinService, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) Track DAU and check if enforcement should apply to the given request.
-
Field Details
-
ENFORCEMENT_EXCEPTION_KEY
-
STATUS_CODE_KEY
See Also:
-
-
Method Details
-
isDauEnabled
Checks if Daily Active User integration is enabled for the application.
Parameters:
service- the VaadinService instance.Returns:
true if DAU integration is enabled, otherwise false.
-
getTrackingCookie
Looks up for a daily active user tracking cookie in a given http request from browser.
Parameters:
request- Vaadin requestReturns:
optional cookie object, may be missing, if users tracking is disabled or if this request is an initial request from client.
-
jsonEnforcementResponse
public static String jsonEnforcementResponse(VaadinRequest vaadinRequest, DauEnforcementException enforcementException) Creates a JSON message which, when sent to client as-is, will cause a critical error to be shown with the given details.
Parameters:
vaadinRequest- the current Vaadin request.enforcementException- the enforcement exception raised by license checker.Returns:
an error messages in JSON format to be sent to the client.
-
getEnforcementNotificationMessages
public static EnforcementNotificationMessages getEnforcementNotificationMessages(VaadinRequest vaadinRequest) Gets the enforcement messages for the given request.
Enforcement messages are get from the registeredDAUCustomizer, if available. Otherwise, the default messages are returned.Parameters:
vaadinRequest- The current requestReturns:
enforcement messages for the request.
See Also:
-
trackDAU
public static DAUUtils.EnforcementResult trackDAU(VaadinService defaultVaadinService, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) Track DAU and check if enforcement should apply to the given request. If enforcement is needed, the enforcement messages are returned.
Method checks if the current request should be considered for DAU tracking by usingisDauEnabled(VaadinService).Parameters:
defaultVaadinService- the default VaadinService to use if the current service is not availablerequest- the request. Cannot be null.response- the responseReturns:
the enforcement result. Never null.
-