/*
* 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
*
* 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.springframework.http.codec;
import org.springframework.core.codec.Encoder;
Extension of CodecConfigurer
for HTTP message reader and writer options relevant on the server side. HTTP message readers for the following are registered by default:
byte[]
ByteBuffer
DataBuffer
Resource
String
MultiValueMap<String,String>
for form data
MultiValueMap<String,Object>
for multipart data - JSON and Smile, if Jackson is present
- XML, if JAXB2 is present
HTTP message writers registered by default:
byte[]
ByteBuffer
DataBuffer
Resource
String
MultiValueMap<String,String>
for form data - JSON and Smile, if Jackson is present
- XML, if JAXB2 is present
- Server-Sent Events
Author: Rossen Stoyanchev Since: 5.0
/**
* Extension of {@link CodecConfigurer} for HTTP message reader and writer
* options relevant on the server side.
*
* <p>HTTP message readers for the following are registered by default:
* <ul>{@code byte[]}
* <li>{@link java.nio.ByteBuffer}
* <li>{@link org.springframework.core.io.buffer.DataBuffer DataBuffer}
* <li>{@link org.springframework.core.io.Resource Resource}
* <li>{@link String}
* <li>{@link org.springframework.util.MultiValueMap
* MultiValueMap<String,String>} for form data
* <li>{@link org.springframework.util.MultiValueMap
* MultiValueMap<String,Object>} for multipart data
* <li>JSON and Smile, if Jackson is present
* <li>XML, if JAXB2 is present
* </ul>
*
* <p>HTTP message writers registered by default:
* <ul>{@code byte[]}
* <li>{@link java.nio.ByteBuffer}
* <li>{@link org.springframework.core.io.buffer.DataBuffer DataBuffer}
* <li>{@link org.springframework.core.io.Resource Resource}
* <li>{@link String}
* <li>{@link org.springframework.util.MultiValueMap
* MultiValueMap<String,String>} for form data
* <li>JSON and Smile, if Jackson is present
* <li>XML, if JAXB2 is present
* <li>Server-Sent Events
* </ul>
*
* @author Rossen Stoyanchev
* @since 5.0
*/
public interface ServerCodecConfigurer extends CodecConfigurer {
{@inheritDoc}
On the server side, built-in default also include customizations
related to the encoder for SSE.
/**
* {@inheritDoc}
* <p>On the server side, built-in default also include customizations
* related to the encoder for SSE.
*/
@Override
ServerDefaultCodecs defaultCodecs();
Static factory method for a ServerCodecConfigurer
. /**
* Static factory method for a {@code ServerCodecConfigurer}.
*/
static ServerCodecConfigurer create() {
return CodecConfigurerFactory.create(ServerCodecConfigurer.class);
}
DefaultCodecs
extension with extra client-side options. /**
* {@link CodecConfigurer.DefaultCodecs} extension with extra client-side options.
*/
interface ServerDefaultCodecs extends DefaultCodecs {
Configure the Encoder
to use for Server-Sent Events. By default if this is not set, and Jackson is available, the DefaultCodecs.jackson2JsonEncoder
override is used instead. Use this property if you want to further customize the SSE encoder.
/**
* Configure the {@code Encoder} to use for Server-Sent Events.
* <p>By default if this is not set, and Jackson is available, the
* {@link #jackson2JsonEncoder} override is used instead. Use this property
* if you want to further customize the SSE encoder.
*/
void serverSentEventEncoder(Encoder<?> encoder);
}
}