001 /**
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 * http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017 package org.apache.camel.dataformat.xstream;
018
019 import java.io.InputStream;
020 import java.io.OutputStream;
021
022 import javax.xml.stream.XMLStreamException;
023 import javax.xml.stream.XMLStreamReader;
024 import javax.xml.stream.XMLStreamWriter;
025
026 import com.thoughtworks.xstream.XStream;
027 import com.thoughtworks.xstream.io.HierarchicalStreamReader;
028 import com.thoughtworks.xstream.io.HierarchicalStreamWriter;
029 import com.thoughtworks.xstream.io.xml.QNameMap;
030 import com.thoughtworks.xstream.io.xml.StaxReader;
031 import com.thoughtworks.xstream.io.xml.StaxWriter;
032
033 import org.apache.camel.Exchange;
034 import org.apache.camel.converter.IOConverter;
035 import org.apache.camel.spi.ClassResolver;
036 import org.apache.camel.spi.DataFormat;
037
038 /**
039 * A <a href="http://camel.apache.org/data-format.html">data format</a>
040 * ({@link DataFormat}) using XStream to marshal to and from XML
041 *
042 * @version
043 */
044 public class XStreamDataFormat extends AbstractXStreamWrapper {
045 String encoding;
046
047 public XStreamDataFormat() {
048 }
049
050 public XStreamDataFormat(XStream xstream) {
051 super(xstream);
052 }
053
054 public void setEncoding(String encoding) {
055 this.encoding = encoding;
056 }
057
058 public String getEncoding() {
059 return encoding;
060 }
061
062 /**
063 * A factory method which takes a collection of types to be annotated
064 */
065 public static XStreamDataFormat processAnnotations(ClassResolver resolver, Iterable<Class<?>> types) {
066 XStreamDataFormat answer = new XStreamDataFormat();
067 XStream xstream = answer.getXStream(resolver);
068 for (Class<?> type : types) {
069 xstream.processAnnotations(type);
070 }
071 return answer;
072 }
073
074 /**
075 * A factory method which takes a number of types to be annotated
076 */
077 public static XStreamDataFormat processAnnotations(ClassResolver resolver, Class<?>... types) {
078 XStreamDataFormat answer = new XStreamDataFormat();
079 XStream xstream = answer.getXStream(resolver);
080 for (Class<?> type : types) {
081 xstream.processAnnotations(type);
082 }
083 return answer;
084 }
085
086 // just make sure the exchange property can override the xmlstream encoding setting
087 protected void updateCharactorEncodingInfo(Exchange exchange) {
088 if (exchange.getProperty(Exchange.CHARSET_NAME) == null && encoding != null) {
089 exchange.setProperty(Exchange.CHARSET_NAME, IOConverter.normalizeCharset(encoding));
090 }
091 }
092
093 protected HierarchicalStreamWriter createHierarchicalStreamWriter(Exchange exchange, Object body, OutputStream stream) throws XMLStreamException {
094 updateCharactorEncodingInfo(exchange);
095 if (getXstreamDriver() != null) {
096 return getXstreamDriver().createWriter(stream);
097 }
098 XMLStreamWriter xmlWriter = getStaxConverter().createXMLStreamWriter(stream, exchange);
099 return new StaxWriter(new QNameMap(), xmlWriter);
100 }
101
102 protected HierarchicalStreamReader createHierarchicalStreamReader(Exchange exchange, InputStream stream) throws XMLStreamException {
103 updateCharactorEncodingInfo(exchange);
104 if (getXstreamDriver() != null) {
105 return getXstreamDriver().createReader(stream);
106 }
107 XMLStreamReader xmlReader = getStaxConverter().createXMLStreamReader(stream, exchange);
108 return new StaxReader(new QNameMap(), xmlReader);
109 }
110 }