org.apache.paimon.rest

Class RESTTokenFileIO

java.lang.Object

org.apache.paimon.rest.RESTTokenFileIO

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, FileIO

public class RESTTokenFileIO
extends Object
implements FileIO

A FileIO to support getting token from REST Server.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigOption<Boolean>	DATA_TOKEN_ENABLED

Fields inherited from interface org.apache.paimon.fs.FileIO

LOG

Constructor Summary

Constructors

Constructor and Description
RESTTokenFileIO(RESTCatalogLoader catalogLoader, RESTCatalog catalogInstance, Identifier identifier, Path path)

Method Summary

Modifier and Type	Method and Description
void	configure(CatalogContext context) Configure by CatalogContext.
boolean	delete(Path path, boolean recursive) Delete a file.
boolean	exists(Path path) Check if exists.
FileStatus	getFileStatus(Path path) Return a file status object that represents the path.
boolean	isObjectStore()
FileStatus[]	listStatus(Path path) List the statuses of the files/directories in the given path if the path is a directory.
boolean	mkdirs(Path path) Make the given file and all non-existent parents into directories.
SeekableInputStream	newInputStream(Path path) Opens an SeekableInputStream at the indicated Path.
PositionOutputStream	newOutputStream(Path path, boolean overwrite) Opens an PositionOutputStream at the indicated Path.
boolean	rename(Path src, Path dst) Renames the file/directory src to dst.
RESTToken	validToken() Public interface to get valid token, this can be invoked by native engines to get the token and use own File System.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.paimon.fs.FileIO

checkOrMkdirs, close, copyFile, copyFiles, deleteDirectoryQuietly, deleteFilesQuietly, deleteQuietly, discoverLoaders, get, getFileSize, isDir, listDirectories, listFiles, listFilesIterative, overwriteFileUtf8, readFileUtf8, readOverwrittenFileUtf8, tryToWriteAtomic, writeFile

Field Detail

DATA_TOKEN_ENABLED

public static final ConfigOption<Boolean> DATA_TOKEN_ENABLED

Constructor Detail

RESTTokenFileIO

public RESTTokenFileIO(RESTCatalogLoader catalogLoader,
                       RESTCatalog catalogInstance,
                       Identifier identifier,
                       Path path)

Method Detail

configure

public void configure(CatalogContext context)

Description copied from interface: FileIO

Configure by CatalogContext.

Specified by:

configure in interface FileIO

newInputStream

public SeekableInputStream newInputStream(Path path)
                                   throws IOException

Description copied from interface: FileIO

Opens an SeekableInputStream at the indicated Path.

Specified by:

newInputStream in interface FileIO

Parameters:

path - the file to open

Throws:

IOException

newOutputStream

public PositionOutputStream newOutputStream(Path path,
                                            boolean overwrite)
                                     throws IOException

Description copied from interface: FileIO

Opens an PositionOutputStream at the indicated Path.

Specified by:

newOutputStream in interface FileIO

Parameters:

path - the file name to open

overwrite - if a file with this name already exists, then if true, the file will be overwritten, and if false an error will be thrown.

Throws:

IOException - Thrown, if the stream could not be opened because of an I/O, or because a file already exists at that path and the write mode indicates to not overwrite the file.

getFileStatus

public FileStatus getFileStatus(Path path)
                         throws IOException

Description copied from interface: FileIO

Return a file status object that represents the path.

Specified by:

getFileStatus in interface FileIO

Parameters:

path - The path we want information from

Returns:

a FileStatus object

Throws:

FileNotFoundException - when the path does not exist; IOException see specific implementation

IOException

listStatus

public FileStatus[] listStatus(Path path)
                        throws IOException

Description copied from interface: FileIO

List the statuses of the files/directories in the given path if the path is a directory.

Specified by:

listStatus in interface FileIO

Parameters:

path - given path

Returns:

the statuses of the files/directories in the given path

Throws:

IOException

exists

public boolean exists(Path path)
               throws IOException

Description copied from interface: FileIO

Check if exists.

Specified by:

exists in interface FileIO

Parameters:

path - source file

Throws:

IOException

delete

public boolean delete(Path path,
                      boolean recursive)
               throws IOException

Description copied from interface: FileIO

Delete a file.

Specified by:

delete in interface FileIO

Parameters:

path - the path to delete

recursive - if path is a directory and set to true, the directory is deleted else throws an exception. In case of a file the recursive can be set to either true or false

Returns:

true if delete is successful, false otherwise

Throws:

IOException

mkdirs

public boolean mkdirs(Path path)
               throws IOException

Description copied from interface: FileIO

Make the given file and all non-existent parents into directories. Has the semantics of Unix 'mkdir -p'. Existence of the directory hierarchy is not an error.

Specified by:

mkdirs in interface FileIO

Parameters:

path - the directory/directories to be created

Returns:

true if at least one new directory has been created, false otherwise

Throws:

IOException - thrown if an I/O error occurs while creating the directory

rename

public boolean rename(Path src,
                      Path dst)
               throws IOException

Description copied from interface: FileIO

Renames the file/directory src to dst.

Specified by:

rename in interface FileIO

Parameters:

src - the file/directory to rename

dst - the new name of the file/directory

Returns:

true if the renaming was successful, false otherwise

Throws:

IOException

isObjectStore

public boolean isObjectStore()

Specified by:

isObjectStore in interface FileIO

validToken

public RESTToken validToken()

Public interface to get valid token, this can be invoked by native engines to get the token and use own File System.