| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>org.apache.sis.cloud.aws.s3 (Apache SIS 1.4 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2023-10-05"> |
| <meta name="description" content="declaration: module: org.apache.sis.cloud.aws, package: org.apache.sis.cloud.aws.s3"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.cloud.aws.s3 package"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../sis.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="package-declaration-page"> |
| <script type="text/javascript">var pathtoroot = "../../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../../index.html">Overview</a></li> |
| <li><a href="../../../../../../module-summary.html">Module</a></li> |
| <li class="nav-bar-cell1-rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html#package">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Package:</p> |
| <ul> |
| <li><a href="#package-description">Description</a></li> |
| <li>Related Packages</li> |
| <li><a href="#class-summary">Classes and Interfaces</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li>Related Packages | </li> |
| <li><a href="#class-summary">Classes and Interfaces</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../../../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-package">Module</span> <a href="../../../../../../module-summary.html">org.apache.sis.cloud.aws</a></div> |
| <h1 title="Package org.apache.sis.cloud.aws.s3" class="title">Package org.apache.sis.cloud.aws.s3</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">org.apache.sis.cloud.aws.s3</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Java NIO wrappers for Amazon Simple Storage Service (S3). |
| The wrapped framework is AWS SDK version 2. |
| |
| <h2 id="url-syntax-heading">URL syntax</h2> |
| <p>The file system in this package accepts URIs of the following forms:</p> |
| |
| <ul> |
| <li><code>S3://bucket/key</code></li> |
| <li><code>S3://accessKey@bucket/key</code> (password not allowed)</li> |
| </ul> |
| |
| <p>Keys can be paths with components separated by the <code>'/'</code> separator. |
| The password and the region can be specified at |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/file/FileSystems.html#newFileSystem(java.net.URI,java.util.Map)" title="class or interface in java.nio.file" class="external-link">file system initialization time</a>. |
| The endpoint (e.g. <code>"s3.eu-central-1.amazonaws.com"</code>) shall <em>not</em> be specified in the URI. |
| In particular the region (<code>"eu-central-1"</code> in above example) can depend on the server location |
| instead of the data to access, and can be a global configuration for the server.</p> |
| |
| <p>After a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link"><code>Path</code></a> instance has been created, |
| the following syntax can be used on <code>Path</code> methods expecting a <code>String</code> argument. |
| The <code>key</code> can be a path with <code>'/'</code> separators.</p> |
| |
| <ul> |
| <li><code>"S3://bucket/key"</code> (note that <code>"accessKey@bucket"</code> is not accepted)</li> |
| <li><code>"/bucket/key"</code> (absolute path)</li> |
| <li><code>"key"</code> (relative path)</li> |
| </ul> |
| |
| <h2 id="thread-safety-heading">Thread safety</h2> |
| All classes provided by this package are safe of usage in multi-threading environment.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>1.2</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="https://sdk.amazonaws.com/java/api/latest/index.html">AWS SDK for Java</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="class-summary"> |
| <div class="caption"><span>Classes</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="FileService.html" title="class in org.apache.sis.cloud.aws.s3">FileService</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A provider of file system services as wrappers around Amazon Simple Storage Service (AWS S3).</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
