public interface FileServiceConfig extends Config
This is an optional object for a Web Server, that is a Web Server may or may not have a file service configured.
No values can be changed after the server has been started.
Modifier and Type | Method and Description |
---|---|
VirtualHostConfig |
addVirtualHost(String name,
String host,
String documentRoot,
String homePage)
Add a new virtual host configuration.
|
String |
getName()
Gets the file service name.
|
VirtualHostConfig |
getVirtualHost(String name)
Get a named virtual host configuration.
|
List<VirtualHostConfig> |
getVirtualHosts()
Get Virtual Hosts configured.
|
long |
getWriteTimeout()
Gets the write timeout value.
|
VirtualHostConfig |
removeVirtualHost(String name)
Remove virtual host.
|
void |
setWriteTimeout(long timeout)
Sets the write timeout.
|
String getName()
List<VirtualHostConfig> getVirtualHosts()
VirtualHostConfig getVirtualHost(String name)
name
- the virtual host nameVirtualHostConfig addVirtualHost(String name, String host, String documentRoot, String homePage) throws ConfigException
name
- virtual host namehost
- Specify the host of which the virtual host is to serve, i.e.
download.pushtechnology.com or * for alldocumentRoot
- This is the physical directory for this virtual hosthomePage
- This sets the default home page which is used with
directory browsing.ConfigException
- if unable to ad virtual hostVirtualHostConfig removeVirtualHost(String name) throws ConfigException
name
- the name of the host to removeConfigException
- if unable to removevoid setWriteTimeout(long timeout) throws ConfigException
Write timeout for serving files. This does not affect HTTP clients.
If not explicitly specified, 3 seconds is assumed.
timeout
- in millisecondsConfigException
- if unable to set write timeoutlong getWriteTimeout()
Copyright © 2022 Push Technology Ltd. All Rights Reserved.