Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.web.tomcat

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

All Implemented Interfaces:

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

public final class Site
extends CachedObjectIntegerKey<Site>

An HttpdTomcatSite indicates that an HttpdSite uses the Jakarta Tomcat project as its servlet engine. The servlet engine may be configured in several ways, only what is common to every type of Tomcat installation is stored in HttpdTomcatSite.

Author:

AO Industries, Inc.

See Also:

• Site
• PrivateTomcatSite

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLUMN_HTTPD_SITE_name
static final int	MINIMUM_START_JVM_DELAY	The minimum amount of time in milliseconds between Java VM starts.
static final int	MINIMUM_STOP_JVM_DELAY	The minimum amount of time in milliseconds between Java VM start and stop.

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, 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	addHttpdTomcatContext(String className, boolean cookies, boolean crossContext, PosixPath docBase, boolean override, String path, boolean privileged, boolean reloadable, boolean useNaming, String wrapperClass, int debug, PosixPath workDir, boolean serverXmlConfigured)
int	addJkMount(String path, boolean mount)
boolean	canStart()	Determines if the API user is allowed to start the Java virtual machine associated with this site.
boolean	canStop()	Determines if the API user is allowed to stop the Java virtual machine associated with this site.
boolean	getBlockWebinf()	Blocks access to /META-INF and /WEB-INF at the Apache level.
protected Object	getColumnImpl(int i)
Site	getHttpdJbossSite()
Site	getHttpdSite()
Context	getHttpdTomcatContext(String path)
List<Context>	getHttpdTomcatContexts()
SharedTomcatSite	getHttpdTomcatSharedSite()
PrivateTomcatSite	getHttpdTomcatStdSite()
Version	getHttpdTomcatVersion()
List<Worker>	getHttpdWorkers()
List<JkMount>	getJkMounts()
Table.TableId	getTableId()
void	init(ResultSet result)	Initializes this object from the raw database contents.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	setBlockWebinf(boolean blockWebinf)
String	startJvm()
String	stopJvm()
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_HTTPD_SITE_name

public static final String COLUMN_HTTPD_SITE_name

See Also:

• Constant Field Values

MINIMUM_START_JVM_DELAY

public static final int MINIMUM_START_JVM_DELAY

The minimum amount of time in milliseconds between Java VM starts.

See Also:

• Constant Field Values

MINIMUM_STOP_JVM_DELAY

public static final int MINIMUM_STOP_JVM_DELAY

The minimum amount of time in milliseconds between Java VM start and stop.

See Also:

• Constant Field Values

Constructor Details

Site

@Deprecated(forRemoval=true)
public Site()

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

addHttpdTomcatContext

public int addHttpdTomcatContext(String className,
 boolean cookies,
 boolean crossContext,
 PosixPath docBase,
 boolean override,
 String path,
 boolean privileged,
 boolean reloadable,
 boolean useNaming,
 String wrapperClass,
 int debug,
 PosixPath workDir,
 boolean serverXmlConfigured)
                          throws IOException,
SQLException

Throws:

IOException

SQLException

addJkMount

public int addJkMount(String path,
 boolean mount)
               throws IOException,
SQLException

Throws:

IOException

SQLException

canStop

public boolean canStop()
                throws SQLException,
IOException

Determines if the API user is allowed to stop the Java virtual machine associated with this site.

Throws:

SQLException

IOException

canStart

public boolean canStart()
                 throws SQLException,
IOException

Determines if the API user is allowed to start the Java virtual machine associated with this site.

Throws:

SQLException

IOException

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,Site>

getHttpdJbossSite

public Site getHttpdJbossSite()
                       throws SQLException,
IOException

Throws:

SQLException

IOException

getHttpdSite

public Site getHttpdSite()
                  throws SQLException,
IOException

Throws:

SQLException

IOException

getHttpdTomcatContext

public Context getHttpdTomcatContext(String path)
                              throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdTomcatContexts

public List<Context> getHttpdTomcatContexts()
                                     throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdTomcatSharedSite

public SharedTomcatSite getHttpdTomcatSharedSite()
                                          throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdTomcatStdSite

public PrivateTomcatSite getHttpdTomcatStdSite()
                                        throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdTomcatVersion

public Version getHttpdTomcatVersion()
                              throws SQLException,
IOException

Throws:

SQLException

IOException

getHttpdWorkers

public List<Worker> getHttpdWorkers()
                             throws IOException,
SQLException

Throws:

IOException

SQLException

getJkMounts

public List<JkMount> getJkMounts()
                          throws IOException,
SQLException

Throws:

IOException

SQLException

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,Site>

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

startJvm

public String startJvm()
                throws IOException,
SQLException

Throws:

IOException

SQLException

stopJvm

public String stopJvm()
               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

getBlockWebinf

public boolean getBlockWebinf()

Blocks access to /META-INF and /WEB-INF at the Apache level. When Apache serves content directly, instead of passing all requests to Tomcat, this helps ensure proper protection of these paths.

setBlockWebinf

public void setBlockWebinf(boolean blockWebinf)
                    throws IOException,
SQLException

Throws:

IOException

SQLException

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