Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.web

Class Site

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.web.Site

All Implemented Interfaces:

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

public final class Site
extends CachedObjectIntegerKey<Site>
implements Disablable, Removable

An HttpdSite is one unique set of web content and resides in its own directory under /www. Each HttpdSite has a unique name per server, and may be served simultaneously on any number of HttpdBinds through any number of HttpdServers.

An HttpdSite only stores the information that is common to all site types. The site will always reference one, and only one, other type of entry, indicating the type of site and providing the rest of the information about the site.

Author:

AO Industries, Inc.

See Also:

• VirtualHost
• HttpdBind
• HttpdServer
• StaticSite
• Site

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLUMN_AO_SERVER_name
static final String	COLUMN_NAME_name
static final String	DISABLED	The site name used when an account is disabled.
static final int	MAX_NAME_LENGTH

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
Site()	Deprecated. Only required for implementation, do not use directly.

Method Summary

Modifier and Type	Method	Description
int	addHttpdSiteAuthenticatedLocation(String path, boolean isRegularExpression, String authName, PosixPath authGroupFile, PosixPath authUserFile, String require, String handler)
boolean	canDisable()
boolean	canEnable()
void	disable(DisableLog dl)
void	enable()
int	getAoServer_server_pkey()
void	getAwstatsFile(String path, String queryString, OutputStream out)
String	getAwstatsSkipFiles()
boolean	getBlockCoreDumps()	Added httpd_sites.block_core_dumps column, which enables blocking of core dumps.
boolean	getBlockEditorBackups()	Enables blocking filename patterns associated with editor automatic backups.
boolean	getBlockScm()	Enables the blocking of URL patterns associated with source control management systems.
boolean	getBlockTraceTrack()	Enables the blocking of TRACE and TRACK HTTP methods.
List<CannotRemoveReason<?>>	getCannotRemoveReasons()	Lists the reasons an object may not be removed.
protected Object	getColumnImpl(int i)
DisableLog	getDisableLog()
Integer	getDisableLog_pkey()
boolean	getEnableAnonymousFtp()
boolean	getEnableCgi()
boolean	getEnableFollowSymlinks()
boolean	getEnableHtaccess()
boolean	getEnableIndexes()
boolean	getEnableSsi()
List<Location>	getHttpdSiteAuthenticatedLocations()
List<VirtualHost>	getHttpdSiteBinds()
List<VirtualHost>	getHttpdSiteBinds(HttpdServer server)
StaticSite	getHttpdStaticSite()
Site	getHttpdTomcatSite()
int	getId()
PosixPath	getInstallDirectory()	Gets the directory where this site is installed.
User.Name	getLinuxAccount_username()
Group.Name	getLinuxGroup_name()
Server	getLinuxServer()
UserServer	getLinuxServerAccount()
GroupServer	getLinuxServerGroup()
boolean	getListFirst()
String	getName()
Package	getPackage()
Account.Name	getPackage_name()
SoftwareVersion	getPhpVersion()
Integer	getPhpVersion_pkey()
VirtualHostName	getPrimaryVirtualHostName()
Email	getServerAdmin()
Table.TableId	getTableId()
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isDisabled()	Checks if this object is disabled.
boolean	isManual()
static boolean	isValidSiteName(String name)	Checks the format of the name of the site, as used in the /www directory.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	remove()	Removes this object, and all dependant objects, from the system.
void	setBlockCoreDumps(boolean blockCoreDumps)
void	setBlockEditorBackups(boolean blockEditorBackups)
void	setBlockScm(boolean blockScm)
void	setBlockTraceTrack(boolean blockTraceTrack)
void	setEnableAnonymousFtp(boolean enableAnonymousFtp)
void	setEnableCgi(boolean enableCgi)
void	setEnableFollowSymlinks(boolean enableFollowSymlinks)
void	setEnableHtaccess(boolean enableHtaccess)
void	setEnableIndexes(boolean enableIndexes)
void	setEnableSsi(boolean enableSsi)
void	setIsManual(boolean isManual)
void	setPhpVersion(SoftwareVersion phpVersion)
void	setServerAdmin(Email address)
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

