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 * The Tar File data format is a message compression and de-compression format of tar files.
031 */
032@Metadata(firstVersion = "2.16.0", 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    @XmlAttribute
039    private Boolean allowEmptyDirectory;
040    @XmlAttribute
041    private Boolean preservePathElements;
042
043    public TarFileDataFormat() {
044        super("tarfile");
045    }
046
047    @Override
048    protected void configureDataFormat(DataFormat dataFormat, CamelContext camelContext) {
049        if (usingIterator != null) {
050            setProperty(camelContext, dataFormat, "usingIterator", usingIterator);
051        }
052        if (preservePathElements != null) {
053            setProperty(camelContext, dataFormat, "preservePathElements", preservePathElements);
054        }
055    }
056
057    public Boolean getUsingIterator() {
058        return usingIterator;
059    }
060    
061    public Boolean getAllowEmptyDirectory() {
062        return allowEmptyDirectory;
063    }
064
065    public Boolean getPreservePathElements() {
066        return preservePathElements;
067    }
068
069    /**
070     * If the tar file has more then one entry, the setting this option to true, allows to work with the splitter EIP,
071     * to split the data using an iterator in a streaming mode.
072     */
073    public void setUsingIterator(Boolean usingIterator) {
074        this.usingIterator = usingIterator;
075    }
076    
077    /**
078     * If the tar file has more then one entry, setting this option to true, allows to get the iterator
079     * even if the directory is empty
080     */
081    public void setAllowEmptyDirectory(Boolean allowEmptyDirectory) {
082        this.allowEmptyDirectory = allowEmptyDirectory;
083    }
084
085    /**
086     * If the file name contains path elements, setting this option to true, allows the path to be maintained
087     * in the tar file.
088     */
089    public void setPreservePathElements(Boolean preservePathElements) {
090        this.preservePathElements = preservePathElements;
091    }
092}