org.noear.solon.boot.jlhttp

类 HTTPServer.VirtualHost

java.lang.Object

org.noear.solon.boot.jlhttp.HTTPServer.VirtualHost

封闭类:

HTTPServer

public static class HTTPServer.VirtualHost
extends Object

The VirtualHost class represents a virtual host in the server.

嵌套类概要

嵌套类

限定符和类型	类和说明
class	HTTPServer.VirtualHost.ContextInfo The ContextInfo class holds a single context's information.

字段概要

字段

限定符和类型	字段和说明
protected Set<String>	aliases
protected boolean	allowGeneratedIndex
protected ConcurrentMap<String,HTTPServer.VirtualHost.ContextInfo>	contexts
protected String	directoryIndex
protected HTTPServer.VirtualHost.ContextInfo	emptyContext
protected Set<String>	methods
protected String	name

构造器概要

构造器

构造器和说明
VirtualHost(String name) Constructs a VirtualHost with the given name.

方法概要

限定符和类型	方法和说明
void	addAlias(String alias) Adds an alias for this host.
void	addContext(String path, HTTPServer.ContextHandler handler, String... methods) Adds a context and its corresponding context handler to this server.
void	addContexts(Object o) Adds contexts for all methods of the given object that are annotated with the HTTPServer.Context annotation.
Set<String>	getAliases() Returns this host's aliases.
HTTPServer.VirtualHost.ContextInfo	getContext(String path) Returns the context handler for the given path.
String	getDirectoryIndex() Gets this host's directory index file.
Set<String>	getMethods() Returns all HTTP methods explicitly supported by at least one context (this may or may not include the methods with required or built-in support).
String	getName() Returns this host's name.
boolean	isAllowGeneratedIndex() Returns whether auto-generated indices are allowed.
void	setAllowGeneratedIndex(boolean allowed) Sets whether auto-generated indices are allowed.
void	setDirectoryIndex(String directoryIndex) Sets the directory index file.

从类继承的方法 java.lang.Object

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

字段详细资料

name

protected final String name

aliases

protected final Set<String> aliases

directoryIndex

protected volatile String directoryIndex

allowGeneratedIndex

protected volatile boolean allowGeneratedIndex

methods

protected final Set<String> methods

emptyContext

protected final HTTPServer.VirtualHost.ContextInfo emptyContext

contexts

protected final ConcurrentMap<String,HTTPServer.VirtualHost.ContextInfo> contexts

构造器详细资料

VirtualHost

public VirtualHost(String name)

Constructs a VirtualHost with the given name.

参数:

name - the host's name, or null if it is the default host

方法详细资料

getName

public String getName()

Returns this host's name.

返回:

this host's name, or null if it is the default host

addAlias

public void addAlias(String alias)

Adds an alias for this host.

参数:

alias - the alias

getAliases

public Set<String> getAliases()

Returns this host's aliases.

返回:

the (unmodifiable) set of aliases (which may be empty)

setDirectoryIndex

public void setDirectoryIndex(String directoryIndex)

Sets the directory index file. For every request whose URI ends with a '/' (i.e. a directory), the index file is appended to the path, and the resulting resource is served if it exists. If it does not exist, an auto-generated index for the requested directory may be served, depending on whether a generated index is allowed, otherwise an error is returned. The default directory index file is "index.html".

参数:

directoryIndex - the directory index file, or null if no index file should be used

getDirectoryIndex

public String getDirectoryIndex()

Gets this host's directory index file.

返回:

the directory index file, or null

setAllowGeneratedIndex

public void setAllowGeneratedIndex(boolean allowed)

Sets whether auto-generated indices are allowed. If false, and a directory resource is requested, an error will be returned instead.

参数:

allowed - specifies whether generated indices are allowed

isAllowGeneratedIndex

public boolean isAllowGeneratedIndex()

Returns whether auto-generated indices are allowed.

返回:

whether auto-generated indices are allowed

getMethods

public Set<String> getMethods()

Returns all HTTP methods explicitly supported by at least one context (this may or may not include the methods with required or built-in support).

返回:

all HTTP methods explicitly supported by at least one context

getContext

public HTTPServer.VirtualHost.ContextInfo getContext(String path)

Returns the context handler for the given path.

If a context is not found for the given path, the search is repeated for its parent path, and so on until a base context is found. If neither the given path nor any of its parents has a context, an empty context is returned.

参数:

path - the context's path

返回:

the context info for the given path, or an empty context if none exists

addContext

public void addContext(String path,
                       HTTPServer.ContextHandler handler,
                       String... methods)

Adds a context and its corresponding context handler to this server. Paths are normalized by removing trailing slashes (except the root).

参数:

path - the context's path (must start with '/')

handler - the context handler for the given path

methods - the HTTP methods supported by the context handler (default is "GET")

抛出:

IllegalArgumentException - if path is malformed

addContexts

public void addContexts(Object o)
                 throws IllegalArgumentException

Adds contexts for all methods of the given object that are annotated with the HTTPServer.Context annotation.

参数:

o - the object whose annotated methods are added

抛出:

IllegalArgumentException - if a Context-annotated method has an invalid signature