Field Details

COLUMN_NAME_name

public static final String COLUMN_NAME_name

See Also:

• Constant Field Values

COLUMN_AO_SERVER_name

public static final String COLUMN_AO_SERVER_name

See Also:

• Constant Field Values

MAX_NAME_LENGTH

public static final int MAX_NAME_LENGTH

See Also:

• Constant Field Values

DISABLED

public static final String DISABLED

The site name used when an account is disabled.

See Also:

• Constant Field Values

Constructor Details

Site

@Deprecated
public Site()

Deprecated.

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

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,Site>

getId

public int getId()

getAoServer_server_pkey

public int getAoServer_server_pkey()

getLinuxServer

public Server getLinuxServer()
                      throws SQLException,
IOException

Throws:

SQLException

IOException

getName

public String getName()

getListFirst

public boolean getListFirst()

getPackage_name

public Account.Name getPackage_name()

getPackage

public Package getPackage()
                   throws SQLException,
IOException

Throws:

SQLException

IOException

getLinuxAccount_username

public User.Name getLinuxAccount_username()

getLinuxServerAccount

public UserServer getLinuxServerAccount()
                                 throws SQLException,
IOException

Throws:

SQLException

IOException

getLinuxGroup_name

public Group.Name getLinuxGroup_name()

getLinuxServerGroup

public GroupServer getLinuxServerGroup()
                                throws SQLException,
IOException

Throws:

SQLException

IOException

getServerAdmin

public Email getServerAdmin()

getDisableLog_pkey

public Integer getDisableLog_pkey()

getDisableLog

public DisableLog getDisableLog()
                         throws SQLException,
IOException

Specified by:

getDisableLog in interface Disablable

Throws:

SQLException

IOException

isManual

public boolean isManual()

getAwstatsSkipFiles

public String getAwstatsSkipFiles()

getPhpVersion_pkey

public Integer getPhpVersion_pkey()

getPhpVersion

public SoftwareVersion getPhpVersion()
                              throws IOException,
SQLException

Throws:

IOException

SQLException

getEnableCgi

public boolean getEnableCgi()

getEnableSsi

public boolean getEnableSsi()

getEnableHtaccess

public boolean getEnableHtaccess()

getEnableIndexes

public boolean getEnableIndexes()

getEnableFollowSymlinks

public boolean getEnableFollowSymlinks()

getEnableAnonymousFtp

public boolean getEnableAnonymousFtp()

getBlockTraceTrack

public boolean getBlockTraceTrack()

Enables the blocking of TRACE and TRACK HTTP methods.

getBlockScm

public boolean getBlockScm()

Enables the blocking of URL patterns associated with source control management systems. It is possible for SCM files, such as CVS/Root and .git/config to have authentication credentials. Leave this enabled when pulling web root content directly from revision control systems. Currently has protections for CVS, Subversion, and Git.

getBlockCoreDumps

public boolean getBlockCoreDumps()

Added httpd_sites.block_core_dumps column, which enables blocking of core dumps. Core dumps could potentially expose sensitive information and have predictable filename patterns.

getBlockEditorBackups

public boolean getBlockEditorBackups()

Enables blocking filename patterns associated with editor automatic backups. Without this protection, it is possible for source code to be leaked by accessing the URL associated with the automatic backups. Currently has protections for Emacs and Vim.

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

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

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

Throws:

IOException

addHttpdSiteAuthenticatedLocation

public int addHttpdSiteAuthenticatedLocation(String path,
 boolean isRegularExpression,
 String authName,
 PosixPath authGroupFile,
 PosixPath authUserFile,
 String require,
 String handler)
                                      throws IOException,
SQLException

Throws:

IOException

SQLException

canDisable

public boolean canDisable()
                   throws IOException,
