Package com.sodius.mdw.server

Interface MDWorkbenchServer

  • public interface MDWorkbenchServer
    The central class of MDWorkbench Server. The singleton instance can be retrieved using the MDWorkbenchServer.INSTANCE field.

    This interface is not intended to be implemented by clients.

    • Method Detail

      • getWorkbench

        MDWorkbench getWorkbench()
                  throws CoreException
        Returns the MDWorkbench instance associated with the server.
        Returns:
        an MDWorkbench instance.
        Throws:
        CoreException - if anything prevents from creating an MDWorkbench instance

      • getServicesManager

        ServicesManager getServicesManager()
        Retrieves the manager of services.
        Returns:
        the services manager.

      • getLaunchManager

        LaunchManager getLaunchManager()
        Retrieves the manager of launches.
        Returns:
        the launch manager.

      • getStorageManager

        StorageManager getStorageManager()
        Retrieves the manager of storages.
        Returns:
        the storage manager.

      • getPlatformLocator

        PlatformLocator getPlatformLocator​(javax.servlet.ServletContext context)
        Returns the platform locator service, which gives information to a plug-in developer on where data shall be stored on server side.
        Parameters:
        context - the servlet context.
        Returns:
        the platform locator service.
        Since:
        2.1.0

      • getDiscoveryHelper

        DiscoveryHelper getDiscoveryHelper​(javax.servlet.http.HttpServletRequest request)
        Returns the discovery helpers, which provides URLs of MDWorkbench Server built-in servlets. The discovered servlet URLS are computed regarding the provided servlet request, notably to match the host name.
        Parameters:
        request - the servlet request in which the discovery process happens.
        Returns:
        the discovery helper.
        Since:
        2.1.0

      • getDiscoveryHelper

        @Deprecated
DiscoveryHelper getDiscoveryHelper​(String requestUri)
        Deprecated.
        Clients are recommended to use the getDiscoveryHelper(HttpServletRequest) method.
        Clients are advised not to use this method.
        Parameters:
        requestUri - the servlet request URL in which the discovery process happens.
        Returns:
        the discovery helper.
        See Also:
        getDiscoveryHelper(HttpServletRequest)

      • getLogger

        Logger getLogger()
        Returns the logger where information shall be logged. Such log information shall help the server administrator to monitor the server activity and track down issues. The log information remains on server side and is not meant to be accessible to the client.
        Returns:
        the logger where to output log information.

      • getState

        ServerState getState()
        Returns information on the MDWorkbench Server application state.
        Returns:
        the state of the MDWorkbench Server application.
        Since:
        2.2.0