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.model.DataFormatDefinition;
025import org.apache.camel.spi.Metadata;
026
027/**
028 * The Zip File data format is a message compression and de-compression format
029 * of zip files.
030 */
031@Metadata(firstVersion = "2.11.0", label = "dataformat,transformation,file", title = "Zip File")
032@XmlRootElement(name = "zipfile")
033@XmlAccessorType(XmlAccessType.FIELD)
034public class ZipFileDataFormat extends DataFormatDefinition {
035    @XmlAttribute
036    private Boolean usingIterator;
037    @XmlAttribute
038    private Boolean allowEmptyDirectory;
039    @XmlAttribute
040    private Boolean preservePathElements;
041
042    public ZipFileDataFormat() {
043        super("zipfile");
044    }
045
046    public Boolean getUsingIterator() {
047        return usingIterator;
048    }
049
050    public Boolean getAllowEmptyDirectory() {
051        return allowEmptyDirectory;
052    }
053
054    public Boolean getPreservePathElements() {
055        return preservePathElements;
056    }
057
058    /**
059     * If the zip file has more then one entry, the setting this option to true,
060     * allows to work with the splitter EIP, to split the data using an iterator
061     * in a streaming mode.
062     */
063    public void setUsingIterator(Boolean usingIterator) {
064        this.usingIterator = usingIterator;
065    }
066
067    /**
068     * If the zip file has more then one entry, setting this option to true,
069     * allows to get the iterator even if the directory is empty
070     */
071    public void setAllowEmptyDirectory(Boolean allowEmptyDirectory) {
072        this.allowEmptyDirectory = allowEmptyDirectory;
073    }
074
075    /**
076     * If the file name contains path elements, setting this option to true,
077     * allows the path to be maintained in the zip file.
078     */
079    public void setPreservePathElements(Boolean preservePathElements) {
080        this.preservePathElements = preservePathElements;
081    }
082
083}