com.github.jlangch.venice.javainterop

Interface ILoadPaths

public interface ILoadPaths

Defines load paths for Venice.

The Venice function 'load-file' and file I/O functions can be bound to load resources from restricted paths only. Load paths are part of Venice's Sandbox to control where files can be loaded from.

Use the LoadPathsFactory for creating load paths.

See Also:

LoadPathsFactory

Method Summary

Modifier and Type	Method and Description
boolean	active()
java.io.BufferedReader	getBufferedReader(java.io.File file, java.nio.charset.Charset charset) Returns a BufferedReader for a file from the load paths
java.io.InputStream	getInputStream(java.io.File file) Returns an InputStream for a file from the load paths
java.io.OutputStream	getOutputStream(java.io.File file, java.nio.file.OpenOption... options) Returns an OutputStream for a file from the load paths
java.util.List<java.io.File>	getPaths()
boolean	isDirectoryOnLoadPath(java.io.File file, com.github.jlangch.venice.impl.util.loadpath.Access mode) Returns true if the directory exists on the load path
boolean	isOnLoadPath(java.io.File file, com.github.jlangch.venice.impl.util.loadpath.Access mode) Checks if the passed file is within the load paths.
boolean	isRegularFileOnLoadPath(java.io.File file, com.github.jlangch.venice.impl.util.loadpath.Access mode) Returns true if the regular file exists on the load path
boolean	isUnlimitedAccess()
java.nio.ByteBuffer	loadBinaryResource(java.io.File file) Loads a binary resources file from the load paths
java.lang.String	loadTextResource(java.io.File file, java.nio.charset.Charset charset) Loads a text resources file from the load paths
java.lang.String	loadVeniceFile(java.io.File file) Load a Venice script file from the load paths
java.io.File	normalize(java.io.File file) Normalizes a file regarding the load paths.

Method Detail

loadVeniceFile

java.lang.String loadVeniceFile(java.io.File file)

Load a Venice script file from the load paths

Parameters:

file - A Venice script file to load. Adds a '.venice' file extension implicitly if missing.

Returns:

The script or null if not found

loadBinaryResource

java.nio.ByteBuffer loadBinaryResource(java.io.File file)

Loads a binary resources file from the load paths

Parameters:

file - A file to load.

Returns:

The binary or null if not found

loadTextResource

java.lang.String loadTextResource(java.io.File file,
                                  java.nio.charset.Charset charset)

Loads a text resources file from the load paths

Parameters:

file - A file to load.

charset - an optional text encoding like 'UTF-8'. 'UTF-8' on passing null

Returns:

The text resource or null if not found

getInputStream

java.io.InputStream getInputStream(java.io.File file)

Returns an InputStream for a file from the load paths

Parameters:

file - A file to return an InputStream.

Returns:

The InputStream or null if not found

getBufferedReader

java.io.BufferedReader getBufferedReader(java.io.File file,
                                         java.nio.charset.Charset charset)

Returns a BufferedReader for a file from the load paths

Parameters:

file - A file to return an BufferedReader.

charset - an optional text encoding like 'UTF-8'. 'UTF-8' on passing null

Returns:

The BufferedReader or null if not found

getOutputStream

java.io.OutputStream getOutputStream(java.io.File file,
                                     java.nio.file.OpenOption... options)

Returns an OutputStream for a file from the load paths

If no options are present then this method works as if the CREATE, TRUNCATE_EXISTING, and WRITE options are present. In other words, it opens the file for writing, creating the file if it doesn't exist, or initially truncating an existing regular-file to a size of 0 if it exists.

Parameters:

file - A file to return an BufferedReader.

options - options specifying how the file is opened

Returns:

The OutputStream or null if not found

isRegularFileOnLoadPath

boolean isRegularFileOnLoadPath(java.io.File file,
                                com.github.jlangch.venice.impl.util.loadpath.Access mode)

Returns true if the regular file exists on the load path

Parameters:

file - a file

mode - an access mode: read, write, read/write

Returns:

true if the file exists on the load path

isDirectoryOnLoadPath

boolean isDirectoryOnLoadPath(java.io.File file,
                              com.github.jlangch.venice.impl.util.loadpath.Access mode)

Returns true if the directory exists on the load path

Parameters:

file - a file

mode - an access mode: read, write, read/write

Returns:

true if the file exists on the load path

isOnLoadPath

boolean isOnLoadPath(java.io.File file,
                     com.github.jlangch.venice.impl.util.loadpath.Access mode)

Checks if the passed file is within the load paths. The file must not exist though.

Parameters:

file - a file to check

mode - an access mode: read, write, read/write

Returns:

true if the file is within the load paths

normalize

java.io.File normalize(java.io.File file)

Normalizes a file regarding the load paths.

Parameters:

file - a file

Returns:

the normalized file

isUnlimitedAccess

boolean isUnlimitedAccess()

Returns:

true if the access to files is unlimited or false if the access is limited to the load paths.

getPaths

java.util.List<java.io.File> getPaths()

Returns:

the file paths associated with this ILoadPaths object

active

boolean active()

Returns:

true if load paths have been configured, else false