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