Package com.iizix.server.run.remote

Class RemoteBuilderEndPointConstructor

  • All Implemented Interfaces:
    IEndPointConstructor<java.lang.Object>
    public class RemoteBuilderEndPointConstructor
extends java.lang.Object
implements IEndPointConstructor<java.lang.Object>
    The Remote Customized iiziRun Builder constructor of end points.
    Author:
    Christopher Mindus

    • Constructor Summary

      Constructors 
      ConstructorDescription
      RemoteBuilderEndPointConstructor​(boolean isVerbose)
      Constructor at server start builds and checks the initial environment.

    • Method Summary

      All Methods Instance Methods Concrete 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, java.lang.Object object)
      Creates a new end point.
      java.lang.String[]getHandledContextPaths()
      Gets the list of potential handled context paths for the websocket.
      java.lang.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.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • RemoteBuilderEndPointConstructor

        public RemoteBuilderEndPointConstructor​(boolean isVerbose)
        Constructor at server start builds and checks the initial environment.
        Parameters:
        isVerbose - The verbose flag.

    • Method Detail

      • getHandledContextPaths

        public java.lang.String[] getHandledContextPaths()
        Gets the list of potential handled context paths for the websocket.
        Specified by:
        getHandledContextPaths in interface IEndPointConstructor<java.lang.Object>
        Returns:
        The array of possibly handled context paths.

      • isHandled

        public java.lang.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)
        Checks if this end point constructor handles this URI.
        Specified by:
        isHandled in interface IEndPointConstructor<java.lang.Object>
        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.

      • createInstance

        public 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,
                                java.lang.Object object)
                         throws java.io.IOException
        Creates a new end point.
        Specified by:
        createInstance in interface IEndPointConstructor<java.lang.Object>
        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.