All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.atmosphere.websocket.protocol.SimpleHttpProtocol Maven / Gradle / Ivy

There is a newer version: 3.0.13
Show newest version
/*
* Copyright 2008-2024 Async-IO.org
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package org.atmosphere.websocket.protocol;

import org.atmosphere.cpr.ApplicationConfig;
import org.atmosphere.cpr.AtmosphereConfig;
import org.atmosphere.cpr.AtmosphereRequest;
import org.atmosphere.cpr.AtmosphereResourceImpl;
import org.atmosphere.cpr.FrameworkConfig;
import org.atmosphere.websocket.WebSocket;
import org.atmosphere.websocket.WebSocketProcessor;
import org.atmosphere.websocket.WebSocketProtocol;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.Serializable;
import java.net.URI;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import static org.atmosphere.websocket.protocol.ProtocolUtil.constructRequest;

/**
 * Like the {@link org.atmosphere.cpr.AsynchronousProcessor} class, this class is responsible for dispatching WebSocket messages to the
 * proper {@link org.atmosphere.websocket.WebSocket} implementation by wrapping the Websocket message's bytes within
 * an {@link jakarta.servlet.http.HttpServletRequest}.
 * 

* The content-type is defined using {@link org.atmosphere.cpr.ApplicationConfig#WEBSOCKET_CONTENT_TYPE} property * The method is defined using {@link org.atmosphere.cpr.ApplicationConfig#WEBSOCKET_METHOD} property *

* * @author Jeanfrancois Arcand */ public class SimpleHttpProtocol implements WebSocketProtocol, Serializable { private static final long serialVersionUID = 7526472295622776111L; private static final Logger logger = LoggerFactory.getLogger(SimpleHttpProtocol.class); protected final static String TEXT = "text/plain"; protected String contentType = TEXT; protected String methodType = "POST"; protected String delimiter = "@@"; protected boolean destroyable; protected boolean rewriteUri; @Override public void configure(AtmosphereConfig config) { String contentType = config.getInitParameter(ApplicationConfig.WEBSOCKET_CONTENT_TYPE); if (contentType == null) { contentType = "text/plain"; } this.contentType = contentType; String methodType = config.getInitParameter(ApplicationConfig.WEBSOCKET_METHOD); if (methodType == null) { methodType = "POST"; } this.methodType = methodType; String delimiter = config.getInitParameter(ApplicationConfig.WEBSOCKET_PATH_DELIMITER); if (delimiter == null) { delimiter = "@@"; } this.delimiter = delimiter; String s = config.getInitParameter(ApplicationConfig.RECYCLE_ATMOSPHERE_REQUEST_RESPONSE); destroyable = Boolean.parseBoolean(s); rewriteUri = Boolean.parseBoolean(config.getInitParameter(ApplicationConfig.REWRITE_WEBSOCKET_REQUESTURI, "true")); } @Override public List onMessage(WebSocket webSocket, String message) { AtmosphereResourceImpl resource = (AtmosphereResourceImpl) webSocket.resource(); if (resource == null) { logger.trace("The WebSocket has been closed before the message was processed."); return null; } AtmosphereRequest request = resource.getRequest(false); request.setAttribute(FrameworkConfig.WEBSOCKET_SUBPROTOCOL, FrameworkConfig.SIMPLE_HTTP_OVER_WEBSOCKET); if (!resource.isInScope()) return Collections.emptyList(); String pathInfo = request.getPathInfo(); String requestURI = request.getRequestURI(); // This confuse some JAXRS servers like RestEasy if (rewriteUri && (requestURI.startsWith("http://") || requestURI.startsWith("https://"))) { logger.debug("Rewriting requestURI {}. To disable, add {} set to true as init-param", requestURI, ApplicationConfig.REWRITE_WEBSOCKET_REQUESTURI); requestURI = URI.create(requestURI).getPath(); request.requestURI(requestURI); } if (message.startsWith(delimiter)) { int delimiterLength = delimiter.length(); int bodyBeginIndex = message.indexOf(delimiter, delimiterLength); if (bodyBeginIndex != -1) { pathInfo = message.substring(delimiterLength, bodyBeginIndex); requestURI += pathInfo; message = message.substring(bodyBeginIndex + delimiterLength); } } List list = new ArrayList<>(); list.add(constructRequest(webSocket, pathInfo, requestURI, methodType, contentType.equalsIgnoreCase(TEXT) ? null : contentType, destroyable).body(message).build()); return list; } @Override public List onMessage(WebSocket webSocket, byte[] d, final int offset, final int length) { //Converting to a string and delegating to onMessage(WebSocket webSocket, String d) causes issues because the binary data may not be a valid string. AtmosphereResourceImpl resource = (AtmosphereResourceImpl) webSocket.resource(); if (resource == null) { logger.trace("The WebSocket has been closed before the message was processed."); return null; } AtmosphereRequest request = resource.getRequest(false); request.setAttribute(FrameworkConfig.WEBSOCKET_SUBPROTOCOL, FrameworkConfig.SIMPLE_HTTP_OVER_WEBSOCKET); if (!resource.isInScope()) return Collections.emptyList(); List list = new ArrayList<>(); list.add(constructRequest(webSocket, request.getPathInfo(), request.getRequestURI(), methodType, contentType.equalsIgnoreCase(TEXT) ? null : contentType, destroyable).body(d, offset, length).build()); return list; } @Override public void onOpen(WebSocket webSocket) { } @Override public void onClose(WebSocket webSocket) { } @Override public void onError(WebSocket webSocket, WebSocketProcessor.WebSocketException t) { logger.warn(t.getMessage() + ". Unable to deliver the websocket messages to installed component." + " Status {} Message {}", t.response().getStatus(), t.response().getStatusMessage()); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy