io.knotx.repository.fs

Class FilesystemRepositoryOptions

java.lang.Object

io.knotx.repository.fs.FilesystemRepositoryOptions

public class FilesystemRepositoryOptions
extends Object

Describes a file system repository configuration

Field Summary

Fields

Modifier and Type	Field and Description
String	DEFAULT_ADDRESS Default EB address of the file system repository verticle
String	DEFAULT_CATALOGUE Default root folder of the filesystem repository

Constructor Summary

Constructors

Constructor and Description
FilesystemRepositoryOptions() Default constructor
FilesystemRepositoryOptions(FilesystemRepositoryOptions other) Copy constructor
FilesystemRepositoryOptions(io.vertx.core.json.JsonObject json) Create an settings from JSON

Method Summary

Modifier and Type	Method and Description
String	getAddress()
String	getCatalogue()
FilesystemRepositoryOptions	setAddress(String address) Set the EB address of the file system repository verticle
FilesystemRepositoryOptions	setCatalogue(String catalogue) Set the root folder of the repository on file system.
io.vertx.core.json.JsonObject	toJson() Convert to JSON

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ADDRESS

public final String DEFAULT_ADDRESS

Default EB address of the file system repository verticle

See Also:

Constant Field Values

DEFAULT_CATALOGUE

public final String DEFAULT_CATALOGUE

Default root folder of the filesystem repository

See Also:

Constant Field Values

Constructor Detail

FilesystemRepositoryOptions

public FilesystemRepositoryOptions()

Default constructor

FilesystemRepositoryOptions

public FilesystemRepositoryOptions(FilesystemRepositoryOptions other)

Copy constructor

Parameters:

other - the instance to copy

FilesystemRepositoryOptions

public FilesystemRepositoryOptions(io.vertx.core.json.JsonObject json)

Create an settings from JSON

Parameters:

json - the JSON

Method Detail

toJson

public io.vertx.core.json.JsonObject toJson()

Convert to JSON

Returns:

the JSON

getAddress

public String getAddress()

Returns:

EB address of the verticle

setAddress

public FilesystemRepositoryOptions setAddress(String address)

Set the EB address of the file system repository verticle

Parameters:

address - an EB address of the verticle

Returns:

a reference to this, so the API can be used fluently

getCatalogue

public String getCatalogue()

Returns:

Root folder of the files on filesystem repository

setCatalogue

public FilesystemRepositoryOptions setCatalogue(String catalogue)

Set the root folder of the repository on file system. If catalogue equals empty string a verticle will look for the files in classpath

Parameters:

catalogue - a root path to the repository files

Returns:

a reference to this, so the API can be used fluently