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 Zip File data format is a message compression and de-compression format of zip files. 031 */ 032@Metadata(firstVersion = "2.11.0", label = "dataformat,transformation,file", title = "Zip File") 033// TODO: use zipfile as name in Camel 3.0 034@XmlRootElement(name = "zipFile") 035@XmlAccessorType(XmlAccessType.FIELD) 036public class ZipFileDataFormat extends DataFormatDefinition { 037 @XmlAttribute 038 private Boolean usingIterator; 039 @XmlAttribute 040 private Boolean allowEmptyDirectory; 041 @XmlAttribute 042 private Boolean preservePathElements; 043 044 public ZipFileDataFormat() { 045 super("zipfile"); 046 } 047 048 @Override 049 protected void configureDataFormat(DataFormat dataFormat, CamelContext camelContext) { 050 if (usingIterator != null) { 051 setProperty(camelContext, dataFormat, "usingIterator", usingIterator); 052 } 053 if (allowEmptyDirectory != null) { 054 setProperty(camelContext, dataFormat, "allowEmptyDirectory", allowEmptyDirectory); 055 } 056 if (preservePathElements != null) { 057 setProperty(camelContext, dataFormat, "preservePathElements", preservePathElements); 058 } 059 } 060 061 public Boolean getUsingIterator() { 062 return usingIterator; 063 } 064 065 public Boolean getAllowEmptyDirectory() { 066 return allowEmptyDirectory; 067 } 068 069 public Boolean getPreservePathElements() { 070 return preservePathElements; 071 } 072 073 /** 074 * If the zip file has more then one entry, the setting this option to true, allows to work with the splitter EIP, 075 * to split the data using an iterator in a streaming mode. 076 */ 077 public void setUsingIterator(Boolean usingIterator) { 078 this.usingIterator = usingIterator; 079 } 080 081 /** 082 * If the zip file has more then one entry, setting this option to true, allows to get the iterator 083 * even if the directory is empty 084 */ 085 public void setAllowEmptyDirectory(Boolean allowEmptyDirectory) { 086 this.allowEmptyDirectory = allowEmptyDirectory; 087 } 088 089 /** 090 * If the file name contains path elements, setting this option to true, allows the path to be maintained 091 * in the zip file. 092 */ 093 public void setPreservePathElements(Boolean preservePathElements) { 094 this.preservePathElements = preservePathElements; 095 } 096 097}