View Javadoc
1   /*
2    * This file is part of Waarp Project (named also Waarp or GG).
3    *
4    *  Copyright (c) 2019, Waarp SAS, and individual contributors by the @author
5    *  tags. See the COPYRIGHT.txt in the distribution for a full listing of
6    * individual contributors.
7    *
8    *  All Waarp Project is free software: you can redistribute it and/or
9    * modify it under the terms of the GNU General Public License as published by
10   * the Free Software Foundation, either version 3 of the License, or (at your
11   * option) any later version.
12   *
13   * Waarp is distributed in the hope that it will be useful, but WITHOUT ANY
14   * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
15   * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16   *
17   *  You should have received a copy of the GNU General Public License along with
18   * Waarp . If not, see <http://www.gnu.org/licenses/>.
19   */
20  
21  package org.waarp.gateway.ftp.file;
22  
23  import org.waarp.common.command.exception.CommandAbstractException;
24  import org.waarp.ftp.core.file.FtpFile;
25  import org.waarp.ftp.core.session.FtpSession;
26  import org.waarp.ftp.filesystembased.FilesystemBasedFtpFile;
27  
28  import java.io.File;
29  
30  /**
31   * FtpFile implementation based on true directories and files
32   */
33  public class FileBasedFile extends FilesystemBasedFtpFile {
34    /**
35     * @param session
36     * @param fileBasedDir It is not necessary the directory that owns
37     *     this
38     *     file.
39     * @param path
40     * @param append
41     *
42     * @throws CommandAbstractException
43     */
44    public FileBasedFile(final FtpSession session,
45                         final FileBasedDir fileBasedDir, final String path,
46                         final boolean append) throws CommandAbstractException {
47      super(session, fileBasedDir, path, append);
48    }
49  
50    /**
51     * This method is a good to have in a true {@link FtpFile} implementation.
52     *
53     * @return the File associated with the current FtpFile operation
54     */
55    public final File getTrueFile() {
56      try {
57        return getFileFromPath(getFile());
58      } catch (final CommandAbstractException e) {
59        return null;
60      }
61    }
62  }