Package com.iizix.server

Interface IEndPointConstructor<OBJECT>

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      IEndPointcreateInstance​(ServerShell server, java.lang.ThreadGroup serverThreadGroup, long sessionID, IWebSocketComm comm, java.lang.String uri, java.lang.String query, java.util.Map<java.lang.String,​java.util.List<java.lang.String>> headerFields, OBJECT object)
      Creates a new end point.
      java.lang.String[]getHandledContextPaths()
      Gets the list of potential handled context paths for the websocket.
      OBJECTisHandled​(ServerShell server, IWebSocketComm comm, java.lang.String uri, java.lang.String query, java.util.Map<java.lang.String,​java.util.List<java.lang.String>> headerFields)
      Checks if this end point constructor handles this URI.

    • Method Detail

      • getHandledContextPaths

        java.lang.String[] getHandledContextPaths()
        Gets the list of potential handled context paths for the websocket.
        Returns:
        The array of possibly handled context paths, or null for none.

      • isHandled

        OBJECT isHandled​(ServerShell server,
                 IWebSocketComm comm,
                 java.lang.String uri,
                 java.lang.String query,
                 java.util.Map<java.lang.String,​java.util.List<java.lang.String>> headerFields)
          throws java.io.IOException
        Checks if this end point constructor handles this URI.
        Parameters:
        server - Server shell.
        comm - The Web Socket communication properties.
        uri - The URI.
        query - The Query (after the URI).
        headerFields - HTTP header fields, null for a pre-check of the handled state, to avoid processing a request further to e.g. negotiate WebSocket protocol.
        Returns:
        An Object if handled, null when not handled. This Object is passed in to the createInstance() method when the headerFields are non-null and the construction should take place.
        Throws:
        java.io.IOException - For communications failure.

      • createInstance

        IEndPoint createInstance​(ServerShell server,
                         java.lang.ThreadGroup serverThreadGroup,
                         long sessionID,
                         IWebSocketComm comm,
                         java.lang.String uri,
                         java.lang.String query,
                         java.util.Map<java.lang.String,​java.util.List<java.lang.String>> headerFields,
                         OBJECT object)
                  throws java.io.IOException
        Creates a new end point.
        Parameters:
        server - Server shell.
        serverThreadGroup - The server thread group.
        sessionID - The session ID.
        comm - The Web Socket communication properties.
        uri - The URI.
        query - The Query (after the URI).
        headerFields - HTTP header fields.
        object - The Object returned in isHandled().
        Returns:
        The new end point.
        Throws:
        java.io.IOException - For communications failure.