Package de.xima.fc

Class PathHandler.Web

  • Enclosing class:
    PathHandler

    public static final class PathHandler.Web
    extends Object
    Zentrale Behandlung von Formcycle-URLs
    • Method Detail

      • baseUrlFor

        public static String baseUrlFor​(Mandant mandant)
        Liefert die (ggfs mandantenabhängige) Basis-Adresse zum Aufruf von Formcycle.
        Parameters:
        mandant - - Mandant der die Basis-URL definiert haben sollte
        Returns:
        Basis URL zu Formcycle
      • getFormSessionParamName

        public static String getFormSessionParamName()
      • baseFormUrlFor

        public static String baseFormUrlFor​(Mandant mandant)
        Returns the clients base-url with form servlet sub-dir
        Parameters:
        mandant - Mandant for which the url should be returned
        Returns:
        base-url with form servlet sub-dir
      • baseFormIncludeUrlFor

        public static String baseFormIncludeUrlFor​(Mandant client)
        Determines the path to the JavaScript file for including the form via AJAX. For example:
         https://demo.formcycle.eu/formcycle/form/include.js
         
        Parameters:
        client - The client Mandant for the base URL.
        Returns:
        Path to the include script without options.
      • baseIncludesFor

        public static String baseIncludesFor​(Mandant client)
        Generates the base URL for form includes, /form/includes.
        Parameters:
        client - A client for which to generate the URL.
        Returns:
        The URL for form includes for the client.
      • baseIncludesFor

        public static String baseIncludesFor​(MandantFrontendServer mfs)
        Generates the base URL for form includes, /form/includes.
        Parameters:
        mfs - A frontend server for which to generate the URL.
        Returns:
        The URL for form includes for the client.
      • formIncludeUrlFor

        public static String formIncludeUrlFor​(Projekt p)
        Builds the link to the form include JavaScript (/form/include.js). This uses the URL to the master server.
        Parameters:
        p - The project for which to get the URL.
        Returns:
        The link to the include script.
      • formIncludeUrlFor

        public static String formIncludeUrlFor​(Projekt p,
                                               MandantFrontendServer mfs)
        Builds the link to the form include JavaScript (/form/include.js) for the given frontend server.
        Parameters:
        p - The project for which to get the URL.
        mfs - The frontend server to use.
        Returns:
        The link to the include script.
      • fd2CurrentEditFor

        public static String fd2CurrentEditFor​(Projekt project,
                                               String baseUrl)
      • fd2VersionEditFor

        public static String fd2VersionEditFor​(Projekt project)
      • fd2VersionEditFor

        public static String fd2VersionEditFor​(Projekt project,
                                               String baseUrl)
      • fd2VersionEditFor

        public static String fd2VersionEditFor​(Long projectId,
                                               Long versionId,
                                               Long workflowVersionId,
                                               String baseUrl)
      • fd2VersionEditFor

        public static String fd2VersionEditFor​(Long projectId,
                                               Long versionId,
                                               Long workflowVersionId,
                                               String baseUrl,
                                               String initialViewId)
      • getDesignerBase

        public static String getDesignerBase​(String baseUrl)
      • formRequestFor

        public static String formRequestFor​(Projekt project)
        Liefert die allgemeine (offizielle und nach außen sichtbare) URL zum Aufruf des aktiven Formulars eines Projektes. Diese Adresse ist für alle FormVersionen und FormTypen gleich, sie leitet intern auf die konkrete Formular-Adresse weiter.
        Parameters:
        project - - das betreffende Projekt
        Returns:
        URL zum Aufruf des aktiven Formulars
      • formRequestFor

        public static String formRequestFor​(Projekt project,
                                            MandantFrontendServer mfs)
        Liefert die allgemeine (offizielle und nach außen sichtbare) URL zum Aufruf des aktiven Formulars eines Projektes. Diese Adresse ist für alle FormVersionen und FormTypen gleich, sie leitet intern auf die konkrete Formular-Adresse weiter.
        Parameters:
        project - - das betreffende Projekt
        Returns:
        URL zum Aufruf des aktiven Formulars
      • getBaseProvideUrl

        public static String getBaseProvideUrl​(Mandant client)
        Parameters:
        client - Mandant
        Returns:
        String base url for accessing forms of the given client
      • aliasFormRequestFor

        public static String aliasFormRequestFor​(Projekt p)
        Liefert die allgemeine (offizielle und nach außen sichtbare) URL zum Aufruf des aktiven Formulars eines Projektes. Diese Adresse ist für alle FormVersionen und FormTypen gleich, sie leitet intern auf die konkrete Formular-Adresse weiter.
        Parameters:
        p - - das betreffende Projekt
        Returns:
        URL zum Aufruf des aktiven Formulars
      • aliasFormRequestWithoutAlias

        public static String aliasFormRequestWithoutAlias​(Mandant client)
      • aliasFormImageFor

        public static String aliasFormImageFor​(Projekt project,
                                               String basePath)
        Liefert die allgemeine (offizielle und nach außen sichtbare) URL zum Aufruf des Thumbnail des aktiven Formulars eines
        Parameters:
        project - - das betreffende Projekt
        Returns:
        URL zum Aufruf des aktiven Formulars
      • aliasFormImageFor

        public static String aliasFormImageFor​(Long projectId,
                                               String basePath)
      • printFormRequestFor

        public static String printFormRequestFor​(Projekt p)
      • formRequestFor

        public static String formRequestFor​(Long projectId,
                                            String baseURL)
      • formRequestFor

        public static String formRequestFor​(FormVersion fv,
                                            String baseURL)
        Liefert die allgemeine (offizielle und nach außen sichtbare) URL zum Aufruf des Formulars zur übergebenen Formularversion. Diese Adresse ist für alle FormVersionen und FormTypen gleich, sie leitet intern auf die konkrete Formular-Adresse weiter.
        Parameters:
        fv - - die betreffende Formularversion
        baseURL - String die Base-URL
        Returns:
        URL zum Aufruf des aktiven Formulars
      • formPreviewFor

        public static String formPreviewFor​(Long projectId,
                                            String baseURL)
      • formActionFor

        public static String formActionFor​(Projekt project,
                                           int formVersion)
        Returns the URL for processing submitted forms of the given project. When rendering an HTML form, this is used as the value action for the attribute action of the FORM HTML element.
        Example: http://localhost/xima-formcycle/form/process/742/2/
        Parameters:
        formVersion - The version number of the form.
        project - The project for which the URL is generated.
        Returns:
        URL URL for processing submitted forms of the given project.
        See Also:
        baseUrlFor(Mandant)
      • formCorrectionFor

        public static String formCorrectionFor​(Projekt project,
                                               int formVersion)
        Similar to formActionFor(Projekt, int), but with additional options that influence workflow processing.
        Example: http://localhost/xima-formcycle/form/workflow/742/2/
        Parameters:
        formVersion - The version number of the form.
        project - The project for which the URL is generated.
        Returns:
        URL URL for processing submitted forms of the given project.
        See Also:
        baseUrlFor(Mandant)
      • formReprovideFor

        public static String formReprovideFor​(Vorgang process,
                                              String baseURL)
        Liefert die URL zum Aufrufen eines bereits ausgefüllten Formulars
        Parameters:
        process - - Vorgang, anhand dessen Vorgang.getProzessId() das ausgefüllte Formular ermittelt wird
        baseURL - String die Base-URL
        Returns:
        Link zum ausgefüllten Formular
      • includeUrlFor

        public static String includeUrlFor​(Mandant client,
                                           String resourceName)
        Returns the URL to the given form resource, eg. form/includes/010-jquery-min.js?_nc=20190904014040
        Parameters:
        client - Client for which to generate the URL.
        resourceName - Name of a resource
        Returns:
        The URL for the form resource.
      • includeUrlFor

        public static String includeUrlFor​(MandantFrontendServer mfs,
                                           String resourceName)
        Returns the URL to the given form resource, eg. form/includes/010-jquery-min.js?_nc=20190904014040
        Parameters:
        mfs - Frontend server for which to generate the URL.
        resourceName - Name of a resource
        Returns:
        The URL for the form resource.
      • loginRequestFor

        public static String loginRequestFor​(Mandant mandant)
        Diese Methode liefert die URL zur Startseite von XFC. Hier kann der Nutzer sich mit deinem Account anmelden
        Parameters:
        mandant - - Mandant dessen gesetzte Basis-URL genutzt werden soll
        Returns:
        URL zur XFC-Startseite
      • projektIdFrom

        public static Long projektIdFrom​(String formReqUrl)
        Extrahiert aus der übergebenen URL die XFC-Projekt-ID
        Parameters:
        formReqUrl - - die zu verarbeitende URL
        Returns:
        die extrahierte Projekt-ID oder ITransferableEntity.INVALID_ID, wenn kein entsprechender Wert gefunden wurde
      • formVersionNumFrom

        public static int formVersionNumFrom​(String formReqUrl)
        Extrahiert aus der übergebenen URL die Form-Versions-Nummer
        Parameters:
        formReqUrl - - die zu verarbeitende URL
        Returns:
        die extrahierte FormVersion-Nummer oder FormVersion.INVALID_VERS_NUM, wenn kein entsprechender Wert gefunden wurde
      • formVersionStringFrom

        public static String formVersionStringFrom​(String formReqUrl)
      • prozessIdFrom

        public static String prozessIdFrom​(String formReqUrl)
        Extrahiert aus der übergebenen URL die Form-Versions-Nummer
        Parameters:
        formReqUrl - - die zu verarbeitende URL
        Returns:
        die extrahierte FormVersion-Nummer oder FormVersion.INVALID_VERS_NUM, wenn kein entsprechender Wert gefunden wurde
      • formAttachmentDownload

        public static String formAttachmentDownload​(String baseUrl)
      • iCalDownload

        public static String iCalDownload​(String baseUrl)