/*
 * Copyright 2002-2019 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.http.codec;

import org.springframework.core.codec.Decoder;
import org.springframework.core.codec.Encoder;

Extension of CodecConfigurer for HTTP message reader and writer options relevant on the client side. 
HTTP message readers for the following are 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

HTTP message writers 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

Author:
Rossen Stoyanchev
Since:
5.0/**
 * Extension of {@link CodecConfigurer} for HTTP message reader and writer
 * options relevant on the client 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&lt;String,String&gt;} for form data
 * <li>JSON and Smile, if Jackson is present
 * <li>XML, if JAXB2 is present
 * <li>Server-Sent Events
 * </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&lt;String,String&gt;} for form data
 * <li>{@link org.springframework.util.MultiValueMap
 * MultiValueMap&lt;String,Object&gt;} for multipart data
 * <li>JSON and Smile, if Jackson is present
 * <li>XML, if JAXB2 is present
 * </ul>
 *
 * @author Rossen Stoyanchev
 * @since 5.0
 */
public interface ClientCodecConfigurer extends CodecConfigurer {

	
{@inheritDoc}
On the client side, built-in default also include customizations related
to multipart readers and writers, as well as the decoder for SSE.
/**
	 * {@inheritDoc}
	 * <p>On the client side, built-in default also include customizations related
	 * to multipart readers and writers, as well as the decoder for SSE.
	 */
	@Override
	ClientDefaultCodecs defaultCodecs();

	
{@inheritDoc}.
/**
	 * {@inheritDoc}.
	 */
	@Override
	ClientCodecConfigurer clone();


	
Static factory method for a ClientCodecConfigurer. /**
	 * Static factory method for a {@code ClientCodecConfigurer}.
	 */
	static ClientCodecConfigurer create() {
		return CodecConfigurerFactory.create(ClientCodecConfigurer.class);
	}


	
DefaultCodecs extension with extra client-side options. /**
	 * {@link CodecConfigurer.DefaultCodecs} extension with extra client-side options.
	 */
	interface ClientDefaultCodecs extends DefaultCodecs {

		
Configure encoders or writers for use with 
MultipartHttpMessageWriter. /**
		 * Configure encoders or writers for use with
		 * {@link org.springframework.http.codec.multipart.MultipartHttpMessageWriter
		 * MultipartHttpMessageWriter}.
		 */
		MultipartCodecs multipartCodecs();

		
Configure the Decoder to use for Server-Sent Events. 
By default if this is not set, and Jackson is available, the DefaultCodecs.jackson2JsonDecoder override is used instead. Use this property if you want to further customize the SSE decoder. 
Note that DefaultCodecs.maxInMemorySize(int), if configured, will be applied to the given decoder. 
Params:
decoder – the decoder to use/**
		 * Configure the {@code Decoder} to use for Server-Sent Events.
		 * <p>By default if this is not set, and Jackson is available, the
		 * {@link #jackson2JsonDecoder} override is used instead. Use this property
		 * if you want to further customize the SSE decoder.
		 * <p>Note that {@link #maxInMemorySize(int)}, if configured, will be
		 * applied to the given decoder.
		 * @param decoder the decoder to use
		 */
		void serverSentEventDecoder(Decoder<?> decoder);
	}


	
Registry and container for multipart HTTP message writers.
/**
	 * Registry and container for multipart HTTP message writers.
	 */
	interface MultipartCodecs {

		
Add a Part Encoder, internally wrapped with EncoderHttpMessageWriter. 
Params:
encoder – the encoder to add/**
		 * Add a Part {@code Encoder}, internally wrapped with
		 * {@link EncoderHttpMessageWriter}.
		 * @param encoder the encoder to add
		 */
		MultipartCodecs encoder(Encoder<?> encoder);

		
Add a Part HttpMessageWriter. For writers of type EncoderHttpMessageWriter consider using the shortcut encoder(Encoder<?>) instead. 
Params:
writer – the writer to add/**
		 * Add a Part {@link HttpMessageWriter}. For writers of type
		 * {@link EncoderHttpMessageWriter} consider using the shortcut
		 * {@link #encoder(Encoder)} instead.
		 * @param writer the writer to add
		 */
		MultipartCodecs writer(HttpMessageWriter<?> writer);
	}

}