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