Package org.silverpeas.core.wbe

Interface WbeClientManager

  • All Known Implementing Classes:
    DragAndDropWebEditorClientManager
    public interface WbeClientManager
    In charge of the management of Web Browser Edition (WBE) clients (LibreOffice Online for example which uses WOPI protocol).

    Web Browser Edition of Silverpeas deals with this interface in order to manage properly the data about an edition according to a client. For each client, or dor each client protocol, this interface MUST be implemented.

    Author:
    silveryocha

    • Method Detail

      • clear

        void clear()
        Clears all the context of the Web Browser Edition.

      • isEnabled

        boolean isEnabled()
        Indicates if the WBE edition is enabled.
        Returns:
        true if enabled, false otherwise.

      • isHandled

        boolean isHandled​(WbeFile file)
        Indicates if given WbeFile is handled by WBE client.
        Parameters:
        file - the WBE file to check.
        Returns:
        true if handled, false otherwise.

      • prepareEditionWith

        <T extends WbeEdition> Optional<T> prepareEditionWith​(WbeUser user,
                                                      WbeFile file)
        Prepares a WBE edition from given data.

        If the client is enabled at Silverpeas's side and if the file is handled by the client, a WbeEdition instance is returned. It contains the necessary data to initialize an edition from the WEB services.

        Type Parameters:
        T - a WbeEdition type.
        Parameters:
        user - a WBE user.
        file - a Silverpeas's WBE file.
        Returns:
        an optional WbeEdition instance.

      • getAdministrationUrl

        Optional<String> getAdministrationUrl()
        Provides the URL that permits to access the administration of Web Browser Edition client.
        Returns:
        an optional URL as string.

      • getName

        String getName​(String language)
        Provides the name of the client.
        Parameters:
        language - the user language.
        Returns:
        a string.