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