Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.web

Class VirtualHost

java.lang.Object

com.aoindustries.aoserv.client.AoservObject<Integer,VirtualHost>

com.aoindustries.aoserv.client.CachedObject<Integer,VirtualHost>

com.aoindustries.aoserv.client.CachedObjectIntegerKey<VirtualHost>

com.aoindustries.aoserv.client.web.VirtualHost

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, Row, AoservReadable, AoservStreamable, AoservWritable, Disablable, SingleTableObject<Integer,VirtualHost>

public final class VirtualHost
extends CachedObjectIntegerKey<VirtualHost>
implements Disablable

Author:

AO Industries, Inc.

See Also:

• Site

Field Summary

Fields inherited from class com.aoindustries.aoserv.client.CachedObjectIntegerKey

pkey

Fields inherited from class com.aoindustries.aoserv.client.CachedObject

table

Fields inherited from class com.aoindustries.aoserv.client.AoservObject

USE_ARRAY_OF_DOMAIN, USE_SQL_DATA, USE_SQL_DATA_WRITE

Constructor Summary

Constructors

Constructor	Description
VirtualHost()	Deprecated, for removal: This API element is subject to removal in a future version. Only required for implementation, do not use directly.

Method Summary

Modifier and Type	Method	Description
int	addVirtualHostName(DomainName hostname)
boolean	canDisable()
boolean	canEnable()
void	disable(DisableLog dl)
void	enable()
PosixPath	getAccessLog()
List<VirtualHostName>	getAltVirtualHostNames()
Certificate	getCertificate()	Gets the SSL certificate for this server.
protected Object	getColumnImpl(int i)
DisableLog	getDisableLog()
PosixPath	getErrorLog()
HttpdBind	getHttpdBind()
Site	getHttpdSite()
List<Header>	getHttpdSiteBindHeaders()
String	getIncludeSiteConfig()	Controls whether this bind includes the per-site configuration file.
String	getName()	Gets the name of the bind.
String	getPredisableConfig()
VirtualHostName	getPrimaryVirtualHostName()
boolean	getRedirectToPrimaryHostname()
List<RewriteRule>	getRewriteRules()
String	getSystemdEscapedName()	Gets the systemd-encoded name of the bind.
Table.TableId	getTableId()
List<VirtualHostName>	getVirtualHostNames()
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isDisabled()	Checks if this object is disabled.
boolean	isManual()
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	setIsManual(boolean isManual)
void	setPredisableConfig(String config)
void	setRedirectToPrimaryHostname(boolean redirectToPrimaryHostname)
String	toStringImpl()	AoservObject.toString() implementation that is allowed to throw exceptions.
void	write(StreamableOutput out, AoservProtocol.Version protocolVersion)

Methods inherited from class com.aoindustries.aoserv.client.CachedObjectIntegerKey

equals, getKey, getPkey, hashCode

Methods inherited from class com.aoindustries.aoserv.client.CachedObject

getTable, setTable

Methods inherited from class com.aoindustries.aoserv.client.AoservObject

compare, compare, compare, compare, compareIgnoreCaseConsistentWithEquals, compareTo, compareTo, compareTo, getAccountingCode, getColumn, getColumns, getColumns, getDomainLabel, getDomainLabels, getDomainName, getDto, getEmail, getGecos, getGroupId, getHashedKey, getHashedPassword, getHostname, getInetAddress, getLinuxId, getLinuxUserName, getMacAddress, getMysqlDatabaseName, getMysqlServerName, getMysqlUserName, getPort, getPostgresDatabaseName, getPostgresServerName, getPostgresUserId, getTableSchema, getTimeMillis, getTimeMillis, getUnixPath, getUserId, read, toString, write

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

VirtualHost

@Deprecated(forRemoval=true)
public VirtualHost()

Deprecated, for removal: This API element is subject to removal in a future version.

Only required for implementation, do not use directly.

See Also:

• init(java.sql.ResultSet)
• read(com.aoapps.hodgepodge.io.stream.StreamableInput, com.aoindustries.aoserv.client.schema.AoservProtocol.Version)

Method Details

toStringImpl

public String toStringImpl()
                    throws SQLException,
IOException

Description copied from class: AoservObject

AoservObject.toString() implementation that is allowed to throw exceptions.

Implementation Note:
This default implementation calls AoservObject.toString() on the key (from AoservObject.getKey()). When the key is null, uses the default implementation from Object.toString().

Overrides:

toStringImpl in class CachedObjectIntegerKey<VirtualHost>

Throws:

SQLException

IOException

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,VirtualHost>

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,VirtualHost>

init

public void init(ResultSet result)
          throws SQLException

