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.dataformat;
018
019import javax.xml.bind.annotation.XmlAccessType;
020import javax.xml.bind.annotation.XmlAccessorType;
021import javax.xml.bind.annotation.XmlAttribute;
022import javax.xml.bind.annotation.XmlRootElement;
023
024import org.apache.camel.CamelContext;
025import org.apache.camel.model.DataFormatDefinition;
026import org.apache.camel.spi.DataFormat;
027import org.apache.camel.spi.Metadata;
028
029/**
030 * Represents the TAR file XML {@link org.apache.camel.spi.DataFormat}.
031 */
032@Metadata(label = "dataformat,transformation,file", title = "Tar File")
033@XmlRootElement(name = "tarfile")
034@XmlAccessorType(XmlAccessType.FIELD)
035public class TarFileDataFormat extends DataFormatDefinition {
036    @XmlAttribute
037    private Boolean usingIterator;
038
039    public TarFileDataFormat() {
040        super("tarfile");
041    }
042
043    @Override
044    protected void configureDataFormat(DataFormat dataFormat, CamelContext camelContext) {
045        if (usingIterator != null) {
046            setProperty(camelContext, dataFormat, "usingIterator", usingIterator);
047        }
048    }
049
050    public Boolean getUsingIterator() {
051        return usingIterator;
052    }
053
054    /**
055     * If the tar file has more then one entry, the setting this option to true, allows to work with the splitter EIP,
056     * to split the data using an iterator in a streaming mode.
057     */
058    public void setUsingIterator(Boolean usingIterator) {
059        this.usingIterator = usingIterator;
060    }
061}