org.simpleframework.http.socket.service
Class ProtocolRouter

java.lang.Object
  org.simpleframework.http.socket.service.ProtocolRouter

All Implemented Interfaces:

Router

public class ProtocolRouter
extends Object
implements Router

The ProtocolRouter is used when there are multiple services that can be used. Each service is selected based on the protocol sent in the initiating request. If a match cannot be made based on the request then a default service us chosen.

Author:

Niall Gallagher

See Also:

RouterContainer

Constructor Summary

ProtocolRouter(Map<String,Service> registry, Service primary)
Constructor for the ProtocolRouter object.

Method Summary

Service

route(Request request, Response response) This is used to route an incoming request to a service if the request represents a WebSocket handshake as defined by RFC 6455.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtocolRouter

public ProtocolRouter(Map<String,Service> registry,
                      Service primary)
               throws IOException

Constructor for the ProtocolRouter object. This is used to create a router using a selection of services that can be selected using the Sec-WebSocket-Protocol header sent in the initiating request by the client.

Parameters:

registry - this is the registry of available services

primary - this is the default service to use

Throws:

IOException

Method Detail

route

public Service route(Request request,
                     Response response)

This is used to route an incoming request to a service if the request represents a WebSocket handshake as defined by RFC 6455. If the request is not a session initiating handshake then this will return a null value to allow it to be processed by some other part of the server.

Specified by:

route in interface Router

Parameters:

request - this is the request to use for routing

response - this is the response to establish the session

Returns:

a service that can be used to process the session