Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.web

Class VirtualHostName

java.lang.Object

com.aoindustries.aoserv.client.AOServObject<K,T>

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

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

com.aoindustries.aoserv.client.web.VirtualHostName

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, Row, AOServReadable, AOServStreamable, AOServWritable, Removable, SingleTableObject<Integer,VirtualHostName>

public final class VirtualHostName
extends CachedObjectIntegerKey<VirtualHostName>
implements Removable

Multiple HttpdSiteURLs may be attached to a unique combination of HttpdSite and HttpdBind, represented by an HttpdSiteBind. This allows a web site to respond to several different hostnames on the same IP/port combination.

Author:

AO Industries, Inc.

See Also:

VirtualHost, Site, HttpdBind

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
VirtualHostName()

Method Summary

Modifier and Type	Method	Description
List<CannotRemoveReason<VirtualHostName>>	getCannotRemoveReasons()	Lists the reasons an object may not be removed.
protected Object	getColumnImpl(int i)
DomainName	getHostname()
VirtualHost	getHttpdSiteBind()
Table.TableID	getTableID()
String	getURL()
String	getURLNoSlash()
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isPrimary()	TODO: "Primary Hostname" to "Canonical Hostname" across the AO system.
boolean	isTestURL()
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	remove()	Removes this object, and all dependant objects, from the system.
void	setAsPrimary()
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 Detail

VirtualHostName

public VirtualHostName()

Method Detail

getCannotRemoveReasons

public List<CannotRemoveReason<VirtualHostName>> getCannotRemoveReasons()
                                                                 throws SQLException,
                                                                        IOException

Description copied from interface: Removable

Lists the reasons an object may not be removed.

Specified by:

getCannotRemoveReasons in interface Removable

Returns:

an empty List<CannotRemoveReason> if this object may be removed, or a list of descriptions

Throws:

SQLException

IOException

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AOServObject<Integer,VirtualHostName>

getHostname

public DomainName getHostname()

getHttpdSiteBind

public VirtualHost getHttpdSiteBind()
                             throws SQLException,
                                    IOException

Throws:

SQLException

IOException

getTableID

public Table.TableID getTableID()

Specified by:

getTableID in class AOServObject<Integer,VirtualHostName>

getURL

public String getURL()
              throws SQLException,
                     IOException

Throws:

SQLException

IOException

getURLNoSlash

public String getURLNoSlash()
                     throws SQLException,
                            IOException

Throws:

SQLException

IOException

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,VirtualHostName>

Parameters:

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

Throws:

SQLException

isPrimary

public boolean isPrimary()

TODO: "Primary Hostname" to "Canonical Hostname" across the AO system.

isTestURL

public boolean isTestURL()
                  throws SQLException,
                         IOException

Throws:

SQLException

IOException

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,VirtualHostName>

Throws:

IOException

remove

public void remove()
            throws IOException,
                   SQLException

Description copied from interface: Removable

Removes this object, and all dependant objects, from the system.

Specified by:

remove in interface Removable

Throws:

IOException

SQLException

setAsPrimary

public void setAsPrimary()
                  throws IOException,
                         SQLException

Throws:

IOException

SQLException

toStringImpl

public String toStringImpl()

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<VirtualHostName>

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,VirtualHostName>

Throws:

IOException