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.spi.DataFormat;
035    
036    /**
037     * A <a href="http://camel.apache.org/data-format.html">data format</a>
038     * ({@link DataFormat}) using XStream to marshal to and from XML
039     *
040     * @version $Revision: 904442 $
041     */
042    public class XStreamDataFormat extends AbstractXStreamWrapper  {
043        String encoding;
044        
045        public XStreamDataFormat() {
046        }
047    
048        public XStreamDataFormat(XStream xstream) {
049            super(xstream);
050        }
051        
052        public void setEncoding(String encoding) {
053            this.encoding = encoding;
054        }
055        
056        public String getEncoding() {
057            return encoding;
058        }
059    
060        /**
061         * A factory method which takes a collection of types to be annotated
062         */
063        public static XStreamDataFormat processAnnotations(Iterable<Class<?>> types) {
064            XStreamDataFormat answer = new XStreamDataFormat();
065            XStream xstream = answer.getXStream();
066            for (Class<?> type : types) {
067                xstream.processAnnotations(type);
068            }
069            return answer;
070        }
071    
072        /**
073         * A factory method which takes a number of types to be annotated
074         */
075        public static XStreamDataFormat processAnnotations(Class<?>... types) {
076            XStreamDataFormat answer = new XStreamDataFormat();
077            XStream xstream = answer.getXStream();
078            for (Class<?> type : types) {
079                xstream.processAnnotations(type);
080            }
081            return answer;
082        }
083        
084        // just make sure the exchange property can override the xmlstream encoding setting
085        protected void updateCharactorEncodingInfo(Exchange exchange) {
086            if (exchange.getProperty(Exchange.CHARSET_NAME) == null && encoding != null) {
087                exchange.setProperty(Exchange.CHARSET_NAME, encoding);
088            }
089        }
090    
091        protected HierarchicalStreamWriter createHierarchicalStreamWriter(Exchange exchange, Object body, OutputStream stream) throws XMLStreamException {
092            updateCharactorEncodingInfo(exchange);
093            XMLStreamWriter xmlWriter = getStaxConverter().createXMLStreamWriter(stream, exchange);
094            return new StaxWriter(new QNameMap(), xmlWriter);
095        }
096    
097        protected HierarchicalStreamReader createHierarchicalStreamReader(Exchange exchange, InputStream stream) throws XMLStreamException {
098            updateCharactorEncodingInfo(exchange);
099            XMLStreamReader xmlReader = getStaxConverter().createXMLStreamReader(stream, exchange);
100            return new StaxReader(new QNameMap(), xmlReader);
101        }
102    }