Interface MappedWebSocketCreator

    • Method Detail

      • addMapping

        void addMapping​(java.lang.String spec,
                        WebSocketCreator creator)
        Add a mapping, of a pathspec to a WebSocketCreator.

        Recognized Path Spec syntaxes

        /path/to or / or *.ext or servlet|{spec}
        Servlet Syntax
        ^{spec} or regex|{spec}
        Regex Syntax
        uri-template|{spec}
        URI Template (see JSR356 and RFC6570 level 1)
        Parameters:
        spec - the path spec to use.
        creator - the websocket creator for this specific mapping
      • addMapping

        void addMapping​(PathSpec spec,
                        WebSocketCreator creator)
        Add a mapping.
        Parameters:
        spec - the path spec to use
        creator - the creator for the mapping
        Since:
        9.2.20
      • getMapping

        WebSocketCreator getMapping​(java.lang.String spec)
        /** Returns the creator for the given path spec.
        Parameters:
        spec - the spec to test for (using the same spec syntax as seen in addMapping(String, WebSocketCreator))
        Returns:
        the websocket creator if path spec exists, or null
      • removeMapping

        boolean removeMapping​(java.lang.String spec)
        Removes the mapping based on the given path spec.
        Parameters:
        spec - the path spec to remove (using the same spec syntax as seen in addMapping(String, WebSocketCreator))
        Returns:
        true if underlying mapping were altered, false otherwise