org.frankframework.filesystem.FileSystemBase Maven / Gradle / Ivy

Go to download
/*
   Copyright 2020-2024 WeAreFrank!

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
 */
package org.frankframework.filesystem;

import java.io.IOException;
import java.nio.file.DirectoryStream;
import java.util.Iterator;

import org.apache.logging.log4j.Logger;
import org.frankframework.util.LogUtil;

/**
 * Baseclass for {@link IBasicFileSystem FileSystems}.
 *
 * @author Gerrit van Brakel
 *
 */
public abstract class FileSystemBase implements IBasicFileSystem {
	protected final Logger log = LogUtil.getLogger(this);

	private int maxNumberOfMessagesToList=-1;

	private boolean open;

	@Override
	public void open() throws FileSystemException {
		open = true;
	}
	@Override
	public void close() throws FileSystemException {
		open = false;
	}

	@Override
	public boolean isOpen() {
		return open;
	}

	@Override
	public int getNumberOfFilesInFolder(String folder) throws FileSystemException {
		int count = 0;
		int stopAt = getMaxNumberOfMessagesToList();
		if (stopAt<0) {
			stopAt = Integer.MAX_VALUE;
		}
		try(DirectoryStream ds = list(folder, TypeFilter.FILES_ONLY)) {
			for (Iterator it = ds.iterator(); it.hasNext() && count<=stopAt; it.next()) {
				count++;
			}
		} catch (IOException e) {
			throw new FileSystemException(e);
		}
		return count;
	}

	/**
	 * The maximum number of messages to be retrieved from a folder.
	 * @ff.default -1 (unlimited)
	 */
	public void setMaxNumberOfMessagesToList(int maxNumberOfMessagesToList) {
		this.maxNumberOfMessagesToList = maxNumberOfMessagesToList;
	}
	public int getMaxNumberOfMessagesToList() {
		return maxNumberOfMessagesToList;
	}


}