Class WebEndpointManager


  • public class WebEndpointManager
    extends Object
    Manager for working with formcycle web endpoints.
    Since:
    8.0.0
    Author:
    XIMA Media GmbH
    • Method Detail

      • registerWebEndpoint

        public static boolean registerWebEndpoint​(IWebEndpoint endpoint)
        Registers a web endpoint.
        Parameters:
        endpoint - to be registered.
        Returns:
        true if the web endpoint has been registered and false if the web endpoint could not be registered because it has already been registered.
      • unregisterWebEndpoint

        public static boolean unregisterWebEndpoint​(IWebEndpoint endpoint)
        Unregisters a custom web endpoint.
        Parameters:
        endpoint - Endpoint to be unregistered.
        Returns:
        true if the web endpoint has been unregistered and false if the web endpoint could not be unregistered because there was no registered web endpoint to be unregistered.
      • registerPluginMenuEntries

        public static void registerPluginMenuEntries​(String contextName,
                                                     IPluginMenuEntries menuEntries)
      • unregisterPluginMenuEntries

        public static void unregisterPluginMenuEntries​(IPluginMenuEntries menuEntries)
      • getWebEndpoint

        public static IWebEndpoint getWebEndpoint​(javax.servlet.http.HttpServletRequest req)
        Get the web endpoint for the given request
        Parameters:
        req - HTTP request from which the web endpoint is extracted.
        Returns:
        The web endpoint requested by the given HTTP request.
      • getRewriteUriResolvers

        public static Set<IRewriteUriResolver> getRewriteUriResolvers()
        Returns all registered web endpoints with rewrite uri resolvers. Web endpoints with rewrite uri resolvers perform request rewrites using the RewriteFilter.
        Returns:
        all registered web endpoints with rewrite uri resolvers.