org.springframework.web.reactive.socket.WebSocketMessage.java Source code

Introduction

Here is the source code for org.springframework.web.reactive.socket.WebSocketMessage.java

Source

/*
 * Copyright 2002-2018 the original author or authors.
 *
 * 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
 *
 *      https://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.springframework.web.reactive.socket;

import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;

import org.springframework.core.io.buffer.DataBuffer;
import org.springframework.core.io.buffer.DataBufferUtils;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.ObjectUtils;

/**
 * Representation of a WebSocket message.
 * <p>See static factory methods in {@link WebSocketSession} for creating messages
 * with the {@link org.springframework.core.io.buffer.DataBufferFactory
 * DataBufferFactory} for the session.
 *
 * @author Rossen Stoyanchev
 * @since 5.0
 */
public class WebSocketMessage {

    private final Type type;

    private final DataBuffer payload;

    /**
     * Constructor for a WebSocketMessage.
     * <p>See static factory methods in {@link WebSocketSession} or alternatively
     * use {@link WebSocketSession#bufferFactory()} to create the payload and
     * then invoke this constructor.
     */
    public WebSocketMessage(Type type, DataBuffer payload) {
        Assert.notNull(type, "'type' must not be null");
        Assert.notNull(payload, "'payload' must not be null");
        this.type = type;
        this.payload = payload;
    }

    /**
     * Return the message type (text, binary, etc).
     */
    public Type getType() {
        return this.type;
    }

    /**
     * Return the message payload.
     */
    public DataBuffer getPayload() {
        return this.payload;
    }

    /**
     * A variant of {@link #getPayloadAsText(Charset)} that uses {@code UTF-8}
     * for decoding the raw content to text.
     */
    public String getPayloadAsText() {
        return getPayloadAsText(StandardCharsets.UTF_8);
    }

    /**
     * A shortcut for decoding the raw content of the message to text with the
     * given character encoding. This is useful for text WebSocket messages, or
     * otherwise when the payload is expected to contain text.
     * @param charset the character encoding
     * @since 5.0.5
     */
    public String getPayloadAsText(Charset charset) {
        byte[] bytes = new byte[this.payload.readableByteCount()];
        this.payload.read(bytes);
        return new String(bytes, charset);
    }

    /**
     * Retain the data buffer for the message payload, which is useful on
     * runtimes (e.g. Netty) with pooled buffers. A shortcut for:
     * <pre>
     * DataBuffer payload = message.getPayload();
     * DataBufferUtils.retain(payload);
     * </pre>
     * @see DataBufferUtils#retain(DataBuffer)
     */
    public WebSocketMessage retain() {
        DataBufferUtils.retain(this.payload);
        return this;
    }

    /**
     * Release the payload {@code DataBuffer} which is useful on runtimes
     * (e.g. Netty) with pooled buffers such as Netty. A shortcut for:
     * <pre>
     * DataBuffer payload = message.getPayload();
     * DataBufferUtils.release(payload);
     * </pre>
     * @see DataBufferUtils#release(DataBuffer)
     */
    public void release() {
        DataBufferUtils.release(this.payload);
    }

    @Override
    public boolean equals(@Nullable Object other) {
        if (this == other) {
            return true;
        }
        if (!(other instanceof WebSocketMessage)) {
            return false;
        }
        WebSocketMessage otherMessage = (WebSocketMessage) other;
        return (this.type.equals(otherMessage.type)
                && ObjectUtils.nullSafeEquals(this.payload, otherMessage.payload));
    }

    @Override
    public int hashCode() {
        return this.type.hashCode() * 29 + this.payload.hashCode();
    }

    @Override
    public String toString() {
        return "WebSocket " + this.type.name() + " message (" + this.payload.readableByteCount() + " bytes)";
    }

    /**
     * WebSocket message types.
     */
    public enum Type {
        /**
         * Text WebSocket message.
         */
        TEXT,
        /**
         * Binary WebSocket message.
         */
        BINARY,
        /**
         * WebSocket ping.
         */
        PING,
        /**
         * WebSocket pong.
         */
        PONG;
    }

}