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 * Compression and decompress streams using java.util.zip.Zip*Stream.
029 */
030@Metadata(firstVersion = "2.11.0", label = "dataformat,transformation,file", title = "Zip File")
031@XmlRootElement(name = "zipfile")
032@XmlAccessorType(XmlAccessType.FIELD)
033public class ZipFileDataFormat extends DataFormatDefinition {
034    @XmlAttribute
035    @Metadata(javaType = "java.lang.Boolean")
036    private String usingIterator;
037    @XmlAttribute
038    @Metadata(javaType = "java.lang.Boolean")
039    private String allowEmptyDirectory;
040    @XmlAttribute
041    @Metadata(javaType = "java.lang.Boolean")
042    private String preservePathElements;
043    @XmlAttribute
044    @Metadata(javaType = "java.lang.Long")
045    private String maxDecompressedSize;
046
047    public ZipFileDataFormat() {
048        super("zipfile");
049    }
050
051    public String getUsingIterator() {
052        return usingIterator;
053    }
054
055    public String getAllowEmptyDirectory() {
056        return allowEmptyDirectory;
057    }
058
059    public String getPreservePathElements() {
060        return preservePathElements;
061    }
062
063    public String getMaxDecompressedSize() {
064        return maxDecompressedSize;
065    }
066
067    /**
068     * If the zip file has more then one entry, the setting this option to true,
069     * allows to work with the splitter EIP, to split the data using an iterator
070     * in a streaming mode.
071     */
072    public void setUsingIterator(String usingIterator) {
073        this.usingIterator = usingIterator;
074    }
075
076    /**
077     * If the zip file has more then one entry, setting this option to true,
078     * allows to get the iterator even if the directory is empty
079     */
080    public void setAllowEmptyDirectory(String allowEmptyDirectory) {
081        this.allowEmptyDirectory = allowEmptyDirectory;
082    }
083
084    /**
085     * If the file name contains path elements, setting this option to true,
086     * allows the path to be maintained in the zip file.
087     */
088    public void setPreservePathElements(String preservePathElements) {
089        this.preservePathElements = preservePathElements;
090    }
091
092    /**
093     * Set the maximum decompressed size of a zip file (in bytes). An IOException will be thrown if the decompressed
094     * size exceeds this amount. Set to -1 to disable setting a maximum decompressed size. By default there is no
095     * maximum size enforced.
096     *
097     * @param maxDecompressedSize the maximum decompressed size of a zip file (in bytes)
098     */
099    public void setMaxDecompressedSize(String maxDecompressedSize) {
100        this.maxDecompressedSize = maxDecompressedSize;
101    }
102}