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.transformer;
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.XmlType;
025import org.apache.camel.CamelContext;
026import org.apache.camel.impl.transformer.DataFormatTransformer;
027import org.apache.camel.model.DataFormatDefinition;
028import org.apache.camel.model.dataformat.ASN1DataFormat;
029import org.apache.camel.model.dataformat.AvroDataFormat;
030import org.apache.camel.model.dataformat.BarcodeDataFormat;
031import org.apache.camel.model.dataformat.Base64DataFormat;
032import org.apache.camel.model.dataformat.BeanioDataFormat;
033import org.apache.camel.model.dataformat.BindyDataFormat;
034import org.apache.camel.model.dataformat.BoonDataFormat;
035import org.apache.camel.model.dataformat.CastorDataFormat;
036import org.apache.camel.model.dataformat.CryptoDataFormat;
037import org.apache.camel.model.dataformat.CsvDataFormat;
038import org.apache.camel.model.dataformat.CustomDataFormat;
039import org.apache.camel.model.dataformat.FlatpackDataFormat;
040import org.apache.camel.model.dataformat.GzipDataFormat;
041import org.apache.camel.model.dataformat.HL7DataFormat;
042import org.apache.camel.model.dataformat.HessianDataFormat;
043import org.apache.camel.model.dataformat.IcalDataFormat;
044import org.apache.camel.model.dataformat.JacksonXMLDataFormat;
045import org.apache.camel.model.dataformat.JaxbDataFormat;
046import org.apache.camel.model.dataformat.JibxDataFormat;
047import org.apache.camel.model.dataformat.JsonDataFormat;
048import org.apache.camel.model.dataformat.LZFDataFormat;
049import org.apache.camel.model.dataformat.MimeMultipartDataFormat;
050import org.apache.camel.model.dataformat.PGPDataFormat;
051import org.apache.camel.model.dataformat.ProtobufDataFormat;
052import org.apache.camel.model.dataformat.RssDataFormat;
053import org.apache.camel.model.dataformat.SerializationDataFormat;
054import org.apache.camel.model.dataformat.SoapJaxbDataFormat;
055import org.apache.camel.model.dataformat.StringDataFormat;
056import org.apache.camel.model.dataformat.SyslogDataFormat;
057import org.apache.camel.model.dataformat.TarFileDataFormat;
058import org.apache.camel.model.dataformat.ThriftDataFormat;
059import org.apache.camel.model.dataformat.TidyMarkupDataFormat;
060import org.apache.camel.model.dataformat.UniVocityCsvDataFormat;
061import org.apache.camel.model.dataformat.UniVocityFixedWidthDataFormat;
062import org.apache.camel.model.dataformat.UniVocityTsvDataFormat;
063import org.apache.camel.model.dataformat.XMLBeansDataFormat;
064import org.apache.camel.model.dataformat.XMLSecurityDataFormat;
065import org.apache.camel.model.dataformat.XStreamDataFormat;
066import org.apache.camel.model.dataformat.XmlJsonDataFormat;
067import org.apache.camel.model.dataformat.XmlRpcDataFormat;
068import org.apache.camel.model.dataformat.YAMLDataFormat;
069import org.apache.camel.model.dataformat.ZipDataFormat;
070import org.apache.camel.model.dataformat.ZipFileDataFormat;
071import org.apache.camel.spi.DataFormat;
072import org.apache.camel.spi.Metadata;
073import org.apache.camel.spi.Transformer;
074
075/**
076 * Represents a {@link DataFormatTransformer} which leverages {@link DataFormat} to perform
077 * transformation. One of the DataFormat 'ref' or DataFormat 'type' needs to be specified.
078 * 
079 * {@see TransformerDefinition}
080 * {@see DataFormatTransformer}
081 */
082@Metadata(label = "transformation")
083@XmlType(name = "dataFormatTransformer")
084@XmlAccessorType(XmlAccessType.FIELD)
085public class DataFormatTransformerDefinition extends TransformerDefinition {
086
087    @XmlElements({
088        @XmlElement(required = false, name = "asn1", type = ASN1DataFormat.class),
089        @XmlElement(required = false, name = "avro", type = AvroDataFormat.class),
090        @XmlElement(required = false, name = "barcode", type = BarcodeDataFormat.class),
091        @XmlElement(required = false, name = "base64", type = Base64DataFormat.class),
092        @XmlElement(required = false, name = "beanio", type = BeanioDataFormat.class),
093        @XmlElement(required = false, name = "bindy", type = BindyDataFormat.class),
094        @XmlElement(required = false, name = "boon", type = BoonDataFormat.class),
095        @XmlElement(required = false, name = "castor", type = CastorDataFormat.class),
096        @XmlElement(required = false, name = "crypto", type = CryptoDataFormat.class),
097        @XmlElement(required = false, name = "csv", type = CsvDataFormat.class),
098        // TODO: Camel 3.0 - Should be named customDataFormat to avoid naming clash with custom loadbalancer
099        @XmlElement(required = false, name = "custom", type = CustomDataFormat.class),
100        @XmlElement(required = false, name = "flatpack", type = FlatpackDataFormat.class),
101        @XmlElement(required = false, name = "gzip", type = GzipDataFormat.class),
102        @XmlElement(required = false, name = "hessian", type = HessianDataFormat.class),
103        @XmlElement(required = false, name = "hl7", type = HL7DataFormat.class),
104        @XmlElement(required = false, name = "ical", type = IcalDataFormat.class),
105        @XmlElement(required = false, name = "jacksonxml", type = JacksonXMLDataFormat.class),
106        @XmlElement(required = false, name = "jaxb", type = JaxbDataFormat.class),
107        @XmlElement(required = false, name = "jibx", type = JibxDataFormat.class),
108        @XmlElement(required = false, name = "json", type = JsonDataFormat.class),
109        @XmlElement(required = false, name = "lzf", type = LZFDataFormat.class),
110        @XmlElement(required = false, name = "mimeMultipart", type = MimeMultipartDataFormat.class),
111        @XmlElement(required = false, name = "protobuf", type = ProtobufDataFormat.class),
112        @XmlElement(required = false, name = "rss", type = RssDataFormat.class),
113        @XmlElement(required = false, name = "secureXML", type = XMLSecurityDataFormat.class),
114        @XmlElement(required = false, name = "serialization", type = SerializationDataFormat.class),
115        @XmlElement(required = false, name = "soapjaxb", type = SoapJaxbDataFormat.class),
116        @XmlElement(required = false, name = "string", type = StringDataFormat.class),
117        @XmlElement(required = false, name = "syslog", type = SyslogDataFormat.class),
118        @XmlElement(required = false, name = "tarfile", type = TarFileDataFormat.class),
119        @XmlElement(required = false, name = "thrift", type = ThriftDataFormat.class),
120        @XmlElement(required = false, name = "tidyMarkup", type = TidyMarkupDataFormat.class),
121        @XmlElement(required = false, name = "univocity-csv", type = UniVocityCsvDataFormat.class),
122        @XmlElement(required = false, name = "univocity-fixed", type = UniVocityFixedWidthDataFormat.class),
123        @XmlElement(required = false, name = "univocity-tsv", type = UniVocityTsvDataFormat.class),
124        @XmlElement(required = false, name = "xmlBeans", type = XMLBeansDataFormat.class),
125        @XmlElement(required = false, name = "xmljson", type = XmlJsonDataFormat.class),
126        @XmlElement(required = false, name = "xmlrpc", type = XmlRpcDataFormat.class),
127        @XmlElement(required = false, name = "xstream", type = XStreamDataFormat.class),
128        @XmlElement(required = false, name = "pgp", type = PGPDataFormat.class),
129        @XmlElement(required = false, name = "yaml", type = YAMLDataFormat.class),
130        @XmlElement(required = false, name = "zip", type = ZipDataFormat.class),
131        @XmlElement(required = false, name = "zipFile", type = ZipFileDataFormat.class)}
132        )
133    private DataFormatDefinition dataFormatType;
134
135    @XmlAttribute
136    private String ref;
137
138    @Override
139    protected Transformer doCreateTransformer(CamelContext context) {
140        return new DataFormatTransformer(context)
141                .setDataFormatType(dataFormatType)
142                .setDataFormatRef(ref)
143                .setModel(getScheme())
144                .setFrom(getFromType())
145                .setTo(getToType());
146    }
147
148    public String getRef() {
149        return ref;
150    }
151
152    /**
153     * Set the reference of the DataFormat.
154     *
155     * @param ref reference of the DataFormat
156     */
157    public void setRef(String ref) {
158        this.ref = ref;
159    }
160
161    public DataFormatDefinition getDataFormatType() {
162        return dataFormatType;
163    }
164
165    /**
166     * The data format to be used
167     */
168    public void setDataFormatType(DataFormatDefinition dataFormatType) {
169        this.dataFormatType = dataFormatType;
170    }
171
172}
173