Description copied from class: AoservObject

Initializes this object from the raw database contents.

Specified by:

init in class AoservObject<Integer,VirtualHost>

Parameters:

result - the ResultSet containing the row to copy into this object

Throws:

SQLException

read

public void read(StreamableInput in,
 AoservProtocol.Version protocolVersion)
          throws IOException

Specified by:

read in interface AoservReadable

Specified by:

read in interface AoservStreamable

Specified by:

read in class AoservObject<Integer,VirtualHost>

Throws:

IOException

write

public void write(StreamableOutput out,
 AoservProtocol.Version protocolVersion)
           throws IOException

Specified by:

write in interface AoservStreamable

Specified by:

write in interface AoservWritable

Specified by:

write in class AoservObject<Integer,VirtualHost>

Throws:

IOException

getHttpdSite

public Site getHttpdSite()
                  throws SQLException,
IOException

Throws:

SQLException

IOException

getHttpdBind

public HttpdBind getHttpdBind()
                       throws SQLException,
IOException

Throws:

SQLException

IOException

getName

public String getName()

Gets the name of the bind. The default per-(site, ip, bind) has a null name. Additional binds per (site, ip, bind) will have non-empty names. The name is unique per (site, ip, bind), including only one default bind.

See Also:

• getSystemdEscapedName()

getSystemdEscapedName

public String getSystemdEscapedName()

Gets the systemd-encoded name of the bind.

See Also:

• getName()
• SystemdUtil.encode(java.lang.String)

getAccessLog

public PosixPath getAccessLog()

getErrorLog

public PosixPath getErrorLog()

getCertificate

public Certificate getCertificate()
                           throws SQLException,
IOException

Gets the SSL certificate for this server.

Returns:

the SSL certificate or null when filtered or not applicable

Throws:

SQLException

IOException

getDisableLog

public DisableLog getDisableLog()
                         throws SQLException,
IOException

Specified by:

getDisableLog in interface Disablable

Throws:

SQLException

IOException

isDisabled

public boolean isDisabled()

Description copied from interface: Disablable

Checks if this object is disabled. This should execute very quickly (not incur any round-trip to any database) and thus does not throw any checked exceptions.

Specified by:

isDisabled in interface Disablable

canDisable

public boolean canDisable()

Specified by:

canDisable in interface Disablable

canEnable

public boolean canEnable()
                  throws SQLException,
IOException

Specified by:

canEnable in interface Disablable

Throws:

SQLException

IOException

disable

public void disable(DisableLog dl)
             throws IOException,
SQLException

Specified by:

disable in interface Disablable

Throws:

IOException

SQLException

enable

public void enable()
            throws IOException,
SQLException

Specified by:

enable in interface Disablable

Throws:

IOException

SQLException

getPredisableConfig

public String getPredisableConfig()

setPredisableConfig

public void setPredisableConfig(String config)
                         throws IOException,
SQLException

Throws:

IOException

SQLException

isManual

public boolean isManual()

setIsManual

public void setIsManual(boolean isManual)
                 throws IOException,
SQLException

Throws:

IOException

SQLException

getRedirectToPrimaryHostname

public boolean getRedirectToPrimaryHostname()

setRedirectToPrimaryHostname

public void setRedirectToPrimaryHostname(boolean redirectToPrimaryHostname)
                                  throws IOException,
SQLException

Throws:

IOException

SQLException

getIncludeSiteConfig

public String getIncludeSiteConfig()

Controls whether this bind includes the per-site configuration file. Will be one of:

• null - Automatic mode
• "true" - Include manually enabled
• "false" - Include manually disabled
• "IfModule <module_name>" - Include when a module is enabled
• "IfModule !<module_name>" - Include when a module is disabled
• Any future unrecognized value should be treated as equivalent to null (automatic mode)

getVirtualHostNames

public List<VirtualHostName> getVirtualHostNames()
                                          throws IOException,
SQLException

Throws:

IOException

SQLException

getPrimaryVirtualHostName

public VirtualHostName getPrimaryVirtualHostName()
                                          throws SQLException,
IOException

Throws:

SQLException

IOException

getAltVirtualHostNames

public List<VirtualHostName> getAltVirtualHostNames()
                                             throws IOException,
SQLException

Throws:

IOException

SQLException

addVirtualHostName

public int addVirtualHostName(DomainName hostname)
                       throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdSiteBindHeaders

public List<Header> getHttpdSiteBindHeaders()
                                     throws IOException,
SQLException

Throws:

IOException

SQLException

getRewriteRules

public List<RewriteRule> getRewriteRules()
                                  throws IOException,
SQLException

Throws:

IOException

SQLException