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.xmlschema;
014
015import org.apache.juneau.*;
016import org.apache.juneau.annotation.*;
017import org.apache.juneau.collections.*;
018import org.apache.juneau.serializer.*;
019
020/**
021 * Serializes POJO metadata to HTTP responses as XML.
022 *
023 * <h5 class='topic'>Media types</h5>
024 *
025 * Handles <c>Accept</c> types:  <bc>text/xml+schema</bc>
026 * <p>
027 * Produces <c>Content-Type</c> types:  <bc>text/xml</bc>
028 *
029 * <h5 class='topic'>Description</h5>
030 *
031 * Same as {@link XmlSchemaSerializer}, except prepends <code><xt>&lt;?xml</xt> <xa>version</xa>=<xs>'1.0'</xs>
032 * <xa>encoding</xa>=<xs>'UTF-8'</xs><xt>?&gt;</xt></code> to the response to make it a valid XML document.
033 */
034@ConfigurableContext
035@Deprecated
036public class XmlSchemaDocSerializer extends XmlSchemaSerializer {
037
038   //-------------------------------------------------------------------------------------------------------------------
039   // Configurable properties
040   //-------------------------------------------------------------------------------------------------------------------
041
042   static final String PREFIX = "XmlSchemaDocSerializer";
043
044   //-----------------------------------------------------------------------------------------------------------------
045   // Overridden methods
046   //-----------------------------------------------------------------------------------------------------------------
047
048   /**
049    * Constructor.
050    *
051    * @param ps The property store containing all the settings for this object.
052    */
053   public XmlSchemaDocSerializer(PropertyStore ps) {
054      super(ps);
055   }
056
057   @Override /* Serializer */
058   public XmlSchemaSerializerSession createSession() {
059      return createSession(createDefaultSessionArgs());
060   }
061
062   @Override /* Serializer */
063   public XmlSchemaSerializerSession createSession(SerializerSessionArgs args) {
064      return new XmlSchemaSerializerSession(this, args);
065   }
066
067   //-----------------------------------------------------------------------------------------------------------------
068   // Other methods
069   //-----------------------------------------------------------------------------------------------------------------
070
071   @Override /* Context */
072   public OMap toMap() {
073      return super.toMap()
074         .a("XmlSchemaDocSerializer", new DefaultFilteringOMap()
075         );
076   }
077}