Package apoc.util

Class FileUtils

java.lang.Object

apoc.util.FileUtils

public class FileUtils
extends Object

Since:

22.05.16

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCESS_OUTSIDE_DIR_ERROR
static final String	ERROR_READ_FROM_FS_NOT_ALLOWED

Constructor Summary

Constructors

Constructor	Description
FileUtils()

Method Summary

Modifier and Type	Method	Description
static String	changeFileUrlIfImportDirectoryConstrained(String url, org.neo4j.graphdb.security.URLAccessChecker urlAccessChecker)
static URLStreamHandler	createURLStreamHandler(SupportedProtocols protocol)
static SupportedProtocols	from(String source)
static SupportedProtocols	from(URL url)
static String	getFileUrl(String fileName)
static CountingInputStream	getInputStreamFromBinary(byte[] urlOrBinary, String compressionAlgo)
static String	getLoadFileUrl(String fileName, org.neo4j.graphdb.security.URLAccessChecker urlAccessChecker)
static File	getLogDirectory()
static OutputStream	getOutputStream(SupportedProtocols protocol, String fileName, ExportConfig config)
static OutputStream	getOutputStream(String fileName)
static OutputStream	getOutputStream(String fileName, ExportConfig config)
static StreamConnection	getStreamConnection(SupportedProtocols protocol, String urlAddress, Map<String,Object> headers, String payload, org.neo4j.graphdb.security.URLAccessChecker urlAccessChecker)
static CountingInputStream	inputStreamFor(Object input, Map<String,Object> headers, String payload, String compressionAlgo, org.neo4j.graphdb.security.URLAccessChecker urlAccessChecker)
static boolean	isFile(String fileName)
static boolean	isImportUsingNeo4jConfig()
static SupportedProtocols	of(String name)
static StreamConnection	openHdfsInputStream(String urlAddress)
static StreamConnection	openS3InputStream(String urlAddress)
static CountingReader	readerFor(Object input, String compressionAlgo, org.neo4j.graphdb.security.URLAccessChecker urlAccessChecker)
static CountingReader	readerFor(Object input, Map<String,Object> headers, String payload, String compressionAlgo, org.neo4j.graphdb.security.URLAccessChecker urlAccessChecker)

Methods inherited from class java.lang.Object

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

Field Details

ERROR_READ_FROM_FS_NOT_ALLOWED

public static final String ERROR_READ_FROM_FS_NOT_ALLOWED

See Also:

• Constant Field Values

ACCESS_OUTSIDE_DIR_ERROR

public static final String ACCESS_OUTSIDE_DIR_ERROR

See Also:

• Constant Field Values

Constructor Details

FileUtils

public FileUtils()

Method Details

getLoadFileUrl

public static String getLoadFileUrl(String fileName,
 org.neo4j.graphdb.security.URLAccessChecker urlAccessChecker)
                             throws MalformedURLException,
org.neo4j.graphdb.security.URLAccessValidationError

Throws:

MalformedURLException

org.neo4j.graphdb.security.URLAccessValidationError

getFileUrl

public static String getFileUrl(String fileName)
                         throws MalformedURLException

Throws:

MalformedURLException

getStreamConnection

public static StreamConnection getStreamConnection(SupportedProtocols protocol,
 String urlAddress,
 Map<String,Object> headers,
 String payload,
 org.neo4j.graphdb.security.URLAccessChecker urlAccessChecker)
                                            throws IOException,
org.neo4j.graphdb.security.URLAccessValidationError,
URISyntaxException

Throws:

IOException

org.neo4j.graphdb.security.URLAccessValidationError

URISyntaxException

createURLStreamHandler

public static URLStreamHandler createURLStreamHandler(SupportedProtocols protocol)

of

public static SupportedProtocols of(String name)

from

public static SupportedProtocols from(URL url)

from

public static SupportedProtocols from(String source)

readerFor

public static CountingReader readerFor(Object input,
 String compressionAlgo,
 org.neo4j.graphdb.security.URLAccessChecker urlAccessChecker)
                                throws IOException,
URISyntaxException,
org.neo4j.graphdb.security.URLAccessValidationError

Throws:

IOException

URISyntaxException

org.neo4j.graphdb.security.URLAccessValidationError

readerFor

public static CountingReader readerFor(Object input,
 Map<String,Object> headers,
 String payload,
 String compressionAlgo,
 org.neo4j.graphdb.security.URLAccessChecker urlAccessChecker)
                                throws IOException,
URISyntaxException,
org.neo4j.graphdb.security.URLAccessValidationError

Throws:

IOException

URISyntaxException

org.neo4j.graphdb.security.URLAccessValidationError

inputStreamFor

public static CountingInputStream inputStreamFor(Object input,
 Map<String,Object> headers,
 String payload,
 String compressionAlgo,
 org.neo4j.graphdb.security.URLAccessChecker urlAccessChecker)
                                          throws IOException,
URISyntaxException,
org.neo4j.graphdb.security.URLAccessValidationError

Throws:

IOException

URISyntaxException

org.neo4j.graphdb.security.URLAccessValidationError

changeFileUrlIfImportDirectoryConstrained

public static String changeFileUrlIfImportDirectoryConstrained(String url,
 org.neo4j.graphdb.security.URLAccessChecker urlAccessChecker)
                                                        throws IOException,
org.neo4j.graphdb.security.URLAccessValidationError

Throws:

IOException

org.neo4j.graphdb.security.URLAccessValidationError

isFile

public static boolean isFile(String fileName)

getOutputStream

public static OutputStream getOutputStream(String fileName)

getOutputStream

public static OutputStream getOutputStream(String fileName,
 ExportConfig config)

getOutputStream

public static OutputStream getOutputStream(SupportedProtocols protocol,
 String fileName,
 ExportConfig config)

isImportUsingNeo4jConfig

public static boolean isImportUsingNeo4jConfig()

openS3InputStream

public static StreamConnection openS3InputStream(String urlAddress)
                                          throws IOException

Throws:

IOException

openHdfsInputStream

public static StreamConnection openHdfsInputStream(String urlAddress)
                                            throws IOException

Throws:

IOException

getLogDirectory

public static File getLogDirectory()

Returns:

a File pointing to Neo4j's log directory, if it exists and is readable, null otherwise.

getInputStreamFromBinary

public static CountingInputStream getInputStreamFromBinary(byte[] urlOrBinary,
 String compressionAlgo)