Module com.aoindustries.aoserv.client

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

Class SharedTomcat

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.web.tomcat.SharedTomcat

All Implemented Interfaces:

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

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

An HttpdSharedTomcat stores configuration information about the Jakarta Tomcat JVM under which run one or more HttpdTomcatSharedSites.

Author:

AO Industries, Inc.

See Also:

• SharedTomcatSite
• Site

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_MAX_PARAMETER_COUNT	The default setting of maxParameterCount on the <Connector /> in server.xml.
static final int	DEFAULT_MAX_POST_SIZE	The default setting of maxPostSize on the <Connector /> in server.xml.
static final String	DEFAULT_TOMCAT_VERSION_PREFIX
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
SharedTomcat()	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
boolean	canDisable()
boolean	canEnable()
void	disable(DisableLog dl)
void	enable()
boolean	getAutoDeploy()	Gets the autoDeploy setting for this Tomcat.
List<CannotRemoveReason<SharedTomcatSite>>	getCannotRemoveReasons()	Lists the reasons an object may not be removed.
protected Object	getColumnImpl(int i)
DisableLog	getDisableLog()
List<SharedTomcatSite>	getHttpdTomcatSharedSites()
Version	getHttpdTomcatVersion()
PosixPath	getInstallDirectory()
Server	getLinuxServer()
UserServer	getLinuxServerAccount()
int	getLinuxServerAccount_pkey()
GroupServer	getLinuxServerGroup()
int	getLinuxServerGroup_pkey()
int	getMaxParameterCount()	Gets the maxParameterCount or -1 if not limited.
int	getMaxPostSize()	Gets the maxPostSize or -1 if not limited.
String	getName()
Table.TableId	getTableId()
String	getTomcat4ShutdownKey()
Bind	getTomcat4ShutdownPort()
Worker	getTomcat4Worker()
boolean	getTomcatAuthentication()	Gets the tomcatAuthentication setting for this Tomcat.
boolean	getUndeployOldVersions()	Gets the undeployOldVersions setting for this Tomcat.
boolean	getUnpackWars()	Gets the unpackWars setting for this Tomcat.
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isDisabled()	Checks if this object is disabled.
boolean	isManual()
static boolean	isValidSharedTomcatName(String name)	Checks the format of the name of the shared Tomcat, as used in the /wwwgroup directory.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)	readImpl method comment.
void	remove()	Removes this object, and all dependant objects, from the system.
void	setAutoDeploy(boolean autoDeploy)
void	setHttpdTomcatVersion(Version version)
void	setIsManual(boolean isManual)
void	setMaxParameterCount(int maxParameterCount)
void	setMaxPostSize(int maxPostSize)
void	setTomcatAuthentication(boolean tomcatAuthentication)
void	setUndeployOldVersions(boolean undeployOldVersions)
void	setUnpackWars(boolean unpackWars)
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

DEFAULT_MAX_PARAMETER_COUNT

public static final int DEFAULT_MAX_PARAMETER_COUNT

The default setting of maxParameterCount on the <Connector /> in server.xml. This matches the default of 1000 since Tomcat 8.5.88, 9.0.74, 10.1.8. Previously, the default was 10000.

See Also:

• getMaxParameterCount()
• Constant Field Values

DEFAULT_MAX_POST_SIZE

public static final int DEFAULT_MAX_POST_SIZE

The default setting of maxPostSize on the <Connector /> in server.xml. This raises the value from the Tomcat default of 2 MiB to a more real-world value, such as allowing uploads of pictures from modern digital cameras.

See Also:

• getMaxPostSize()
• Constant Field Values

MAX_NAME_LENGTH

public static final int MAX_NAME_LENGTH

See Also:

• Constant Field Values

DEFAULT_TOMCAT_VERSION_PREFIX

public static final String DEFAULT_TOMCAT_VERSION_PREFIX

See Also:

• Constant Field Values

Constructor Details

SharedTomcat

@Deprecated(forRemoval=true)
public SharedTomcat()

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

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

