org.jooby.internal.WebSocketImpl Maven / Gradle / Ivy
/**
* Apache License
* Version 2.0, January 2004
* http://www.apache.org/licenses/
*
* TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
*
* 1. Definitions.
*
* "License" shall mean the terms and conditions for use, reproduction,
* and distribution as defined by Sections 1 through 9 of this document.
*
* "Licensor" shall mean the copyright owner or entity authorized by
* the copyright owner that is granting the License.
*
* "Legal Entity" shall mean the union of the acting entity and all
* other entities that control, are controlled by, or are under common
* control with that entity. For the purposes of this definition,
* "control" means (i) the power, direct or indirect, to cause the
* direction or management of such entity, whether by contract or
* otherwise, or (ii) ownership of fifty percent (50%) or more of the
* outstanding shares, or (iii) beneficial ownership of such entity.
*
* "You" (or "Your") shall mean an individual or Legal Entity
* exercising permissions granted by this License.
*
* "Source" form shall mean the preferred form for making modifications,
* including but not limited to software source code, documentation
* source, and configuration files.
*
* "Object" form shall mean any form resulting from mechanical
* transformation or translation of a Source form, including but
* not limited to compiled object code, generated documentation,
* and conversions to other media types.
*
* "Work" shall mean the work of authorship, whether in Source or
* Object form, made available under the License, as indicated by a
* copyright notice that is included in or attached to the work
* (an example is provided in the Appendix below).
*
* "Derivative Works" shall mean any work, whether in Source or Object
* form, that is based on (or derived from) the Work and for which the
* editorial revisions, annotations, elaborations, or other modifications
* represent, as a whole, an original work of authorship. For the purposes
* of this License, Derivative Works shall not include works that remain
* separable from, or merely link (or bind by name) to the interfaces of,
* the Work and Derivative Works thereof.
*
* "Contribution" shall mean any work of authorship, including
* the original version of the Work and any modifications or additions
* to that Work or Derivative Works thereof, that is intentionally
* submitted to Licensor for inclusion in the Work by the copyright owner
* or by an individual or Legal Entity authorized to submit on behalf of
* the copyright owner. For the purposes of this definition, "submitted"
* means any form of electronic, verbal, or written communication sent
* to the Licensor or its representatives, including but not limited to
* communication on electronic mailing lists, source code control systems,
* and issue tracking systems that are managed by, or on behalf of, the
* Licensor for the purpose of discussing and improving the Work, but
* excluding communication that is conspicuously marked or otherwise
* designated in writing by the copyright owner as "Not a Contribution."
*
* "Contributor" shall mean Licensor and any individual or Legal Entity
* on behalf of whom a Contribution has been received by Licensor and
* subsequently incorporated within the Work.
*
* 2. Grant of Copyright License. Subject to the terms and conditions of
* this License, each Contributor hereby grants to You a perpetual,
* worldwide, non-exclusive, no-charge, royalty-free, irrevocable
* copyright license to reproduce, prepare Derivative Works of,
* publicly display, publicly perform, sublicense, and distribute the
* Work and such Derivative Works in Source or Object form.
*
* 3. Grant of Patent License. Subject to the terms and conditions of
* this License, each Contributor hereby grants to You a perpetual,
* worldwide, non-exclusive, no-charge, royalty-free, irrevocable
* (except as stated in this section) patent license to make, have made,
* use, offer to sell, sell, import, and otherwise transfer the Work,
* where such license applies only to those patent claims licensable
* by such Contributor that are necessarily infringed by their
* Contribution(s) alone or by combination of their Contribution(s)
* with the Work to which such Contribution(s) was submitted. If You
* institute patent litigation against any entity (including a
* cross-claim or counterclaim in a lawsuit) alleging that the Work
* or a Contribution incorporated within the Work constitutes direct
* or contributory patent infringement, then any patent licenses
* granted to You under this License for that Work shall terminate
* as of the date such litigation is filed.
*
* 4. Redistribution. You may reproduce and distribute copies of the
* Work or Derivative Works thereof in any medium, with or without
* modifications, and in Source or Object form, provided that You
* meet the following conditions:
*
* (a) You must give any other recipients of the Work or
* Derivative Works a copy of this License; and
*
* (b) You must cause any modified files to carry prominent notices
* stating that You changed the files; and
*
* (c) You must retain, in the Source form of any Derivative Works
* that You distribute, all copyright, patent, trademark, and
* attribution notices from the Source form of the Work,
* excluding those notices that do not pertain to any part of
* the Derivative Works; and
*
* (d) If the Work includes a "NOTICE" text file as part of its
* distribution, then any Derivative Works that You distribute must
* include a readable copy of the attribution notices contained
* within such NOTICE file, excluding those notices that do not
* pertain to any part of the Derivative Works, in at least one
* of the following places: within a NOTICE text file distributed
* as part of the Derivative Works; within the Source form or
* documentation, if provided along with the Derivative Works; or,
* within a display generated by the Derivative Works, if and
* wherever such third-party notices normally appear. The contents
* of the NOTICE file are for informational purposes only and
* do not modify the License. You may add Your own attribution
* notices within Derivative Works that You distribute, alongside
* or as an addendum to the NOTICE text from the Work, provided
* that such additional attribution notices cannot be construed
* as modifying the License.
*
* You may add Your own copyright statement to Your modifications and
* may provide additional or different license terms and conditions
* for use, reproduction, or distribution of Your modifications, or
* for any such Derivative Works as a whole, provided Your use,
* reproduction, and distribution of the Work otherwise complies with
* the conditions stated in this License.
*
* 5. Submission of Contributions. Unless You explicitly state otherwise,
* any Contribution intentionally submitted for inclusion in the Work
* by You to the Licensor shall be under the terms and conditions of
* this License, without any additional terms or conditions.
* Notwithstanding the above, nothing herein shall supersede or modify
* the terms of any separate license agreement you may have executed
* with Licensor regarding such Contributions.
*
* 6. Trademarks. This License does not grant permission to use the trade
* names, trademarks, service marks, or product names of the Licensor,
* except as required for reasonable and customary use in describing the
* origin of the Work and reproducing the content of the NOTICE file.
*
* 7. Disclaimer of Warranty. Unless required by applicable law or
* agreed to in writing, Licensor provides the Work (and each
* Contributor provides its Contributions) on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
* implied, including, without limitation, any warranties or conditions
* of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
* PARTICULAR PURPOSE. You are solely responsible for determining the
* appropriateness of using or redistributing the Work and assume any
* risks associated with Your exercise of permissions under this License.
*
* 8. Limitation of Liability. In no event and under no legal theory,
* whether in tort (including negligence), contract, or otherwise,
* unless required by applicable law (such as deliberate and grossly
* negligent acts) or agreed to in writing, shall any Contributor be
* liable to You for damages, including any direct, indirect, special,
* incidental, or consequential damages of any character arising as a
* result of this License or out of the use or inability to use the
* Work (including but not limited to damages for loss of goodwill,
* work stoppage, computer failure or malfunction, or any and all
* other commercial damages or losses), even if such Contributor
* has been advised of the possibility of such damages.
*
* 9. Accepting Warranty or Additional Liability. While redistributing
* the Work or Derivative Works thereof, You may choose to offer,
* and charge a fee for, acceptance of support, warranty, indemnity,
* or other liability obligations and/or rights consistent with this
* License. However, in accepting such obligations, You may act only
* on Your own behalf and on Your sole responsibility, not on behalf
* of any other Contributor, and only if You agree to indemnify,
* defend, and hold each Contributor harmless for any liability
* incurred by, or claims asserted against, such Contributor by reason
* of your accepting any such warranty or additional liability.
*
* END OF TERMS AND CONDITIONS
*
* APPENDIX: How to apply the Apache License to your work.
*
* To apply the Apache License to your work, attach the following
* boilerplate notice, with the fields enclosed by brackets "{}"
* replaced with your own identifying information. (Don't include
* the brackets!) The text should be enclosed in the appropriate
* comment syntax for the file format. We also recommend that a
* file or class name and description of purpose be included on the
* same "printed page" as the copyright notice for easier
* identification within third-party archives.
*
* Copyright 2014 Edgar Espina
*
* 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.jooby.internal;
import static java.util.Objects.requireNonNull;
import java.nio.channels.ClosedChannelException;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.Queue;
import java.util.concurrent.ConcurrentLinkedQueue;
import org.jooby.Err;
import org.jooby.MediaType;
import org.jooby.Mutant;
import org.jooby.Renderer;
import org.jooby.Request;
import org.jooby.WebSocket;
import org.jooby.internal.parser.ParserExecutor;
import org.jooby.spi.NativeWebSocket;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.google.common.collect.ImmutableList;
import com.google.inject.Injector;
import com.google.inject.Key;
import javaslang.control.Try;
import javaslang.control.Try.CheckedRunnable;
@SuppressWarnings("unchecked")
public class WebSocketImpl implements WebSocket {
@SuppressWarnings({"rawtypes" })
private static final OnMessage NOOP = arg -> {
};
private static final OnClose CLOSE_NOOP = arg -> {
};
/** The logging system. */
private final Logger log = LoggerFactory.getLogger(WebSocket.class);
/** All connected websocket. */
private static final Queue sessions = new ConcurrentLinkedQueue<>();
private Locale locale;
private String path;
private String pattern;
private Map vars;
private MediaType consumes;
private MediaType produces;
private OnOpen handler;
private OnMessage messageCallback = NOOP;
private OnClose closeCallback = CLOSE_NOOP;
private OnError exceptionCallback = cause -> {
log.error("execution of WS" + path() + " resulted in exception", cause);
};
private NativeWebSocket ws;
private Injector injector;
private boolean suspended;
private List renderers;
private volatile boolean open;
public WebSocketImpl(final OnOpen handler, final String path,
final String pattern, final Map vars,
final MediaType consumes, final MediaType produces) {
this.handler = handler;
this.path = path;
this.pattern = pattern;
this.vars = vars;
this.consumes = consumes;
this.produces = produces;
}
@Override
public void close(final CloseStatus status) {
sessions.remove(this);
synchronized (this) {
open = false;
ws.close(status.code(), status.reason());
}
}
@Override
public void resume() {
sessions.add(this);
synchronized (this) {
if (suspended) {
ws.resume();
suspended = false;
}
}
}
@Override
public void pause() {
sessions.remove(this);
synchronized (this) {
if (!suspended) {
ws.pause();
suspended = true;
}
}
}
@Override
public void terminate() throws Exception {
sessions.remove(this);
synchronized (this) {
open = false;
ws.terminate();
}
}
@Override
public boolean isOpen() {
return open && ws.isOpen();
}
@Override
public void broadcast(final Object data, final SuccessCallback success, final OnError err)
throws Exception {
for (WebSocket ws : sessions) {
try {
ws.send(data, success, err);
} catch (Exception ex) {
err.onError(ex);
}
}
}
@Override
public void send(final Object data, final SuccessCallback success, final OnError err)
throws Exception {
requireNonNull(data, "Message required.");
requireNonNull(success, "Success callback required.");
requireNonNull(err, "Error callback required.");
synchronized (this) {
if (isOpen()) {
new WebSocketRendererContext(
renderers,
ws,
produces,
StandardCharsets.UTF_8,
locale,
success,
err).render(data);
} else {
throw new Err(WebSocket.NORMAL, "WebSocket is closed.");
}
}
}
@Override
public void onMessage(final OnMessage callback) throws Exception {
this.messageCallback = requireNonNull(callback, "Message callback required.");
}
public void connect(final Injector injector, final Request req, final NativeWebSocket ws) {
this.open = true;
this.injector = requireNonNull(injector, "Injector required.");
this.ws = requireNonNull(ws, "WebSocket is required.");
this.locale = req.locale();
renderers = ImmutableList.copyOf(injector.getInstance(Renderer.KEY));
/**
* Bind callbacks
*/
ws.onBinaryMessage(buffer -> Try
.run(sync(() -> messageCallback.onMessage(new WsBinaryMessage(buffer))))
.onFailure(this::handleErr));
ws.onTextMessage(message -> Try
.run(sync(() -> messageCallback.onMessage(
new MutantImpl(injector.getInstance(ParserExecutor.class), consumes,
new StrParamReferenceImpl("body", "message", ImmutableList.of(message))))))
.onFailure(this::handleErr));
ws.onCloseMessage((code, reason) -> {
sessions.remove(this);
Try.run(sync(() -> {
this.open = false;
if (closeCallback != null) {
closeCallback.onClose(reason.map(r -> WebSocket.CloseStatus.of(code, r))
.orElse(WebSocket.CloseStatus.of(code)));
}
closeCallback = null;
})).onFailure(this::handleErr);
});
ws.onErrorMessage(this::handleErr);
// connect now
try {
sessions.add(this);
handler.onOpen(req, this);
} catch (Throwable ex) {
handleErr(ex);
}
}
@Override
public String path() {
return path;
}
@Override
public String pattern() {
return pattern;
}
@Override
public Map vars() {
return vars;
}
@Override
public MediaType consumes() {
return consumes;
}
@Override
public MediaType produces() {
return produces;
}
@Override
public T require(final Key key) {
return injector.getInstance(key);
}
@Override
public String toString() {
StringBuilder buffer = new StringBuilder();
buffer.append("WS ").append(path()).append("\n");
buffer.append(" pattern: ").append(pattern()).append("\n");
buffer.append(" vars: ").append(vars()).append("\n");
buffer.append(" consumes: ").append(consumes()).append("\n");
buffer.append(" produces: ").append(produces()).append("\n");
return buffer.toString();
}
@Override
public void onError(final WebSocket.OnError callback) {
this.exceptionCallback = requireNonNull(callback, "A callback is required.");
}
@Override
public void onClose(final WebSocket.OnClose callback) throws Exception {
this.closeCallback = requireNonNull(callback, "A callback is required.");
}
private void handleErr(final Throwable cause) {
try {
boolean silent = ConnectionResetByPeer.test(cause) || cause instanceof ClosedChannelException;
if (silent) {
log.debug("execution of WS" + path() + " resulted in exception", cause);
} else {
exceptionCallback.onError(cause);
}
} finally {
cleanup(cause);
}
}
private void cleanup(final Throwable cause) {
open = false;
NativeWebSocket lws = ws;
this.ws = null;
this.injector = null;
this.handler = null;
this.closeCallback = null;
this.exceptionCallback = null;
this.messageCallback = null;
if (lws != null && lws.isOpen()) {
WebSocket.CloseStatus closeStatus = WebSocket.SERVER_ERROR;
if (cause instanceof IllegalArgumentException) {
closeStatus = WebSocket.BAD_DATA;
} else if (cause instanceof NoSuchElementException) {
closeStatus = WebSocket.BAD_DATA;
} else if (cause instanceof Err) {
Err err = (Err) cause;
if (err.statusCode() == 400) {
closeStatus = WebSocket.BAD_DATA;
}
}
lws.close(closeStatus.code(), closeStatus.reason());
}
}
private CheckedRunnable sync(final CheckedRunnable task) {
return () -> {
synchronized (this) {
task.run();
}
};
}
;
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy