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 * Serializes POJOs to HTTP responses as XML.
021 *
022 * <h5 class='topic'>Media types</h5>
023 *
024 * Handles <c>Accept</c> types:  <bc>text/xml</bc>
025 * <p>
026 * Produces <c>Content-Type</c> types:  <bc>text/xml</bc>
027 *
028 * <h5 class='topic'>Description</h5>
029 *
030 * Same as {@link XmlSerializer}, except prepends <code><xt>&lt;?xml</xt> <xa>version</xa>=<xs>'1.0'</xs>
031 * <xa>encoding</xa>=<xs>'UTF-8'</xs><xt>?&gt;</xt></code> to the response to make it a valid XML document.
032 *
033 */
034public class XmlDocSerializer extends XmlSerializer {
035
036   //-------------------------------------------------------------------------------------------------------------------
037   // Predefined subclasses
038   //-------------------------------------------------------------------------------------------------------------------
039
040   /** Default serializer without namespaces. */
041   public static class Ns extends XmlDocSerializer {
042
043      /**
044       * Constructor.
045       *
046       * @param ps The property store containing all the settings for this object.
047       */
048      public Ns(PropertyStore ps) {
049         super(ps.builder().setDefault(XML_enableNamespaces, true).build());
050      }
051   }
052
053   //-------------------------------------------------------------------------------------------------------------------
054   // Instance
055   //-------------------------------------------------------------------------------------------------------------------
056
057   /**
058    * Constructor.
059    *
060    * @param ps The property store containing all the settings for this object.
061    */
062   public XmlDocSerializer(PropertyStore ps) {
063      super(ps);
064   }
065
066   @Override /* Serializer */
067   public XmlDocSerializerSession createSession() {
068      return createSession(createDefaultSessionArgs());
069   }
070
071   @Override /* Serializer */
072   public XmlDocSerializerSession createSession(SerializerSessionArgs args) {
073      return new XmlDocSerializerSession(this, args);
074   }
075
076   //-----------------------------------------------------------------------------------------------------------------
077   // Other methods
078   //-----------------------------------------------------------------------------------------------------------------
079
080   @Override /* Context */
081   public OMap toMap() {
082      return super.toMap()
083         .a("XmlDocSerializer", new DefaultFilteringOMap()
084         );
085   }
086}