Package org.eclipse.rap.rwt.application

Interface Application

public interface Application
This interface represents an RWT application before it is started. It's used to configure the various aspects that form an application such as entrypoints, URL mapping, styling, etc.

An instance of this interface is provided by the framework to the configure method of an ApplicationConfiguration.

Since:
2.0
See Also:

  • Method Details

    • setOperationMode

      void setOperationMode(Application.OperationMode operationMode)
      The operation mode in which the application will be running. The default is JEE_COMPATIBILITY.
      Parameters:
      operationMode - the operation mode to be used, must not be null
      See Also:

    • addEntryPoint

      void addEntryPoint(String path, Class<? extends EntryPoint> entryPointType, Map<String,String> properties)
      Registers an entrypoint at the given servlet path. A valid path must start with a slash ('/') and must not contain any other slashes. The servlet path "/" denotes the root path. Nested paths (e.g. "/path/subpath") are currently not supported.

      Properties can be specified to control client-specific aspects of the entrypoint such as theme, icons, etc. The acceptable keys and values depend on the client implementation. The class WebClient provides constants for the default RAP client.

      Parameters:
      path - a valid path to register the entry point at
      entryPointType - the entry point class to be registered, must not be null
      properties - properties that control client-specific aspects of the application, such as theme, icons, etc., may be null

    • addEntryPoint

      void addEntryPoint(String path, EntryPointFactory entryPointFactory, Map<String,String> properties)
      Registers an entrypoint at the given servlet path. A valid path must start with a slash ('/') and must not contain any other slashes. The servlet path "/" denotes the root path. Nested paths (e.g. "/path/subpath") are currently not supported.

      Properties can be specified to control client-specific aspects of the entrypoint such as theme, icons, etc. The acceptable keys and values depend on the client implementation. The class WebClient provides constants for the default RAP client.

      Parameters:
      path - a valid path to register the entry point at
      entryPointFactory - the entry point factory to be registered, must not be null
      properties - properties that control client-specific aspects of the application, such as theme, icons, etc., may be null

    • addStyleSheet

      void addStyleSheet(String themeId, String styleSheetLocation)
      Adds the given stylesheet to a theme. If a theme with the given ID does not exist, it is created and initialized with the stylesheet. If the theme exists already, the stylesheet is appended to the theme. The stylesheet file will be loaded with the classloader of the ApplicationConfiguration.
      Parameters:
      themeId - the id of the theme to register or to contribute to
      styleSheetLocation - the location of the CSS file in the format accepted by ClassLoader.getResource(String)
      See Also:

    • addStyleSheet

      void addStyleSheet(String themeId, String styleSheetLocation, ResourceLoader resourceLoader)
      Adds the given stylesheet to a theme. If a theme with the given ID does not exist, it is created and initialized with the stylesheet. If the theme exists already, the stylesheet is appended to the theme. The stylesheet file will be loaded with the classloader of the ApplicationConfiguration. The stylesheet file will be loaded using the given resource loader.
      Parameters:
      themeId - the id of the theme to register or to contribute to
      styleSheetLocation - the location of the CSS file in the format accepted by the given resource loader
      resourceLoader - the resource loader that is able to load the style sheet from the given location
      See Also:

    • setAttribute

      void setAttribute(String name, Object value)
      Set an initial attribute in the application context.
      Parameters:
      name - the name of the attribute, must not be null
      value - the attribute value
      See Also:

    • setSettingStoreFactory

      void setSettingStoreFactory(SettingStoreFactory settingStoreFactory)
      Configure this application to use a custom setting store implementation.
      Parameters:
      the - setting store implementation to use, must not be null
      See Also:

    • setExceptionHandler

      void setExceptionHandler(ExceptionHandler exceptionHandler)
      Sets the exception handler to which exceptions should be forwarded that occur while running the event loop.

      To give an exception handler the chance to log errors it called for all classes of exceptions. Errors however are re-thrown after the handler was called so that they cannot be swallowed.

      The default implementation throws the given exception, resulting in a HTTP 500 response.

      Parameters:
      the - exception handler to use, must not be null
      Since:
      2.1
      See Also:

    • addThemeableWidget

      void addThemeableWidget(Class<? extends Widget> widget)
      Register a themeable widget for this application. A themeable widget is a custom widget that supports theming. To do so, the widget provides a couple of classes and files, such as a theme adapter, that will be found by a naming convention. It's sufficient to register the widget itself. For details on custom widgets, please refer to the documentation.
      Parameters:
      widget - the widget to register as themeable widget
      Since:
      3.0

    • addServiceHandler

      void addServiceHandler(String serviceHandlerId, ServiceHandler serviceHandler)
      Adds a service handler to the application. A service handler is used to handle requests with a certain parameter inside the application. You can think of it like a lightweight servlet that has access to the user's session. Please see the documentation of ServiceHandler for the URL to access this service handler.
      Parameters:
      serviceHandlerId - the id for this servlet handler, used in the parameter
      serviceHandler - the servlet handler to register
      See Also:

    • addResource

      void addResource(String resourceName, ResourceLoader resourceLoader)