Class VSViewerEndPointConstructor
java.lang.Object
com.iizix.server.vsviewer.VSViewerEndPointConstructor
- All Implemented Interfaces:
IEndPointConstructor<Object>
The VirtualSpace Viewer end point constructor.
- Author:
- Christopher Mindus
Constructor Summary
ConstructorsConstructorDescriptionConstructor for a server that has a VSViewer: a development server.VSViewerEndPointConstructor(boolean isAllowed) Constructor.Method Summary
Modifier and TypeMethodDescriptioncreateInstance(ServerShell server, long sessionID, IWebSocketComm comm, String uri, String query, Map<String, List<String>> headerFields, Object object) Creates a new end point.String[]Gets the list of potential handled context paths for the websocket.isHandled(ServerShell server, IWebSocketComm comm, String uri, String query, Map<String, List<String>> headerFields) Checks if this end point constructor handles this URI.
Constructor Details
VSViewerEndPointConstructor
public VSViewerEndPointConstructor()Constructor for a server that has a VSViewer: a development server.VSViewerEndPointConstructor
public VSViewerEndPointConstructor(boolean isAllowed) Constructor.- Parameters:
isAllowed- true for a server that has a VSViewer (VSViewerAccess.isAllowedOn(ServerShell)), false for a production server: the path is registered there to refuse every request of it at the end point, each with one WARNING line.
Method Details
getHandledContextPaths
Gets the list of potential handled context paths for the websocket.- Specified by:
getHandledContextPathsin interfaceIEndPointConstructor<Object>- Returns:
- The array of possibly handled context paths, or
nullfor none.
isHandled
public Object isHandled(ServerShell server, IWebSocketComm comm, String uri, String query, Map<String, List<String>> headerFields) Checks if this end point constructor handles this URI.- Specified by:
isHandledin interfaceIEndPointConstructor<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 theheaderFieldsare non-null and the construction should take place.
createInstance
public IEndPoint createInstance(ServerShell server, long sessionID, IWebSocketComm comm, String uri, String query, Map<String, List<String>> headerFields, Object object) throws IOException Creates a new end point.- Specified by:
createInstancein interfaceIEndPointConstructor<Object>- Parameters:
server- Server shell.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 inisHandled().- Returns:
- The new end point.
- Throws:
IOException- For communications failure.