Class WebClient
- All Implemented Interfaces:
Serializable,Client
- Since:
- 2.0
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringEntrypoint property name for custom HTML code to be placed inside thebodyof the startup page.static final StringEntrypoint property name for specifing the content security policy.static final StringEntrypoint property name to disable the shutdown request.static final StringEntrypoint property name for the website icon (a.k.a favicon or shortcut icon) that will be displayed by the web browser.static final StringEntrypoint property name for additional HTML elements to be added to the <head> section of the startup page.static final StringEntrypoint property name for the page overflow behavior.static final StringEntrypoint property name for the title that will be displayed in the browser window.static final StringEntrypoint property name for a custom theme to be used with the entrypoint. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription<T extends ClientService>
TgetService(Class<T> type) Returns this client's implementation of a given service, if available.
-
Field Details
-
THEME_ID
Entrypoint property name for a custom theme to be used with the entrypoint. The value must be the id of a registered theme. If omitted, the default theme will be used. -
HEAD_HTML
Entrypoint property name for additional HTML elements to be added to the <head> section of the startup page. The value must contain a valid HTML snippet that consists only of HTML elements that are permissible sub-elements ofheadsuch asmetaorlink.Warning: the property value will not be validated by the framework. Invalid HTML can break the application entirely or lead to problems that are hard to identify. It's the responsibility of the developer to ensure the correctness of the resulting page.
-
BODY_HTML
Entrypoint property name for custom HTML code to be placed inside thebodyof the startup page. The value must be proper HTML 4.0 in order not to break the surrounding page.Warning: the property value will not be validated by the framework. Invalid HTML can break the application entirely or lead to problems that are hard to identify. It's the responsibility of the developer to ensure the correctness of the resulting page.
-
PAGE_TITLE
Entrypoint property name for the title that will be displayed in the browser window. The value must be the title string without any HTML markup. -
PAGE_OVERFLOW
Entrypoint property name for the page overflow behavior. The value must be one of the "scroll", "scrollX", "scrollY". If this property is not set the page overflow is disabled. -
FAVICON
Entrypoint property name for the website icon (a.k.a favicon or shortcut icon) that will be displayed by the web browser. The value must contain a valid path where the image can be accessed on the server.Note: if this property is provided, the image resource must be registered to be available. Favicons are usually expected to be 16x16 px in size. If the icon has to work with legacy browsers, use a file in the ICO format.
-
CSP
Entrypoint property name for specifing the content security policy. The value must contain a valid string with content security policy directives.Note: Use "nonce-" without random value in your "script-src" directive. The nonce value will be appended dinamically. Example: "script-src 'strict-dynamic' 'nonce-' 'unsafe-eval' http: https:; object-src 'none'; base-uri 'none';"
-
DISABLE_SHUTDOWN_REQUEST
Entrypoint property name to disable the shutdown request. Accepts only "true" as property value.
-
-
Constructor Details
-
WebClient
public WebClient()
-
-
Method Details
-
getService
Description copied from interface:ClientReturns this client's implementation of a given service, if available.- Specified by:
getServicein interfaceClient- Parameters:
type- the type of the requested service, must be a subtype of ClientService- Returns:
- the requested service if provided by this client, otherwise
null - See Also:
-