FileReference (extensibility-api API)

java.lang.Object
- com.delphix.masking.api.plugin.referenceType.GenericReference
- - com.delphix.masking.api.plugin.referenceType.FileReference

```
public final class FileReference
extends GenericReference
```
This class wraps a file URL reference in order to make it discoverable by the MaskingAPI via reflection.

Nested Classes
Modifier and Type	Class and Description
`static class`	`FileReference.FileReferenceType` Enumeration of file reference types based on the schema and authority in the URI

Constructors
Constructor and Description
`FileReference()`
`FileReference(java.lang.String uri)` Construct a reference to a file.

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkValid()` Test whether an algorithm reference is syntactically valid.
`java.lang.String`	`getValue()` Getter

Methods inherited from class com.delphix.masking.api.plugin.referenceType.GenericReference
checkOptionalReference, checkRequiredReference, setValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

public FileReference(@Nonnull
                     java.lang.String uri)

Construct a reference to a file.

Parameters:

uri - The URI of the file referenced. The valid URI formats are,

URI Format	Description
http[s]://<host>[:<port>]/<path>	To open files located on an web server.
jar://file/<filepath>	To open a file located in the algorithm jar
delphix-file://upload/<file reference id>	To open a file uploaded using masking engine's `fileUpload` endpoint
delphix-file://mount/<mountType>/<mountId>/<file path>	To open a file located on a NFS/CIFS mount server that has been mounted inside the masking engine using `mountFilesystem` endpoint.
file://<filepath>	To open a local file

Class FileReference