1 // ******************************************************************************
2 //
3 // Title: Force Field X.
4 // Description: Force Field X - Software for Molecular Biophysics.
5 // Copyright: Copyright (c) Michael J. Schnieders 2001-2024.
6 //
7 // This file is part of Force Field X.
8 //
9 // Force Field X is free software; you can redistribute it and/or modify it
10 // under the terms of the GNU General Public License version 3 as published by
11 // the Free Software Foundation.
12 //
13 // Force Field X is distributed in the hope that it will be useful, but WITHOUT
14 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 // FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
16 // details.
17 //
18 // You should have received a copy of the GNU General Public License along with
19 // Force Field X; if not, write to the Free Software Foundation, Inc., 59 Temple
20 // Place, Suite 330, Boston, MA 02111-1307 USA
21 //
22 // Linking this library statically or dynamically with other modules is making a
23 // combined work based on this library. Thus, the terms and conditions of the
24 // GNU General Public License cover the whole combination.
25 //
26 // As a special exception, the copyright holders of this library give you
27 // permission to link this library with independent modules to produce an
28 // executable, regardless of the license terms of these independent modules, and
29 // to copy and distribute the resulting executable under terms of your choice,
30 // provided that you also meet, for each linked independent module, the terms
31 // and conditions of the license of that module. An independent module is a
32 // module which is not derived from or based on this library. If you modify this
33 // library, you may extend this exception to your version of the library, but
34 // you are not obligated to do so. If you do not wish to do so, delete this
35 // exception statement from your version.
36 //
37 // ******************************************************************************
38 package ffx.utilities;
39
40 import java.io.File;
41 import java.net.URI;
42 import java.util.logging.Logger;
43
44 import static org.apache.commons.io.FileUtils.copyURLToFile;
45
46 /**
47 * Download utilities.
48 *
49 * @author Michal J. Schnieders
50 * @since 1.0
51 */
52 public class DownloadUtils {
53
54 private static final Logger logger = Logger.getLogger(DownloadUtils.class.getName());
55
56 /**
57 * Download a PDB file.
58 *
59 * @param pdbID The PDB ID.
60 * @return PDB The downloaded PDB filename (or null if there was an error).
61 */
62 public static String downloadPDB(String pdbID) {
63 try {
64 String url = "https://files.rcsb.org/download/" + pdbID + ".pdb";
65 logger.fine(" Attempting to download PDB from:\n " + url);
66 String fileName = pdbID + ".pdb";
67 File file = new File(fileName);
68 // Time-out after 5 seconds.
69 int connectionTimeoutMilliseconds = 5000;
70 int readTimeoutMilliseconds = 5000;
71 copyURLToFile(new URI(url).toURL(), file, connectionTimeoutMilliseconds, readTimeoutMilliseconds);
72 logger.fine(" PDB saved to:\n " + file.getAbsolutePath());
73 return fileName;
74 } catch (Exception e) {
75 logger.warning(" Error downloading PDB ID: " + pdbID + "\n " + e);
76 return null;
77 }
78 }
79 }