001/*
002 * Copyright 2002-2016 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.web.socket.handler;
018
019import java.io.IOException;
020
021import org.springframework.web.socket.BinaryMessage;
022import org.springframework.web.socket.CloseStatus;
023import org.springframework.web.socket.WebSocketHandler;
024import org.springframework.web.socket.WebSocketSession;
025
026/**
027 * A convenient base class for {@link WebSocketHandler} implementations
028 * that process text messages only.
029 *
030 * <p>Binary messages are rejected with {@link CloseStatus#NOT_ACCEPTABLE}.
031 * All other methods have empty implementations.
032 *
033 * @author Rossen Stoyanchev
034 * @author Phillip Webb
035 * @since 4.0
036 */
037public class TextWebSocketHandler extends AbstractWebSocketHandler {
038
039        @Override
040        protected void handleBinaryMessage(WebSocketSession session, BinaryMessage message) {
041                try {
042                        session.close(CloseStatus.NOT_ACCEPTABLE.withReason("Binary messages not supported"));
043                }
044                catch (IOException ex) {
045                        // ignore
046                }
047        }
048
049}