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.model;
018    
019    import javax.xml.bind.annotation.XmlAccessType;
020    import javax.xml.bind.annotation.XmlAccessorType;
021    import javax.xml.bind.annotation.XmlAttribute;
022    import javax.xml.bind.annotation.XmlElement;
023    import javax.xml.bind.annotation.XmlElements;
024    import javax.xml.bind.annotation.XmlRootElement;
025    
026    import org.apache.camel.Processor;
027    import org.apache.camel.model.dataformat.ArtixDSDataFormat;
028    import org.apache.camel.model.dataformat.CsvDataFormat;
029    import org.apache.camel.model.dataformat.DataFormatDefinition;
030    import org.apache.camel.model.dataformat.FlatpackDataFormat;
031    import org.apache.camel.model.dataformat.HL7DataFormat;
032    import org.apache.camel.model.dataformat.JaxbDataFormat;
033    import org.apache.camel.model.dataformat.RssDataFormat;
034    import org.apache.camel.model.dataformat.SerializationDataFormat;
035    import org.apache.camel.model.dataformat.StringDataFormat;
036    import org.apache.camel.model.dataformat.TidyMarkupDataFormat;
037    import org.apache.camel.model.dataformat.XMLBeansDataFormat;
038    import org.apache.camel.model.dataformat.XMLSecurityDataFormat;
039    import org.apache.camel.model.dataformat.XStreamDataFormat;
040    import org.apache.camel.model.dataformat.ZipDataFormat;
041    import org.apache.camel.processor.UnmarshalProcessor;
042    import org.apache.camel.spi.DataFormat;
043    import org.apache.camel.spi.RouteContext;
044    
045    /**
046     * Unmarshals the binary payload using the given {@link DataFormatDefinition}
047     *
048     * @version $Revision: 750806 $
049     */
050    @XmlRootElement(name = "unmarshal")
051    @XmlAccessorType(XmlAccessType.FIELD)
052    public class UnmarshalDefinition extends OutputDefinition<ProcessorDefinition> {
053        @XmlAttribute(required = false)
054        private String ref;
055        // TODO cannot use @XmlElementRef as it doesn't allow optional properties
056        // @XmlElementRef
057        @XmlElements({
058        @XmlElement(required = false, name = "artixDS", type = ArtixDSDataFormat.class),
059        @XmlElement(required = false, name = "csv", type = CsvDataFormat.class),
060        @XmlElement(required = false, name = "flatpack", type = FlatpackDataFormat.class),
061        @XmlElement(required = false, name = "hl7", type = HL7DataFormat.class),
062        @XmlElement(required = false, name = "jaxb", type = JaxbDataFormat.class),
063        @XmlElement(required = false, name = "rss", type = RssDataFormat.class),
064        @XmlElement(required = false, name = "secureXML", type = XMLSecurityDataFormat.class),
065        @XmlElement(required = false, name = "serialization", type = SerializationDataFormat.class),
066        @XmlElement(required = false, name = "string", type = StringDataFormat.class),
067        @XmlElement(required = false, name = "tidyMarkup", type = TidyMarkupDataFormat.class),    
068        @XmlElement(required = false, name = "xmlBeans", type = XMLBeansDataFormat.class),
069        @XmlElement(required = false, name = "xstream", type = XStreamDataFormat.class),
070        @XmlElement(required = false, name = "zip", type = ZipDataFormat.class)}
071        )
072        private DataFormatDefinition dataFormatType;
073    
074        public UnmarshalDefinition() {
075        }
076    
077        public UnmarshalDefinition(DataFormatDefinition dataFormatType) {
078            this.dataFormatType = dataFormatType;
079        }
080    
081        public UnmarshalDefinition(String ref) {
082            this.ref = ref;
083        }
084    
085        @Override
086        public String toString() {
087            if (dataFormatType != null) {
088                return "Marshal[" + dataFormatType + "]";
089            } else {
090                return "Marshal[ref: " + ref + "]";
091            }
092        }
093    
094        @Override
095        public String getShortName() {
096            return "unmarshal";
097        }
098    
099        public String getRef() {
100            return ref;
101        }
102    
103        public void setRef(String ref) {
104            this.ref = ref;
105        }
106    
107        public DataFormatDefinition getDataFormatType() {
108            return dataFormatType;
109        }
110    
111        public void setDataFormatType(DataFormatDefinition dataFormatType) {
112            this.dataFormatType = dataFormatType;
113        }
114    
115        @Override
116        public Processor createProcessor(RouteContext routeContext) {
117            DataFormat dataFormat = DataFormatDefinition.getDataFormat(routeContext, getDataFormatType(), ref);
118            return new UnmarshalProcessor(dataFormat);
119        }
120    }