Package com.iizix.nio
Interface WebSocketAcceptor
- All Known Implementing Classes:
JakartaEEServer,JettyRunConfiguration,RuntimeBuilderServer,ServerShell,StandardServer,TransactionProcessor
public interface WebSocketAcceptorThe WebSocket server acceptor listener.- Author:
- Christopher Mindus
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String[]getHandledContextPaths()Gets the list of potential handled context paths for the websocket.java.lang.ObjectisRequestURIAccepted(IWebSocketComm comm, java.lang.String uri, java.util.Map<java.lang.String,java.util.List<java.lang.String>> headerFields)Called to check if a request URI can be accepted.
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
nullfor none.
isRequestURIAccepted
java.lang.Object isRequestURIAccepted(IWebSocketComm comm, java.lang.String uri, java.util.Map<java.lang.String,java.util.List<java.lang.String>> headerFields)
Called to check if a request URI can be accepted.- Parameters:
comm- The WebSocket communication instance. For certain WebSocket implementations, this instance isnull(e.g. for Grizzly in GlassFish).uri- The request URI, formatted as e.g. "/something/more.ws".headerFields- HTTP header fields, null if called for a quick-check of acceptance.- Returns:
- Object an object that is attached to the TransactionComm instance, or null if the URI is not accepted.