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 */
017package org.apache.camel.model;
018
019import javax.xml.bind.annotation.XmlAccessType;
020import javax.xml.bind.annotation.XmlAccessorType;
021import javax.xml.bind.annotation.XmlAttribute;
022import javax.xml.bind.annotation.XmlElement;
023import javax.xml.bind.annotation.XmlElements;
024import javax.xml.bind.annotation.XmlRootElement;
025
026import org.apache.camel.Processor;
027import org.apache.camel.model.dataformat.AvroDataFormat;
028import org.apache.camel.model.dataformat.Base64DataFormat;
029import org.apache.camel.model.dataformat.BeanioDataFormat;
030import org.apache.camel.model.dataformat.BindyDataFormat;
031import org.apache.camel.model.dataformat.CastorDataFormat;
032import org.apache.camel.model.dataformat.CryptoDataFormat;
033import org.apache.camel.model.dataformat.CsvDataFormat;
034import org.apache.camel.model.dataformat.CustomDataFormat;
035import org.apache.camel.model.dataformat.FlatpackDataFormat;
036import org.apache.camel.model.dataformat.GzipDataFormat;
037import org.apache.camel.model.dataformat.HL7DataFormat;
038import org.apache.camel.model.dataformat.IcalDataFormat;
039import org.apache.camel.model.dataformat.JaxbDataFormat;
040import org.apache.camel.model.dataformat.JibxDataFormat;
041import org.apache.camel.model.dataformat.JsonDataFormat;
042import org.apache.camel.model.dataformat.PGPDataFormat;
043import org.apache.camel.model.dataformat.ProtobufDataFormat;
044import org.apache.camel.model.dataformat.RssDataFormat;
045import org.apache.camel.model.dataformat.SerializationDataFormat;
046import org.apache.camel.model.dataformat.SoapJaxbDataFormat;
047import org.apache.camel.model.dataformat.StringDataFormat;
048import org.apache.camel.model.dataformat.SyslogDataFormat;
049import org.apache.camel.model.dataformat.TidyMarkupDataFormat;
050import org.apache.camel.model.dataformat.UniVocityCsvDataFormat;
051import org.apache.camel.model.dataformat.UniVocityFixedWidthDataFormat;
052import org.apache.camel.model.dataformat.UniVocityTsvDataFormat;
053import org.apache.camel.model.dataformat.XMLBeansDataFormat;
054import org.apache.camel.model.dataformat.XMLSecurityDataFormat;
055import org.apache.camel.model.dataformat.XStreamDataFormat;
056import org.apache.camel.model.dataformat.XmlJsonDataFormat;
057import org.apache.camel.model.dataformat.XmlRpcDataFormat;
058import org.apache.camel.model.dataformat.ZipDataFormat;
059import org.apache.camel.model.dataformat.ZipFileDataFormat;
060import org.apache.camel.processor.UnmarshalProcessor;
061import org.apache.camel.spi.DataFormat;
062import org.apache.camel.spi.Metadata;
063import org.apache.camel.spi.RouteContext;
064
065/**
066 * Converts the message data received from the wire into a format that Apache Camel processors can consume
067 *
068 * @version 
069 */
070@Metadata(label = "eip,transformation")
071@XmlRootElement(name = "unmarshal")
072@XmlAccessorType(XmlAccessType.FIELD)
073public class UnmarshalDefinition extends NoOutputDefinition<UnmarshalDefinition> {
074
075    // TODO: Camel 3.0, ref attribute should be removed as UnmarshalDataFormat is to be used instead
076
077    // cannot use @XmlElementRef as it doesn't allow optional properties
078    @XmlElements({
079    @XmlElement(required = false, name = "avro", type = AvroDataFormat.class),
080    @XmlElement(required = false, name = "base64", type = Base64DataFormat.class),
081    @XmlElement(required = false, name = "beanio", type = BeanioDataFormat.class),
082    @XmlElement(required = false, name = "bindy", type = BindyDataFormat.class),
083    @XmlElement(required = false, name = "castor", type = CastorDataFormat.class),
084    @XmlElement(required = false, name = "crypto", type = CryptoDataFormat.class),
085    @XmlElement(required = false, name = "csv", type = CsvDataFormat.class),
086    @XmlElement(required = false, name = "custom", type = CustomDataFormat.class),
087    @XmlElement(required = false, name = "flatpack", type = FlatpackDataFormat.class),
088    @XmlElement(required = false, name = "gzip", type = GzipDataFormat.class),
089    @XmlElement(required = false, name = "hl7", type = HL7DataFormat.class),
090    @XmlElement(required = false, name = "ical", type = IcalDataFormat.class),
091    @XmlElement(required = false, name = "jaxb", type = JaxbDataFormat.class),
092    @XmlElement(required = false, name = "jibx", type = JibxDataFormat.class),
093    @XmlElement(required = false, name = "json", type = JsonDataFormat.class),
094    @XmlElement(required = false, name = "protobuf", type = ProtobufDataFormat.class),
095    @XmlElement(required = false, name = "rss", type = RssDataFormat.class),
096    @XmlElement(required = false, name = "secureXML", type = XMLSecurityDataFormat.class),
097    @XmlElement(required = false, name = "serialization", type = SerializationDataFormat.class),
098    @XmlElement(required = false, name = "soapjaxb", type = SoapJaxbDataFormat.class),
099    @XmlElement(required = false, name = "string", type = StringDataFormat.class),
100    @XmlElement(required = false, name = "syslog", type = SyslogDataFormat.class),
101    @XmlElement(required = false, name = "tidyMarkup", type = TidyMarkupDataFormat.class),
102    @XmlElement(required = false, name = "univocity-csv", type = UniVocityCsvDataFormat.class),
103    @XmlElement(required = false, name = "univocity-fixed", type = UniVocityFixedWidthDataFormat.class),
104    @XmlElement(required = false, name = "univocity-tsv", type = UniVocityTsvDataFormat.class),
105    @XmlElement(required = false, name = "xmlBeans", type = XMLBeansDataFormat.class),
106    @XmlElement(required = false, name = "xmljson", type = XmlJsonDataFormat.class),
107    @XmlElement(required = false, name = "xmlrpc", type = XmlRpcDataFormat.class),
108    @XmlElement(required = false, name = "xstream", type = XStreamDataFormat.class),
109    @XmlElement(required = false, name = "pgp", type = PGPDataFormat.class),
110    @XmlElement(required = false, name = "zip", type = ZipDataFormat.class),
111    @XmlElement(required = false, name = "zipFile", type = ZipFileDataFormat.class)}
112    )
113    private DataFormatDefinition dataFormatType;
114
115    @XmlAttribute
116    @Deprecated
117    private String ref;
118
119    public UnmarshalDefinition() {
120    }
121
122    public UnmarshalDefinition(DataFormatDefinition dataFormatType) {
123        this.dataFormatType = dataFormatType;
124    }
125
126    public UnmarshalDefinition(String ref) {
127        this.ref = ref;
128    }
129
130    @Override
131    public String toString() {
132        return "Unmarshal[" + description() + "]";
133    }
134    
135    protected String description() {
136        if (dataFormatType != null) {
137            return dataFormatType.toString();
138        } else {
139            return "ref:" + ref;
140        }
141    }
142
143    @Override
144    public String getLabel() {
145        return "unmarshal[" + description() + "]";
146    }
147
148    public String getRef() {
149        return ref;
150    }
151
152    /**
153     * To refer to a custom data format to use as unmarshaller
154     *
155     * @deprecated use custom dataformat instead
156     */
157    @Deprecated
158    public void setRef(String ref) {
159        this.ref = ref;
160    }
161
162    public DataFormatDefinition getDataFormatType() {
163        return dataFormatType;
164    }
165
166    /**
167     * The data format to be used
168     */
169    public void setDataFormatType(DataFormatDefinition dataFormatType) {
170        this.dataFormatType = dataFormatType;
171    }
172
173    @Override
174    public Processor createProcessor(RouteContext routeContext) {
175        DataFormat dataFormat = DataFormatDefinition.getDataFormat(routeContext, getDataFormatType(), ref);
176        return new UnmarshalProcessor(dataFormat);
177    }
178}