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    @Metadata(javaType = "java.lang.Boolean")
037    private String usingIterator;
038    @XmlAttribute
039    @Metadata(javaType = "java.lang.Boolean")
040    private String allowEmptyDirectory;
041    @XmlAttribute
042    @Metadata(javaType = "java.lang.Boolean")
043    private String preservePathElements;
044
045    public ZipFileDataFormat() {
046        super("zipfile");
047    }
048
049    public String getUsingIterator() {
050        return usingIterator;
051    }
052
053    public String getAllowEmptyDirectory() {
054        return allowEmptyDirectory;
055    }
056
057    public String getPreservePathElements() {
058        return preservePathElements;
059    }
060
061    /**
062     * If the zip file has more then one entry, the setting this option to true,
063     * allows to work with the splitter EIP, to split the data using an iterator
064     * in a streaming mode.
065     */
066    public void setUsingIterator(String usingIterator) {
067        this.usingIterator = usingIterator;
068    }
069
070    /**
071     * If the zip file has more then one entry, setting this option to true,
072     * allows to get the iterator even if the directory is empty
073     */
074    public void setAllowEmptyDirectory(String allowEmptyDirectory) {
075        this.allowEmptyDirectory = allowEmptyDirectory;
076    }
077
078    /**
079     * If the file name contains path elements, setting this option to true,
080     * allows the path to be maintained in the zip file.
081     */
082    public void setPreservePathElements(String preservePathElements) {
083        this.preservePathElements = preservePathElements;
084    }
085
086}