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.xml;
014
015import org.apache.juneau.*;
016import org.apache.juneau.collections.*;
017import org.apache.juneau.serializer.*;
018
019/**
020 * Session object that lives for the duration of a single use of {@link XmlDocSerializer}.
021 *
022 * <p>
023 * This class is NOT thread safe.
024 * It is typically discarded after one-time use although it can be reused within the same thread.
025 */
026public class XmlDocSerializerSession extends XmlSerializerSession {
027
028   /**
029    * Create a new session using properties specified in the context.
030    *
031    * @param ctx
032    *    The context creating this session object.
033    *    The context contains all the configuration settings for this object.
034    * @param args
035    *    Runtime arguments.
036    *    These specify session-level information such as locale and URI context.
037    *    It also include session-level properties that override the properties defined on the bean and
038    *    serializer contexts.
039    */
040   protected XmlDocSerializerSession(XmlSerializer ctx, SerializerSessionArgs args) {
041      super(ctx, args);
042   }
043
044   @Override /* SerializerSession */
045   protected void doSerialize(SerializerPipe out, Object o) throws java.io.IOException, SerializeException {
046      try (XmlWriter w = getXmlWriter(out)) {
047         w.append("<?xml")
048            .attr("version", "1.0")
049            .attr("encoding", "UTF-8")
050            .appendln("?>");
051         w.flush();
052         super.doSerialize(out, o);
053      }
054   }
055
056   //-----------------------------------------------------------------------------------------------------------------
057   // Other methods
058   //-----------------------------------------------------------------------------------------------------------------
059
060   @Override /* Session */
061   public OMap toMap() {
062      return super.toMap()
063         .a("XmlDocSerializerSession", new DefaultFilteringOMap()
064         );
065   }
066}