001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.marshall.httppart;
018
019import org.apache.juneau.commons.httppart.*;
020import org.apache.juneau.marshall.serializer.*;
021
022/**
023 * Session object that lives for the duration of a single use of {@link HttpPartSerializer}.
024 *
025 * <h5 class='section'>Notes:</h5><ul>
026 *    <li class='warn'>This class is not thread safe and is typically discarded after one use.
027 * </ul>
028 *
029 * <h5 class='section'>See Also:</h5><ul>
030 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/HttpPartSerializersParsers">HTTP Part Serializers and Parsers</a>
031 * </ul>
032 */
033public interface HttpPartSerializerSession {
034
035   /**
036    * Converts the specified value to a string that can be used as an HTTP header value, query parameter value,
037    * form-data parameter, or URI path variable.
038    *
039    * <p>
040    * Returned values should NOT be URL-encoded.
041    *
042    * @param type The category of value being serialized.
043    * @param schema
044    *    Schema information about the part.
045    *    <br>May be <jk>null</jk>.
046    *    <br>Not all part serializers use the schema information.
047    * @param value The value being serialized.
048    * @return The serialized value.
049    * @throws SerializeException If a problem occurred while trying to parse the input.
050    * @throws SchemaValidationException If the output fails schema validation.
051    */
052   String write(HttpPartType type, HttpPartSchema schema, Object value) throws SerializeException, SchemaValidationException;
053}