Interface HTTPVirtualHost
public interface HTTPVirtualHost
An HTTP Virtual Host within a file service.
- Since:
- 4.0
- 
Method SummaryModifier and TypeMethodDescriptionReturns the alias file.intReturns the compression threshold.Returns the document root directory name.Returns the error page.Returns the file service name.Returns the home page.getHost()Returns the host name.getName()Returns the virtual host name.intGet the number of requests actioned since service started.Returns the web server name.booleanisDebug()Indicates whether debug is set.booleanisMinify()Indicates whether the minify property is set.booleanisStatic()Indicates whether static.voidStart the service.voidStop the service.
- 
Method Details- 
getNameReturns the virtual host name.- Returns:
- the virtual host name
 
- 
getWebServerNameReturns the web server name.- Returns:
- the web server name
 
- 
getFileServiceNameReturns the file service name.- Returns:
- the file service name
 
- 
getHostReturns the host name.- Returns:
- the host name
 
- 
getDocumentRootReturns the document root directory name.- Returns:
- the document root directory
 
- 
getHomePageReturns the home page.- Returns:
- the home-page file name
 
- 
getErrorPageReturns the error page.- Returns:
- the error-page file name
 
- 
getAliasFileReturns the alias file.- Returns:
- the alias file name
 
- 
isDebug@Description("true if debug is set") boolean isDebug()Indicates whether debug is set.- Returns:
- true if debug is set
 
- 
isMinify@Description("true if the minify property is set") boolean isMinify()Indicates whether the minify property is set.- Returns:
- true if the minify property is set.
 
- 
isStatic@Description("true if static") boolean isStatic()Indicates whether static.- Returns:
- true if static
 
- 
getCompressionThreshold@Description("the compression threshold") int getCompressionThreshold()Returns the compression threshold.- Returns:
- the compression threshold
 
- 
stopService@Description("Stops the virtual host from processing requests") @Impact(1) void stopService()Stop the service.Stops the virtual host from processing requests. 
- 
startService@Description("Restart a previously stopped virtual host") @Impact(1) void startService()Start the service.Restart a previously stopped virtual host. 
- 
getNumberOfRequests@Description("number of requests actioned since service was started") int getNumberOfRequests()Get the number of requests actioned since service started.- Returns:
- number of requests actioned since service was started
 
 
-