| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (19) --> |
| <title>FileService (Apache SIS 1.3 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="description" content="declaration: package: org.apache.sis.cloud.aws.s3, class: FileService"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.cloud.aws.s3.FileService class"> |
| <meta name="keywords" content="AWS_SECRET_ACCESS_KEY"> |
| <meta name="keywords" content="AWS_REGION"> |
| <meta name="keywords" content="SEPARATOR"> |
| <meta name="keywords" content="getScheme()"> |
| <meta name="keywords" content="newFileSystem()"> |
| <meta name="keywords" content="getFileSystem()"> |
| <meta name="keywords" content="getPath()"> |
| <meta name="keywords" content="isSameFile()"> |
| <meta name="keywords" content="isHidden()"> |
| <meta name="keywords" content="getFileStore()"> |
| <meta name="keywords" content="newDirectoryStream()"> |
| <meta name="keywords" content="createDirectory()"> |
| <meta name="keywords" content="copy()"> |
| <meta name="keywords" content="move()"> |
| <meta name="keywords" content="delete()"> |
| <meta name="keywords" content="newInputStream()"> |
| <meta name="keywords" content="newByteChannel()"> |
| <meta name="keywords" content="checkAccess()"> |
| <meta name="keywords" content="getFileAttributeView()"> |
| <meta name="keywords" content="readAttributes()"> |
| <meta name="keywords" content="setAttribute()"> |
| <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"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-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="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/FileService.html">Use</a></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#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li>Nested</li> |
| <li><a href="#field-summary">Field</a></li> |
| <li><a href="#constructor-summary">Constr</a></li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li><a href="#field-detail">Field</a></li> |
| <li><a href="#constructor-detail">Constr</a></li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</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"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.cloud.aws.s3</a></div> |
| <h1 title="Class FileService" class="title">Class FileService</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| <div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html" title="class or interface in java.nio.file.spi" class="external-link">FileSystemProvider</a> |
| <div class="inheritance">FileService</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">FileService</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html" title="class or interface in java.nio.file.spi" class="external-link">FileSystemProvider</a></span></div> |
| <div class="block">A provider of file system services as wrappers around Amazon Simple Storage Service (AWS S3). |
| This provider accepts URIs of the following forms: |
| |
| <ul> |
| <li><code>S3://bucket/key</code></li> |
| <li><code>S3://accessKey@bucket/key</code> (password not allowed)</li> |
| </ul> |
| |
| Keys can be paths with components separated by the <code>'/'</code> separator. |
| The password and the region can be specified at <a href="#newFileSystem(java.net.URI,java.util.Map)">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.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>1.2</dd> |
| |
| <p><font size="-1">Defined in the <code>sis-cloud-aws</code> module</font></p> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#AWS_REGION" class="member-name-link">AWS_REGION</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The property for the secret access key (password).</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#AWS_SECRET_ACCESS_KEY" class="member-name-link">AWS_SECRET_ACCESS_KEY</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The property for the secret access key (password).</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#SEPARATOR" class="member-name-link">SEPARATOR</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The property for the name-separator characters.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">FileService</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new provider of file systems for Amazon S3.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkAccess(java.nio.file.Path,java.nio.file.AccessMode...)" class="member-name-link">checkAccess</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/AccessMode.html" title="class or interface in java.nio.file" class="external-link">AccessMode</a>... modes)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Checks the existence, and optionally the accessibility, of a file.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#copy(java.nio.file.Path,java.nio.file.Path,java.nio.file.CopyOption...)" class="member-name-link">copy</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> source, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> target, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/CopyOption.html" title="class or interface in java.nio.file" class="external-link">CopyOption</a>... options)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Copies a file.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createDirectory(java.nio.file.Path,java.nio.file.attribute.FileAttribute...)" class="member-name-link">createDirectory</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> directory, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/attribute/FileAttribute.html" title="class or interface in java.nio.file.attribute" class="external-link">FileAttribute</a><?>... attributes)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Creates a new pseudo-directory.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#delete(java.nio.file.Path)" class="member-name-link">delete</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Deletes a file.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><V extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/attribute/FileAttributeView.html" title="class or interface in java.nio.file.attribute" class="external-link">FileAttributeView</a>><br>V</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFileAttributeView(java.nio.file.Path,java.lang.Class,java.nio.file.LinkOption...)" class="member-name-link">getFileAttributeView</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><V> type, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/LinkOption.html" title="class or interface in java.nio.file" class="external-link">LinkOption</a>... options)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a read-only or updatable view of a set of file attributes.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/FileStore.html" title="class or interface in java.nio.file" class="external-link">FileStore</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFileStore(java.nio.file.Path)" class="member-name-link">getFileStore</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the store where a file is located.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/FileSystem.html" title="class or interface in java.nio.file" class="external-link">FileSystem</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFileSystem(java.net.URI)" class="member-name-link">getFileSystem</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> uri)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a reference to a file system that was created by the <a href="#newFileSystem(java.net.URI,java.util.Map)"><code>newFileSystem(URI, Map)</code></a> method.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPath(java.net.URI)" class="member-name-link">getPath</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> uri)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return a <code>Path</code> object by converting the given <code>URI</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getScheme()" class="member-name-link">getScheme</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the URI scheme that identifies this provider, which is <code>"S3"</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isHidden(java.nio.file.Path)" class="member-name-link">isHidden</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Tells whether a file is considered hidden.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isSameFile(java.nio.file.Path,java.nio.file.Path)" class="member-name-link">isSameFile</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path1, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path2)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Tests if two paths locate the same file.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#move(java.nio.file.Path,java.nio.file.Path,java.nio.file.CopyOption...)" class="member-name-link">move</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> source, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> target, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/CopyOption.html" title="class or interface in java.nio.file" class="external-link">CopyOption</a>... options)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Copies a file.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/channels/SeekableByteChannel.html" title="class or interface in java.nio.channels" class="external-link">SeekableByteChannel</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#newByteChannel(java.nio.file.Path,java.util.Set,java.nio.file.attribute.FileAttribute...)" class="member-name-link">newByteChannel</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><? extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/OpenOption.html" title="class or interface in java.nio.file" class="external-link">OpenOption</a>> options, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/attribute/FileAttribute.html" title="class or interface in java.nio.file.attribute" class="external-link">FileAttribute</a><?>... attributes)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a seekable byte channel to access a file.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/DirectoryStream.html" title="class or interface in java.nio.file" class="external-link">DirectoryStream</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#newDirectoryStream(java.nio.file.Path,java.nio.file.DirectoryStream.Filter)" class="member-name-link">newDirectoryStream</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> directory, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/DirectoryStream.Filter.html" title="class or interface in java.nio.file" class="external-link">DirectoryStream.Filter</a><? super <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a>> filter)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Opens a directory and returns a <code>DirectoryStream</code> to iterate over its entries.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/FileSystem.html" title="class or interface in java.nio.file" class="external-link">FileSystem</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#newFileSystem(java.net.URI,java.util.Map)" class="member-name-link">newFileSystem</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> uri, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?> properties)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Initializes and returns a new file system identified by a URI.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>ResponseInputStream<GetObjectResponse></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#newInputStream(java.nio.file.Path,java.nio.file.OpenOption...)" class="member-name-link">newInputStream</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/OpenOption.html" title="class or interface in java.nio.file" class="external-link">OpenOption</a>... options)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Opens an input stream to read from the path.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><A extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/attribute/BasicFileAttributes.html" title="class or interface in java.nio.file.attribute" class="external-link">BasicFileAttributes</a>><br>A</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#readAttributes(java.nio.file.Path,java.lang.Class,java.nio.file.LinkOption...)" class="member-name-link">readAttributes</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><A> type, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/LinkOption.html" title="class or interface in java.nio.file" class="external-link">LinkOption</a>... options)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Reads a file's attributes as a bulk operation.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#readAttributes(java.nio.file.Path,java.lang.String,java.nio.file.LinkOption...)" class="member-name-link">readAttributes</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> attributes, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/LinkOption.html" title="class or interface in java.nio.file" class="external-link">LinkOption</a>... options)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Reads a set of file attributes as a bulk operation.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAttribute(java.nio.file.Path,java.lang.String,java.lang.Object,java.nio.file.LinkOption...)" class="member-name-link">setAttribute</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> attribute, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/LinkOption.html" title="class or interface in java.nio.file" class="external-link">LinkOption</a>... options)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-FileSystemProvider">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html" title="class or interface in java.nio.file.spi" class="external-link">FileSystemProvider</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#createLink(java.nio.file.Path,java.nio.file.Path)" title="class or interface in java.nio.file.spi" class="external-link">createLink</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#createSymbolicLink(java.nio.file.Path,java.nio.file.Path,java.nio.file.attribute.FileAttribute...)" title="class or interface in java.nio.file.spi" class="external-link">createSymbolicLink</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#deleteIfExists(java.nio.file.Path)" title="class or interface in java.nio.file.spi" class="external-link">deleteIfExists</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#installedProviders()" title="class or interface in java.nio.file.spi" class="external-link">installedProviders</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#newAsynchronousFileChannel(java.nio.file.Path,java.util.Set,java.util.concurrent.ExecutorService,java.nio.file.attribute.FileAttribute...)" title="class or interface in java.nio.file.spi" class="external-link">newAsynchronousFileChannel</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#newFileChannel(java.nio.file.Path,java.util.Set,java.nio.file.attribute.FileAttribute...)" title="class or interface in java.nio.file.spi" class="external-link">newFileChannel</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#newFileSystem(java.nio.file.Path,java.util.Map)" title="class or interface in java.nio.file.spi" class="external-link">newFileSystem</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#newOutputStream(java.nio.file.Path,java.nio.file.OpenOption...)" title="class or interface in java.nio.file.spi" class="external-link">newOutputStream</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#readSymbolicLink(java.nio.file.Path)" title="class or interface in java.nio.file.spi" class="external-link">readSymbolicLink</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Object">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="AWS_SECRET_ACCESS_KEY"> |
| <h3>AWS_SECRET_ACCESS_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">AWS_SECRET_ACCESS_KEY</span></div> |
| <div class="block">The property for the secret access key (password). |
| Values shall be instances of <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>. |
| If not specified, the AWS SDK default mechanism searches for the first of the following: |
| |
| <ul> |
| <li><code>AWS_SECRET_ACCESS_KEY</code> environment variable.</li> |
| <li><code>~/.aws/credentials</code> and <code>~/.aws/config</code> files.</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#newFileSystem(java.net.URI,java.util.Map)"><code>newFileSystem(URI, Map)</code></a></li> |
| <li><a href="../../../../../../constant-values.html#org.apache.sis.cloud.aws.s3.FileService.AWS_SECRET_ACCESS_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="AWS_REGION"> |
| <h3>AWS_REGION</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">AWS_REGION</span></div> |
| <div class="block">The property for the secret access key (password). |
| Values shall be instances of <code>Region</code>. |
| If not specified, the AWS SDK default mechanism searches for the first of the following: |
| |
| <ul> |
| <li><code>AWS_REGION</code> environment variable.</li> |
| <li><code>~/.aws/credentials</code> and <code>~/.aws/config</code> files.</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#newFileSystem(java.net.URI,java.util.Map)"><code>newFileSystem(URI, Map)</code></a></li> |
| <li><a href="../../../../../../constant-values.html#org.apache.sis.cloud.aws.s3.FileService.AWS_REGION">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SEPARATOR"> |
| <h3>SEPARATOR</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">SEPARATOR</span></div> |
| <div class="block">The property for the name-separator characters. |
| The default value is "/" for simulating Unix paths. |
| The separator must contain at least one character. |
| They usually have only one character, but longer separators are accepted. |
| The separator can contain any characters which are valid in a S3 object name.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.sis.cloud.aws.s3.FileService.SEPARATOR">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>FileService</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">FileService</span>()</div> |
| <div class="block">Creates a new provider of file systems for Amazon S3.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getScheme()"> |
| <h3>getScheme</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getScheme</span>()</div> |
| <div class="block">Returns the URI scheme that identifies this provider, which is <code>"S3"</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#getScheme()" title="class or interface in java.nio.file.spi" class="external-link">getScheme</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html" title="class or interface in java.nio.file.spi" class="external-link">FileSystemProvider</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the <code>"S3"</code> URI scheme.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newFileSystem(java.net.URI,java.util.Map)"> |
| <h3>newFileSystem</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/FileSystem.html" title="class or interface in java.nio.file" class="external-link">FileSystem</a></span> <span class="element-name">newFileSystem</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> uri, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?> properties)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Initializes and returns a new file system identified by a URI. |
| The given URI shall have the following pattern: |
| |
| <blockquote><pre>S3://accessKey@bucket/key</pre></blockquote> |
| |
| In current version all path components after <code>accessKey</code> are ignored. |
| A future version may allow finer grain control. |
| |
| <h4>Authentication</h4> |
| The access key is a kind of login (not a password). |
| The password (also called "secret access key") shall not be specified in the URI; |
| syntax like <code>accessKey:password</code> will <em>not</em> be parsed by this package. |
| Instead the password can be specified in the given map as a <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> value |
| associated to the <a href="#AWS_SECRET_ACCESS_KEY">"aws.secretAccessKey"</a> key. |
| |
| <h4>Recognized properties</h4> |
| The following properties are accepted: |
| |
| <ul> |
| <li><a href="#AWS_SECRET_ACCESS_KEY">"aws.secretAccessKey"</a> with <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> value.</li> |
| <li><a href="#AWS_REGION">"aws.region"</a> with <code>Region</code> value.</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#newFileSystem(java.net.URI,java.util.Map)" title="class or interface in java.nio.file.spi" class="external-link">newFileSystem</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html" title="class or interface in java.nio.file.spi" class="external-link">FileSystemProvider</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>uri</code> - a URI of the form <code>"s3://accessKey@bucket/key"</code>.</dd> |
| <dd><code>properties</code> - properties to configure the file system, or <code>null</code> if none.</dd> |
| <dt>Returns:</dt> |
| <dd>the new file system.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the URI or the map contains invalid values.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an I/O error occurs while creating the file system.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/FileSystemAlreadyExistsException.html" title="class or interface in java.nio.file" class="external-link">FileSystemAlreadyExistsException</a></code> - if a file system has already been created |
| for the given URI and has not yet been closed.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFileSystem(java.net.URI)"> |
| <h3>getFileSystem</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/FileSystem.html" title="class or interface in java.nio.file" class="external-link">FileSystem</a></span> <span class="element-name">getFileSystem</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> uri)</span></div> |
| <div class="block">Returns a reference to a file system that was created by the <a href="#newFileSystem(java.net.URI,java.util.Map)"><code>newFileSystem(URI, Map)</code></a> method. |
| If the file system has not been created or has been closed, |
| then this method throws <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/FileSystemNotFoundException.html" title="class or interface in java.nio.file" class="external-link"><code>FileSystemNotFoundException</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#getFileSystem(java.net.URI)" title="class or interface in java.nio.file.spi" class="external-link">getFileSystem</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html" title="class or interface in java.nio.file.spi" class="external-link">FileSystemProvider</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>uri</code> - a URI of the form <code>"s3://accessKey@bucket/key"</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>the file system previously created by <a href="#newFileSystem(java.net.URI,java.util.Map)"><code>newFileSystem(URI, Map)</code></a>.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the URI is not supported by this provider.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/FileSystemNotFoundException.html" title="class or interface in java.nio.file" class="external-link">FileSystemNotFoundException</a></code> - if the file system does not exist or has been closed.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPath(java.net.URI)"> |
| <h3>getPath</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a></span> <span class="element-name">getPath</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> uri)</span></div> |
| <div class="block">Return a <code>Path</code> object by converting the given <code>URI</code>. |
| The resulting <code>Path</code> is associated with a <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/FileSystem.html" title="class or interface in java.nio.file" class="external-link"><code>FileSystem</code></a> |
| that already exists or is constructed automatically.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#getPath(java.net.URI)" title="class or interface in java.nio.file.spi" class="external-link">getPath</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html" title="class or interface in java.nio.file.spi" class="external-link">FileSystemProvider</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>uri</code> - a URI of the form <code>"s3://accessKey@bucket/key"</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>the resulting <code>Path</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the URI is not supported by this provider.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/FileSystemNotFoundException.html" title="class or interface in java.nio.file" class="external-link">FileSystemNotFoundException</a></code> - if the file system does not exist and cannot be created automatically.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isSameFile(java.nio.file.Path,java.nio.file.Path)"> |
| <h3>isSameFile</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isSameFile</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path1, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path2)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Tests if two paths locate the same file.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#isSameFile(java.nio.file.Path,java.nio.file.Path)" title="class or interface in java.nio.file.spi" class="external-link">isSameFile</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html" title="class or interface in java.nio.file.spi" class="external-link">FileSystemProvider</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path1</code> - one path to the file.</dd> |
| <dd><code>path2</code> - the other path.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the two paths locate the same file.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an I/O error occurs.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isHidden(java.nio.file.Path)"> |
| <h3>isHidden</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isHidden</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Tells whether a file is considered hidden. |
| Current implementation always return <code>false</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#isHidden(java.nio.file.Path)" title="class or interface in java.nio.file.spi" class="external-link">isHidden</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html" title="class or interface in java.nio.file.spi" class="external-link">FileSystemProvider</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - the path to the file to test.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the file is considered hidden.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an I/O error occurs.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFileStore(java.nio.file.Path)"> |
| <h3>getFileStore</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/FileStore.html" title="class or interface in java.nio.file" class="external-link">FileStore</a></span> <span class="element-name">getFileStore</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Returns the store where a file is located.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#getFileStore(java.nio.file.Path)" title="class or interface in java.nio.file.spi" class="external-link">getFileStore</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html" title="class or interface in java.nio.file.spi" class="external-link">FileSystemProvider</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - the path to the file.</dd> |
| <dt>Returns:</dt> |
| <dd>the store where the file is stored.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an I/O error occurs.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newDirectoryStream(java.nio.file.Path,java.nio.file.DirectoryStream.Filter)"> |
| <h3>newDirectoryStream</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/DirectoryStream.html" title="class or interface in java.nio.file" class="external-link">DirectoryStream</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a>></span> <span class="element-name">newDirectoryStream</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> directory, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/DirectoryStream.Filter.html" title="class or interface in java.nio.file" class="external-link">DirectoryStream.Filter</a><? super <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a>> filter)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Opens a directory and returns a <code>DirectoryStream</code> to iterate over its entries. |
| S3 does not formally has directories. Instead directories are simulated by handling |
| the <code>'/'</code> character in a special way.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#newDirectoryStream(java.nio.file.Path,java.nio.file.DirectoryStream.Filter)" title="class or interface in java.nio.file.spi" class="external-link">newDirectoryStream</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html" title="class or interface in java.nio.file.spi" class="external-link">FileSystemProvider</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>directory</code> - the path to the directory.</dd> |
| <dd><code>filter</code> - the directory stream filter.</dd> |
| <dt>Returns:</dt> |
| <dd>a new and open stream on directory entries.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/NotDirectoryException.html" title="class or interface in java.nio.file" class="external-link">NotDirectoryException</a></code> - if the file is not a directory.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an I/O error occurs.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createDirectory(java.nio.file.Path,java.nio.file.attribute.FileAttribute...)"> |
| <h3>createDirectory</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">createDirectory</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> directory, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/attribute/FileAttribute.html" title="class or interface in java.nio.file.attribute" class="external-link">FileAttribute</a><?>... attributes)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Creates a new pseudo-directory. |
| S3 does not formally has directories, so the current operation does nothing. |
| Instead a pseudo-directory will appear after the first file or sub-directory is added in the directory.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#createDirectory(java.nio.file.Path,java.nio.file.attribute.FileAttribute...)" title="class or interface in java.nio.file.spi" class="external-link">createDirectory</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html" title="class or interface in java.nio.file.spi" class="external-link">FileSystemProvider</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>directory</code> - the directory to create.</dd> |
| <dd><code>attributes</code> - an optional list of file attributes to set when creating the directory.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an I/O error occurs or the parent directory does not exist.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="copy(java.nio.file.Path,java.nio.file.Path,java.nio.file.CopyOption...)"> |
| <h3>copy</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">copy</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> source, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> target, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/CopyOption.html" title="class or interface in java.nio.file" class="external-link">CopyOption</a>... options)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Copies a file. |
| This method is not yet supported.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#copy(java.nio.file.Path,java.nio.file.Path,java.nio.file.CopyOption...)" title="class or interface in java.nio.file.spi" class="external-link">copy</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html" title="class or interface in java.nio.file.spi" class="external-link">FileSystemProvider</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - the path to the file to copy.</dd> |
| <dd><code>target</code> - the path to the target file.</dd> |
| <dd><code>options</code> - options specifying how the copy should be done</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an I/O error occurs.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="move(java.nio.file.Path,java.nio.file.Path,java.nio.file.CopyOption...)"> |
| <h3>move</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">move</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> source, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> target, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/CopyOption.html" title="class or interface in java.nio.file" class="external-link">CopyOption</a>... options)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Copies a file. |
| This method is not yet supported.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#move(java.nio.file.Path,java.nio.file.Path,java.nio.file.CopyOption...)" title="class or interface in java.nio.file.spi" class="external-link">move</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html" title="class or interface in java.nio.file.spi" class="external-link">FileSystemProvider</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - the path to the file to move.</dd> |
| <dd><code>target</code> - the path to the target file.</dd> |
| <dd><code>options</code> - options specifying how the move should be done</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an I/O error occurs.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="delete(java.nio.file.Path)"> |
| <h3>delete</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">delete</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Deletes a file. |
| This method is not yet supported.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#delete(java.nio.file.Path)" title="class or interface in java.nio.file.spi" class="external-link">delete</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html" title="class or interface in java.nio.file.spi" class="external-link">FileSystemProvider</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - the path to the file to delete.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an I/O error occurs.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newInputStream(java.nio.file.Path,java.nio.file.OpenOption...)"> |
| <h3>newInputStream</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">ResponseInputStream<GetObjectResponse></span> <span class="element-name">newInputStream</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/OpenOption.html" title="class or interface in java.nio.file" class="external-link">OpenOption</a>... options)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Opens an input stream to read from the path. |
| It is important to close the input stream after usage for avoiding exhaustion of connection pool.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#newInputStream(java.nio.file.Path,java.nio.file.OpenOption...)" title="class or interface in java.nio.file.spi" class="external-link">newInputStream</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html" title="class or interface in java.nio.file.spi" class="external-link">FileSystemProvider</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - the path to the file to open.</dd> |
| <dd><code>options</code> - options specifying how the file is opened.</dd> |
| <dt>Returns:</dt> |
| <dd>a new input stream for the specified path.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link">UnsupportedOperationException</a></code> - if an unsupported option is specified.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an I/O error occurs.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newByteChannel(java.nio.file.Path,java.util.Set,java.nio.file.attribute.FileAttribute...)"> |
| <h3>newByteChannel</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/channels/SeekableByteChannel.html" title="class or interface in java.nio.channels" class="external-link">SeekableByteChannel</a></span> <span class="element-name">newByteChannel</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><? extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/OpenOption.html" title="class or interface in java.nio.file" class="external-link">OpenOption</a>> options, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/attribute/FileAttribute.html" title="class or interface in java.nio.file.attribute" class="external-link">FileAttribute</a><?>... attributes)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Returns a seekable byte channel to access a file.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#newByteChannel(java.nio.file.Path,java.util.Set,java.nio.file.attribute.FileAttribute...)" title="class or interface in java.nio.file.spi" class="external-link">newByteChannel</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html" title="class or interface in java.nio.file.spi" class="external-link">FileSystemProvider</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - the path to the file to open.</dd> |
| <dd><code>options</code> - options specifying how the file is opened.</dd> |
| <dd><code>attributes</code> - an optional list of file attributes to set when creating the file.</dd> |
| <dt>Returns:</dt> |
| <dd>a new seekable byte channel for the specified path.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link">UnsupportedOperationException</a></code> - if an unsupported open option is specified.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an I/O error occurs.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="checkAccess(java.nio.file.Path,java.nio.file.AccessMode...)"> |
| <h3>checkAccess</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">checkAccess</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/AccessMode.html" title="class or interface in java.nio.file" class="external-link">AccessMode</a>... modes)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Checks the existence, and optionally the accessibility, of a file.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#checkAccess(java.nio.file.Path,java.nio.file.AccessMode...)" title="class or interface in java.nio.file.spi" class="external-link">checkAccess</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html" title="class or interface in java.nio.file.spi" class="external-link">FileSystemProvider</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - the path to the file to check.</dd> |
| <dd><code>modes</code> - the access modes to check; may have zero elements.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/NoSuchFileException.html" title="class or interface in java.nio.file" class="external-link">NoSuchFileException</a></code> - if a file does not exist <i>(optional specific exception)</i>.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/AccessDeniedException.html" title="class or interface in java.nio.file" class="external-link">AccessDeniedException</a></code> - the requested access would be denied.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an I/O error occurs</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFileAttributeView(java.nio.file.Path,java.lang.Class,java.nio.file.LinkOption...)"> |
| <h3>getFileAttributeView</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><V extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/attribute/FileAttributeView.html" title="class or interface in java.nio.file.attribute" class="external-link">FileAttributeView</a>></span> <span class="return-type">V</span> <span class="element-name">getFileAttributeView</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><V> type, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/LinkOption.html" title="class or interface in java.nio.file" class="external-link">LinkOption</a>... options)</span></div> |
| <div class="block">Returns a read-only or updatable view of a set of file attributes.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#getFileAttributeView(java.nio.file.Path,java.lang.Class,java.nio.file.LinkOption...)" title="class or interface in java.nio.file.spi" class="external-link">getFileAttributeView</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html" title="class or interface in java.nio.file.spi" class="external-link">FileSystemProvider</a></code></dd> |
| <dt>Type Parameters:</dt> |
| <dd><code>V</code> - the view type.</dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - the path to the file.</dd> |
| <dd><code>type</code> - the class of the file attribute view.</dd> |
| <dd><code>options</code> - options indicating how symbolic links are handled.</dd> |
| <dt>Returns:</dt> |
| <dd>a file attribute view of the specified type, or <code>null</code> if not available.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readAttributes(java.nio.file.Path,java.lang.Class,java.nio.file.LinkOption...)"> |
| <h3>readAttributes</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><A extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/attribute/BasicFileAttributes.html" title="class or interface in java.nio.file.attribute" class="external-link">BasicFileAttributes</a>></span> <span class="return-type">A</span> <span class="element-name">readAttributes</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><A> type, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/LinkOption.html" title="class or interface in java.nio.file" class="external-link">LinkOption</a>... options)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Reads a file's attributes as a bulk operation.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#readAttributes(java.nio.file.Path,java.lang.Class,java.nio.file.LinkOption...)" title="class or interface in java.nio.file.spi" class="external-link">readAttributes</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html" title="class or interface in java.nio.file.spi" class="external-link">FileSystemProvider</a></code></dd> |
| <dt>Type Parameters:</dt> |
| <dd><code>A</code> - the <code>BasicFileAttributes</code> type.</dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - the path to the file.</dd> |
| <dd><code>type</code> - the class of the file attributes to read.</dd> |
| <dd><code>options</code> - options indicating how symbolic links are handled.</dd> |
| <dt>Returns:</dt> |
| <dd>the file attributes.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link">UnsupportedOperationException</a></code> - if attributes of the given type are not supported.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an I/O error occurs.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readAttributes(java.nio.file.Path,java.lang.String,java.nio.file.LinkOption...)"> |
| <h3>readAttributes</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></span> <span class="element-name">readAttributes</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> attributes, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/LinkOption.html" title="class or interface in java.nio.file" class="external-link">LinkOption</a>... options)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Reads a set of file attributes as a bulk operation. |
| See <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Files.html#readAttributes(java.nio.file.Path,java.lang.String,java.nio.file.LinkOption...)" title="class or interface in java.nio.file" class="external-link">NIO javadoc</a> |
| for details about the <code>attributes</code> argument.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#readAttributes(java.nio.file.Path,java.lang.String,java.nio.file.LinkOption...)" title="class or interface in java.nio.file.spi" class="external-link">readAttributes</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html" title="class or interface in java.nio.file.spi" class="external-link">FileSystemProvider</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - the path to the file.</dd> |
| <dd><code>attributes</code> - the attributes to read.</dd> |
| <dd><code>options</code> - options indicating how symbolic links are handled</dd> |
| <dt>Returns:</dt> |
| <dd>a map of the attributes returned; may be empty. The map's keys |
| are the attribute names, its values are the attribute values.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an I/O error occurs.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Files.html#readAttributes(java.nio.file.Path,java.lang.String,java.nio.file.LinkOption...)" title="class or interface in java.nio.file" class="external-link"><code>Files.readAttributes(Path, String, LinkOption...)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setAttribute(java.nio.file.Path,java.lang.String,java.lang.Object,java.nio.file.LinkOption...)"> |
| <h3>setAttribute</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setAttribute</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a> path, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> attribute, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/LinkOption.html" title="class or interface in java.nio.file" class="external-link">LinkOption</a>... options)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html#setAttribute(java.nio.file.Path,java.lang.String,java.lang.Object,java.nio.file.LinkOption...)" title="class or interface in java.nio.file.spi" class="external-link">setAttribute</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/spi/FileSystemProvider.html" title="class or interface in java.nio.file.spi" class="external-link">FileSystemProvider</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2010–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |