Module com.aoapps.servlet.firewall.virtualhosts

Package com.aoapps.servlet.firewall.virtualhosts

Class Environment

java.lang.Object

com.aoapps.servlet.firewall.virtualhosts.Environment

public class Environment
extends Object

An Environment is a mapping between partial URLs and virtual hosts.

Method Summary

Modifier and Type	Method	Description
Environment	add(DomainName domain, PartialURL... partialUrls)	Adds new mappings to this environment.
Environment	add(DomainName domain, Iterable<? extends PartialURL> partialUrls)	Adds new mappings to this environment.
Environment	add(Map<? extends PartialURL,? extends DomainName> newMappings)	Adds new mappings to this environment.
VirtualHostManager	getManager()
String	getName()	Gets the unique name of this environment.
Set<PartialURL>	getPartialURLs(DomainName domain)	Gets an unmodifiable copy of all the partial URLs registered for a given virtual host.
PartialURL	getPrimary(DomainName domain)	Gets the primary partial URL for the given virtual host.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

toString

public String toString()

Overrides:

toString in class Object

getManager

public VirtualHostManager getManager()

getName

public String getName()

Gets the unique name of this environment.

add

public Environment add(Map<? extends PartialURL,? extends DomainName> newMappings)

Adds new mappings to this environment. All virtual hosts referenced by the environment must already exist.

Throws:

IllegalStateException - If the virtual host does not exist or the environment already contains any of the new partial URLs.

See Also:

• VirtualHostManager.getVirtualHost(com.aoapps.net.DomainName)
• VirtualHostManager.addSearchOrder(com.aoapps.net.partialurl.PartialURL, com.aoapps.servlet.firewall.virtualhosts.Environment, com.aoapps.net.DomainName)

add

public Environment add(DomainName domain,
 Iterable<? extends PartialURL> partialUrls)
                throws IllegalArgumentException,
IllegalStateException

Adds new mappings to this environment.

Parameters:

domain - The virtual host must already exist.

partialUrls - May not be empty. Duplicate values are not OK. The first partial URL for a given domain is the primary.

Throws:

IllegalArgumentException - when partialURLs contains duplicate values

IllegalStateException - If the virtual host does not exist or the environment already contains any of the new partial URLs.

See Also:

• VirtualHostManager.getVirtualHost(com.aoapps.net.DomainName)

add

public Environment add(DomainName domain,
 PartialURL... partialUrls)
                throws IllegalArgumentException,
IllegalStateException

Adds new mappings to this environment.

Parameters:

domain - The virtual host must already exist.

partialUrls - May not be empty. Duplicate values are not OK. The first partial URL for a given domain is the primary.

Throws:

IllegalArgumentException - when partialURLs contains duplicate values

IllegalStateException - If the virtual host does not exist or the environment already contains any of the new partial URLs.

See Also:

• VirtualHostManager.getVirtualHost(com.aoapps.net.DomainName)

getPrimary

public PartialURL getPrimary(DomainName domain)

Gets the primary partial URL for the given virtual host. This is the same as the first partial URL from getPartialURLs(com.aoapps.net.DomainName).

Returns:

the primary partial URL or null when the virtual host has not been added to this environment.

See Also:

• getPartialURLs(com.aoapps.net.DomainName)

getPartialURLs

public Set<PartialURL> getPartialURLs(DomainName domain)

Gets an unmodifiable copy of all the partial URLs registered for a given virtual host. The first partial URL is the primary.

Returns:

the set of partial URLs or an empty set when the virtual host has not been added to this environment.