001/* 002 * Copyright 2002-2013 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.sockjs.frame; 018 019/** 020 * Applies a transport-specific format to the content of a SockJS frame resulting 021 * in a content that can be written out. Primarily for use in HTTP server-side 022 * transports that push data. 023 * 024 * <p>Formatting may vary from simply appending a new line character for XHR 025 * polling and streaming transports, to a jsonp-style callback function, 026 * surrounding script tags, and more. 027 * 028 * <p>For the various SockJS frame formats in use, see implementations of 029 * {@link org.springframework.web.socket.sockjs.transport.handler.AbstractHttpSendingTransportHandler#getFrameFormat(org.springframework.http.server.ServerHttpRequest) AbstractHttpSendingTransportHandler.getFrameFormat} 030 * 031 * @author Rossen Stoyanchev 032 * @since 4.0 033 */ 034public interface SockJsFrameFormat { 035 036 String format(SockJsFrame frame); 037 038}