Module com.aoindustries.aoserv.client

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

Class Context

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.web.tomcat.Context

All Implemented Interfaces:

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

public final class Context
extends CachedObjectIntegerKey<Context>
implements Removable

Represents one context within a HttpdTomcatSite.

Author:

AO Industries, Inc.

See Also:

• Site

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CLASS_NAME	These are the default values for a new site.
static final boolean	DEFAULT_COOKIES
static final boolean	DEFAULT_CROSS_CONTEXT
static final int	DEFAULT_DEBUG
static final boolean	DEFAULT_OVERRIDE
static final boolean	DEFAULT_PRIVILEGED
static final boolean	DEFAULT_RELOADABLE
static final boolean	DEFAULT_SERVER_XML_CONFIGURED
static final boolean	DEFAULT_USE_NAMING
static final PosixPath	DEFAULT_WORK_DIR
static final String	DEFAULT_WRAPPER_CLASS
static final String	ROOT_DOC_BASE
static final String	ROOT_PATH	The ROOT webapp details.

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

Method Summary

Modifier and Type	Method	Description
int	addHttpdTomcatDataSource(String name, String driverClassName, String url, String username, String password, int maxActive, int maxIdle, int maxWait, String validationQuery)
int	addHttpdTomcatParameter(String name, String value, boolean override, String description)
boolean	allowCrossContext()
boolean	allowOverride()
List<CannotRemoveReason<Context>>	getCannotRemoveReasons()	Lists the reasons an object may not be removed.
String	getClassName()
protected Object	getColumnImpl(int i)
int	getDebugLevel()
PosixPath	getDocBase()
ContextDataSource	getHttpdTomcatDataSource(String name)
List<ContextDataSource>	getHttpdTomcatDataSources()
ContextParameter	getHttpdTomcatParameter(String name)
List<ContextParameter>	getHttpdTomcatParameters()
Site	getHttpdTomcatSite()
int	getHttpdTomcatSite_httpdSite_id()
String	getPath()
Table.TableId	getTableId()
PosixPath	getWorkDir()
String	getWrapperClass()
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isPrivileged()
boolean	isReloadable()
boolean	isServerXmlConfigured()
static boolean	isValidDocBase(PosixPath docBase)
static boolean	isValidPath(String path)
static boolean	isValidWorkDir(PosixPath workDir)
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	remove()	Removes this object, and all dependant objects, from the system.
void	setAttributes(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)
boolean	useCookies()
boolean	useNaming()
void	write(StreamableOutput out, AoservProtocol.Version protocolVersion)

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

equals, getKey, getPkey, hashCode, toStringImpl

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

DEFAULT_CLASS_NAME

public static final String DEFAULT_CLASS_NAME

These are the default values for a new site.

DEFAULT_COOKIES

public static final boolean DEFAULT_COOKIES

See Also:

• Constant Field Values

DEFAULT_CROSS_CONTEXT

public static final boolean DEFAULT_CROSS_CONTEXT

See Also:

• Constant Field Values

DEFAULT_OVERRIDE

public static final boolean DEFAULT_OVERRIDE

See Also:

• Constant Field Values

DEFAULT_PRIVILEGED

public static final boolean DEFAULT_PRIVILEGED

See Also:

• Constant Field Values

DEFAULT_RELOADABLE

public static final boolean DEFAULT_RELOADABLE

See Also:

• Constant Field Values

DEFAULT_USE_NAMING

public static final boolean DEFAULT_USE_NAMING

See Also:

• Constant Field Values

DEFAULT_WRAPPER_CLASS

public static final String DEFAULT_WRAPPER_CLASS

DEFAULT_DEBUG

public static final int DEFAULT_DEBUG

See Also:

• Constant Field Values

DEFAULT_WORK_DIR

public static final PosixPath DEFAULT_WORK_DIR

DEFAULT_SERVER_XML_CONFIGURED

public static final boolean DEFAULT_SERVER_XML_CONFIGURED

See Also:

• Constant Field Values

ROOT_PATH

public static final String ROOT_PATH

The ROOT webapp details.

See Also:

• Constant Field Values

ROOT_DOC_BASE

public static final String ROOT_DOC_BASE

See Also:

• Constant Field Values

Constructor Details

Context

@Deprecated
public Context()

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

addHttpdTomcatDataSource

public int addHttpdTomcatDataSource(String name,
 String driverClassName,
 String url,
 String username,
 String password,
 int maxActive,
 int maxIdle,
 int maxWait,
 String validationQuery)
                             throws IOException,
SQLException

Throws:

IOException

SQLException

addHttpdTomcatParameter

public int addHttpdTomcatParameter(String name,
 String value,
 boolean override,
 String description)
                            throws IOException,
SQLException

Throws:

IOException

SQLException

getCannotRemoveReasons

public List<CannotRemoveReason<Context>> 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

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,Context>

getHttpdTomcatSite_httpdSite_id

public int getHttpdTomcatSite_httpdSite_id()

getHttpdTomcatSite

public Site getHttpdTomcatSite()
                        throws SQLException,
IOException

Throws:

SQLException

IOException

getClassName

public String getClassName()

useCookies

public boolean useCookies()

allowCrossContext

public boolean allowCrossContext()

getDocBase

public PosixPath getDocBase()

allowOverride

public boolean allowOverride()

getPath

public String getPath()

isPrivileged

public boolean isPrivileged()

isReloadable

public boolean isReloadable()

useNaming

public boolean useNaming()

getWrapperClass

public String getWrapperClass()

getDebugLevel

public int getDebugLevel()

getWorkDir

public PosixPath getWorkDir()

isServerXmlConfigured

public boolean isServerXmlConfigured()

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,Context>

getHttpdTomcatDataSources

public List<ContextDataSource> getHttpdTomcatDataSources()
                                                  throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdTomcatDataSource

public ContextDataSource getHttpdTomcatDataSource(String name)
                                           throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdTomcatParameters

public List<ContextParameter> getHttpdTomcatParameters()
                                                throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdTomcatParameter

public ContextParameter getHttpdTomcatParameter(String name)
                                         throws IOException,
SQLException

Throws:

IOException

SQLException

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

Parameters:

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

Throws:

SQLException

isValidDocBase

public static boolean isValidDocBase(PosixPath docBase)

isValidPath

public static boolean isValidPath(String path)

isValidWorkDir

public static boolean isValidWorkDir(PosixPath workDir)

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

Throws:

IOException

setAttributes

public void setAttributes(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

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

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

Throws:

IOException