org.fabric3.binding.web.runtime.channel.WebChannelBindingBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of fabric3-binding-web Show documentation
Show all versions of fabric3-binding-web Show documentation
Support for Comet and Websocket endpoints
/*
* Fabric3
* Copyright (c) 2009-2011 Metaform Systems
*
* Fabric3 is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version, with the
* following exception:
*
* Linking this software statically or dynamically with other
* modules is making a combined work based on this software.
* Thus, the terms and conditions of the GNU General Public
* License cover the whole combination.
*
* As a special exception, the copyright holders of this software
* give you permission to link this software with independent
* modules to produce an executable, regardless of the license
* terms of these independent modules, and to copy and distribute
* the resulting executable under terms of your choice, provided
* that you also meet, for each linked independent module, the
* terms and conditions of the license of that module. An
* independent module is a module which is not derived from or
* based on this software. If you modify this software, you may
* extend this exception to your version of the software, but
* you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version.
*
* Fabric3 is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details.
*
* You should have received a copy of the
* GNU General Public License along with Fabric3.
* If not, see {
private static final String CONTEXT_PATH = "/channels/*";
private BroadcasterManager broadcasterManager;
private PubSubManager pubSubManager;
private ServletHost servletHost;
private AtmosphereServlet gatewayServlet;
private long timeout = 1000 * 10 * 60;
private ChannelMonitor monitor;
public WebChannelBindingBuilder(@Reference BroadcasterManager broadcasterManager,
@Reference PubSubManager pubSubManager,
@Reference ServletHost servletHost,
@Monitor ChannelMonitor monitor) {
this.broadcasterManager = broadcasterManager;
this.pubSubManager = pubSubManager;
this.servletHost = servletHost;
this.monitor = monitor;
}
/**
* Sets the client connection timeout
*
* @param timeout the timeout in milliseconds
*/
@Property(required = false)
public void setTimeout(long timeout) {
this.timeout = timeout;
}
/**
* Initializes the Atmosphere infrastructure, including the gateway servlet, websocket handler, and channel router. The gateway servlet is
* registered with the runtime Servlet host to receive incoming comet and websocket requests.
*
* @throws ServletException if an error initializing one of the Atmosphere servlets is encountered
*/
@Init
public void init() throws ServletException {
GatewayServletContext context = new GatewayServletContext(CONTEXT_PATH);
// TODO support other configuration as specified in AtmosphereServlet init()
context.setInitParameter(AtmosphereServlet.PROPERTY_SESSION_SUPPORT, "false");
context.setInitParameter(AtmosphereServlet.WEBSOCKET_ATMOSPHEREHANDLER, "false"); // turn the handler off as it is overriden below
context.setInitParameter(AtmosphereServlet.WEBSOCKET_SUPPORT, "true");
GatewayServletConfig config = new GatewayServletConfig(context);
gatewayServlet = new ChannelGatewayServlet(servletHost, pubSubManager);
gatewayServlet.init(config);
ChannelRouter router = new ChannelRouter(pubSubManager, monitor);
ReflectorServletProcessor processor = new ReflectorServletProcessor();
processor.setServlet(router);
processor.init(config);
ChannelWebSocketHandler webSocketHandler = new ChannelWebSocketHandler(processor, broadcasterManager);
gatewayServlet.addAtmosphereHandler("/*", webSocketHandler);
servletHost.registerMapping(CONTEXT_PATH, gatewayServlet);
}
@Destroy
public void destroy() {
servletHost.unregisterMapping(CONTEXT_PATH);
gatewayServlet.destroy();
}
public void build(WebChannelBindingDefinition definition, Channel channel) throws BuilderException {
URI sourceUri = channel.getUri();
String path = UriHelper.getBaseName(sourceUri);
OperationsAllowed allowed = definition.getAllowed();
// setup the subscriber infrastructure
if (OperationsAllowed.SUBSCRIBE == allowed || OperationsAllowed.ALL == allowed) {
// create the subscriber responsible for broadcasting channel events to suspended clients
Broadcaster broadcaster = broadcasterManager.getChannelBroadcaster(path);
EventStream stream = new BroadcasterEventStream(broadcaster);
ChannelSubscriber subscriber = new ChannelSubscriberImpl(stream, timeout);
channel.subscribe(sourceUri, subscriber);
pubSubManager.register(path, subscriber);
} else {
// clients are not not allowed to subscribe
DenyChannelSubscriber subscriber = new DenyChannelSubscriber();
pubSubManager.register(path, subscriber);
}
// create the publisher responsible for flowing events from clients to the channel
if (OperationsAllowed.PUBLISH == allowed || OperationsAllowed.ALL == allowed) {
DefaultChannelPublisher publisher = new DefaultChannelPublisher();
channel.addHandler(publisher);
pubSubManager.register(path, publisher);
} else {
// clients are not allowed to publish to the channel
DenyChannelPublisher publisher = new DenyChannelPublisher();
pubSubManager.register(path, publisher);
}
String prefix = CONTEXT_PATH.substring(0, CONTEXT_PATH.length() - 1);
monitor.provisionedChannelEndpoint(prefix + path);
}
public void dispose(WebChannelBindingDefinition definition, Channel channel) throws BuilderException {
URI sourceUri = channel.getUri();
String path = UriHelper.getBaseName(sourceUri);
OperationsAllowed allowed = definition.getAllowed();
// remove the subscriber infrastructure
if (OperationsAllowed.SUBSCRIBE == allowed || OperationsAllowed.ALL == allowed) {
pubSubManager.unregisterSubscriber(path);
channel.unsubscribe(sourceUri);
broadcasterManager.remove(path);
} else {
ChannelPublisher publisher = pubSubManager.unregisterPublisher(path);
channel.removeHandler(publisher);
}
// detach publisher and close cluster channel
pubSubManager.unregisterPublisher(path);
String prefix = CONTEXT_PATH.substring(0, CONTEXT_PATH.length() - 1);
monitor.removedChannelEndpoint(prefix + path);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy