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.XmlElement;
022import javax.xml.bind.annotation.XmlElements;
023import javax.xml.bind.annotation.XmlRootElement;
024
025import org.apache.camel.model.dataformat.ASN1DataFormat;
026import org.apache.camel.model.dataformat.Any23DataFormat;
027import org.apache.camel.model.dataformat.AvroDataFormat;
028import org.apache.camel.model.dataformat.BarcodeDataFormat;
029import org.apache.camel.model.dataformat.Base64DataFormat;
030import org.apache.camel.model.dataformat.BeanioDataFormat;
031import org.apache.camel.model.dataformat.BindyDataFormat;
032import org.apache.camel.model.dataformat.CBORDataFormat;
033import org.apache.camel.model.dataformat.CryptoDataFormat;
034import org.apache.camel.model.dataformat.CsvDataFormat;
035import org.apache.camel.model.dataformat.CustomDataFormat;
036import org.apache.camel.model.dataformat.FhirJsonDataFormat;
037import org.apache.camel.model.dataformat.FhirXmlDataFormat;
038import org.apache.camel.model.dataformat.FlatpackDataFormat;
039import org.apache.camel.model.dataformat.GrokDataFormat;
040import org.apache.camel.model.dataformat.GzipDataFormat;
041import org.apache.camel.model.dataformat.HL7DataFormat;
042import org.apache.camel.model.dataformat.IcalDataFormat;
043import org.apache.camel.model.dataformat.JacksonXMLDataFormat;
044import org.apache.camel.model.dataformat.JaxbDataFormat;
045import org.apache.camel.model.dataformat.JsonApiDataFormat;
046import org.apache.camel.model.dataformat.JsonDataFormat;
047import org.apache.camel.model.dataformat.LZFDataFormat;
048import org.apache.camel.model.dataformat.MimeMultipartDataFormat;
049import org.apache.camel.model.dataformat.PGPDataFormat;
050import org.apache.camel.model.dataformat.ProtobufDataFormat;
051import org.apache.camel.model.dataformat.RssDataFormat;
052import org.apache.camel.model.dataformat.SoapJaxbDataFormat;
053import org.apache.camel.model.dataformat.SyslogDataFormat;
054import org.apache.camel.model.dataformat.TarFileDataFormat;
055import org.apache.camel.model.dataformat.ThriftDataFormat;
056import org.apache.camel.model.dataformat.TidyMarkupDataFormat;
057import org.apache.camel.model.dataformat.UniVocityCsvDataFormat;
058import org.apache.camel.model.dataformat.UniVocityFixedWidthDataFormat;
059import org.apache.camel.model.dataformat.UniVocityTsvDataFormat;
060import org.apache.camel.model.dataformat.XMLSecurityDataFormat;
061import org.apache.camel.model.dataformat.XStreamDataFormat;
062import org.apache.camel.model.dataformat.XmlRpcDataFormat;
063import org.apache.camel.model.dataformat.YAMLDataFormat;
064import org.apache.camel.model.dataformat.ZipDeflaterDataFormat;
065import org.apache.camel.model.dataformat.ZipFileDataFormat;
066import org.apache.camel.spi.Metadata;
067
068/**
069 * Converts the message data received from the wire into a format that Apache
070 * Camel processors can consume
071 */
072@Metadata(label = "dataformat,transformation")
073@XmlRootElement(name = "unmarshal")
074@XmlAccessorType(XmlAccessType.FIELD)
075public class UnmarshalDefinition extends NoOutputDefinition<UnmarshalDefinition> {
076
077    @XmlElements({@XmlElement(required = false, name = "any23", type = Any23DataFormat.class),
078            @XmlElement(required = false, name = "asn1", type = ASN1DataFormat.class),
079            @XmlElement(required = false, name = "avro", type = AvroDataFormat.class),
080            @XmlElement(required = false, name = "barcode", type = BarcodeDataFormat.class),
081            @XmlElement(required = false, name = "base64", type = Base64DataFormat.class),
082            @XmlElement(required = false, name = "beanio", type = BeanioDataFormat.class),
083            @XmlElement(required = false, name = "bindy", type = BindyDataFormat.class),
084            @XmlElement(required = false, name = "cbor", type = CBORDataFormat.class),
085            @XmlElement(required = false, name = "crypto", type = CryptoDataFormat.class),
086            @XmlElement(required = false, name = "csv", type = CsvDataFormat.class),
087            @XmlElement(required = false, name = "custom", type = CustomDataFormat.class),
088            @XmlElement(required = false, name = "fhirJson", type = FhirJsonDataFormat.class),
089            @XmlElement(required = false, name = "fhirXml", type = FhirXmlDataFormat.class),
090            @XmlElement(required = false, name = "flatpack", type = FlatpackDataFormat.class),
091            @XmlElement(required = false, name = "grok", type = GrokDataFormat.class),
092            @XmlElement(required = false, name = "gzip", type = GzipDataFormat.class),
093            @XmlElement(required = false, name = "hl7", type = HL7DataFormat.class),
094            @XmlElement(required = false, name = "ical", type = IcalDataFormat.class),
095            @XmlElement(required = false, name = "jacksonxml", type = JacksonXMLDataFormat.class),
096            @XmlElement(required = false, name = "jaxb", type = JaxbDataFormat.class),
097            @XmlElement(required = false, name = "json", type = JsonDataFormat.class),
098            @XmlElement(required = false, name = "jsonApi", type = JsonApiDataFormat.class),
099            @XmlElement(required = false, name = "lzf", type = LZFDataFormat.class),
100            @XmlElement(required = false, name = "mimeMultipart", type = MimeMultipartDataFormat.class),
101            @XmlElement(required = false, name = "protobuf", type = ProtobufDataFormat.class),
102            @XmlElement(required = false, name = "rss", type = RssDataFormat.class),
103            @XmlElement(required = false, name = "secureXML", type = XMLSecurityDataFormat.class),
104            @XmlElement(required = false, name = "soapjaxb", type = SoapJaxbDataFormat.class),
105            @XmlElement(required = false, name = "syslog", type = SyslogDataFormat.class),
106            @XmlElement(required = false, name = "tarfile", type = TarFileDataFormat.class),
107            @XmlElement(required = false, name = "thrift", type = ThriftDataFormat.class),
108            @XmlElement(required = false, name = "tidyMarkup", type = TidyMarkupDataFormat.class),
109            @XmlElement(required = false, name = "univocity-csv", type = UniVocityCsvDataFormat.class),
110            @XmlElement(required = false, name = "univocity-fixed", type = UniVocityFixedWidthDataFormat.class),
111            @XmlElement(required = false, name = "univocity-tsv", type = UniVocityTsvDataFormat.class),
112            @XmlElement(required = false, name = "xmlrpc", type = XmlRpcDataFormat.class),
113            @XmlElement(required = false, name = "xstream", type = XStreamDataFormat.class),
114            @XmlElement(required = false, name = "pgp", type = PGPDataFormat.class),
115            @XmlElement(required = false, name = "yaml", type = YAMLDataFormat.class),
116            @XmlElement(required = false, name = "zip", type = ZipDeflaterDataFormat.class),
117            @XmlElement(required = false, name = "zipfile", type = ZipFileDataFormat.class)})
118    private DataFormatDefinition dataFormatType;
119
120    public UnmarshalDefinition() {
121    }
122
123    public UnmarshalDefinition(DataFormatDefinition dataFormatType) {
124        this.dataFormatType = dataFormatType;
125    }
126
127    @Override
128    public String toString() {
129        return "Unmarshal[" + description() + "]";
130    }
131
132    protected String description() {
133        if (dataFormatType != null) {
134            return dataFormatType.toString();
135        } else {
136            return "";
137        }
138    }
139
140    @Override
141    public String getShortName() {
142        return "unmarshal";
143    }
144
145    @Override
146    public String getLabel() {
147        return "unmarshal[" + description() + "]";
148    }
149
150    public DataFormatDefinition getDataFormatType() {
151        return dataFormatType;
152    }
153
154    /**
155     * The data format to be used
156     */
157    public void setDataFormatType(DataFormatDefinition dataFormatType) {
158        this.dataFormatType = dataFormatType;
159    }
160
161}