SQLException

Specified by:

canDisable in interface Disablable

Throws:

IOException

SQLException

canEnable

public boolean canEnable()
                  throws SQLException,
IOException

Specified by:

canEnable in interface Disablable

Throws:

SQLException

IOException

getCannotRemoveReasons

public List<CannotRemoveReason<?>> getCannotRemoveReasons()

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

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

getInstallDirectory

public PosixPath getInstallDirectory()
                              throws SQLException,
IOException

Gets the directory where this site is installed.

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

getHttpdSiteAuthenticatedLocations

public List<Location> getHttpdSiteAuthenticatedLocations()
                                                  throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdSiteBinds

public List<VirtualHost> getHttpdSiteBinds()
                                    throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdSiteBinds

public List<VirtualHost> getHttpdSiteBinds(HttpdServer server)
                                    throws SQLException,
IOException

Throws:

SQLException

IOException

getHttpdStaticSite

public StaticSite getHttpdStaticSite()
                              throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdTomcatSite

public Site getHttpdTomcatSite()
                        throws IOException,
SQLException

Throws:

IOException

SQLException

getPrimaryVirtualHostName

public VirtualHostName getPrimaryVirtualHostName()
                                          throws SQLException,
IOException

Throws:

SQLException

IOException

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,Site>

isValidSiteName

public static boolean isValidSiteName(String name)

Checks the format of the name of the site, as used in the /www directory. The site name must be 255 characters or less, and comprised of only a-z, 0-9, . or -. The first character must be a-z or 0-9.

Note: This matches the check constraint on the httpd_sites table. Note: This matches keepWwwDirs in HttpdSiteManager.

TODO: Self-validating type for site names (Build on PosixPortableFilename, once it exists?)

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

setIsManual

public void setIsManual(boolean isManual)
                 throws IOException,
SQLException

Throws:

IOException

SQLException

setServerAdmin

public void setServerAdmin(Email address)
                    throws IOException,
SQLException

Throws:

IOException

SQLException

setPhpVersion

public void setPhpVersion(SoftwareVersion phpVersion)
                   throws IOException,
SQLException

Throws:

IOException

SQLException

setEnableCgi

public void setEnableCgi(boolean enableCgi)
                  throws IOException,
SQLException

Throws:

IOException

SQLException

setEnableSsi

public void setEnableSsi(boolean enableSsi)
                  throws IOException,
SQLException

Throws:

IOException

SQLException

setEnableHtaccess

public void setEnableHtaccess(boolean enableHtaccess)
                       throws IOException,
SQLException

Throws:

IOException

SQLException

setEnableIndexes

public void setEnableIndexes(boolean enableIndexes)
                      throws IOException,
SQLException

Throws:

IOException

SQLException

setEnableFollowSymlinks

public void setEnableFollowSymlinks(boolean enableFollowSymlinks)
                             throws IOException,
SQLException

Throws:

IOException

SQLException

setEnableAnonymousFtp

public void setEnableAnonymousFtp(boolean enableAnonymousFtp)
                           throws IOException,
SQLException

Throws:

IOException

SQLException

setBlockTraceTrack

public void setBlockTraceTrack(boolean blockTraceTrack)
                        throws IOException,
SQLException

Throws:

IOException

SQLException

setBlockScm

public void setBlockScm(boolean blockScm)
                 throws IOException,
SQLException

Throws:

IOException

SQLException

setBlockCoreDumps

public void setBlockCoreDumps(boolean blockCoreDumps)
                       throws IOException,
SQLException

Throws:

IOException

SQLException

setBlockEditorBackups

public void setBlockEditorBackups(boolean blockEditorBackups)
                           throws IOException,
SQLException

Throws:

IOException

SQLException

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

Throws:

SQLException

IOException

getAwstatsFile

public void getAwstatsFile(String path,
 String queryString,
 OutputStream out)
                    throws IOException,
SQLException

Throws:

IOException

SQLException