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