getCannotRemoveReasons

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

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

Throws:

SQLException

IOException

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,SharedTomcat>

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

getDisableLog

public DisableLog getDisableLog()
                         throws SQLException,
IOException

Specified by:

getDisableLog in interface Disablable

Throws:

SQLException

IOException

getHttpdTomcatSharedSites

public List<SharedTomcatSite> getHttpdTomcatSharedSites()
                                                 throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdTomcatVersion

public Version getHttpdTomcatVersion()
                              throws SQLException,
IOException

Throws:

SQLException

IOException

setHttpdTomcatVersion

public void setHttpdTomcatVersion(Version version)
                           throws IOException,
SQLException

Throws:

IOException

SQLException

getLinuxServerAccount_pkey

public int getLinuxServerAccount_pkey()

getLinuxServerAccount

public UserServer getLinuxServerAccount()
                                 throws SQLException,
IOException

Throws:

SQLException

IOException

getLinuxServerGroup_pkey

public int getLinuxServerGroup_pkey()

getLinuxServerGroup

public GroupServer getLinuxServerGroup()
                                throws SQLException,
IOException

Throws:

SQLException

IOException

getName

public String getName()

getLinuxServer

public Server getLinuxServer()
                      throws SQLException,
IOException

Throws:

SQLException

IOException

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,SharedTomcat>

getTomcat4Worker

public Worker getTomcat4Worker()
                        throws SQLException,
IOException

Throws:

SQLException

IOException

getTomcat4ShutdownKey

public String getTomcat4ShutdownKey()

getTomcat4ShutdownPort

public Bind getTomcat4ShutdownPort()
                            throws IOException,
SQLException

Throws:

IOException

SQLException

isManual

public boolean isManual()

setIsManual

public void setIsManual(boolean isManual)
                 throws IOException,
SQLException

Throws:

IOException

SQLException

getMaxParameterCount

public int getMaxParameterCount()

Gets the maxParameterCount or -1 if not limited.

setMaxParameterCount

public void setMaxParameterCount(int maxParameterCount)
                          throws IOException,
SQLException

Throws:

IOException

SQLException

getMaxPostSize

public int getMaxPostSize()

Gets the maxPostSize or -1 if not limited.

setMaxPostSize

public void setMaxPostSize(int maxPostSize)
                    throws IOException,
SQLException

Throws:

IOException

SQLException

getUnpackWars

public boolean getUnpackWars()

Gets the unpackWars setting for this Tomcat.

setUnpackWars

public void setUnpackWars(boolean unpackWars)
                   throws IOException,
SQLException

Throws:

IOException

SQLException

getAutoDeploy

public boolean getAutoDeploy()

Gets the autoDeploy setting for this Tomcat.

setAutoDeploy

public void setAutoDeploy(boolean autoDeploy)
                   throws IOException,
SQLException

Throws:

IOException

SQLException

getUndeployOldVersions

public boolean getUndeployOldVersions()

Gets the undeployOldVersions setting for this Tomcat.

setUndeployOldVersions

public void setUndeployOldVersions(boolean undeployOldVersions)
                            throws IOException,
SQLException

Throws:

IOException

SQLException

getTomcatAuthentication

public boolean getTomcatAuthentication()

Gets the tomcatAuthentication setting for this Tomcat.

setTomcatAuthentication

public void setTomcatAuthentication(boolean tomcatAuthentication)
                             throws IOException,
SQLException

Throws:

IOException

SQLException

isValidSharedTomcatName

public static boolean isValidSharedTomcatName(String name)

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

Note: This matches the check constraint on the httpd_shared_tomcats table. Note: This matches keepWwwgroupDirs in HttpdSharedTomcatManager.

TODO: Self-validating type (Shared site Site.Name validator, and/or PosixPortableFilename?)

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

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

readImpl method comment.

Specified by:

read in interface AoservReadable

Specified by:

read in interface AoservStreamable

Specified by:

read in class AoservObject<Integer,SharedTomcat>

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

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

Throws:

SQLException

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

Throws:

IOException