Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.net

Class Bind

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.net.Bind

All Implemented Interfaces:

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

public final class Bind
extends CachedObjectIntegerKey<Bind>
implements Removable

All listening network ports must be registered as a NetBind. The NetBind information is also used for internel server and external network monitoring. If either a network port is not listening that should, or a network port is listening that should not, monitoring personnel are notified to remove the discrepancy.

Author:

AO Industries, Inc.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLUMN_IP_ADDRESS_name
static final String	COLUMN_PORT_name
static final String	COLUMN_SERVER_name

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
Bind()	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
static URIParameters	decodeParameters(String monitoringParameters)	Decodes the parameters.
static String	encodeParameters(URIParameters monitoringParameters)	Encodes the parameters.
Server	getAoserverByDaemonNetBind()
Server	getAoserverByJilterNetBind()
AppProtocol	getAppProtocol()
String	getAppProtocol_protocol()
List<CannotRemoveReason<?>>	getCannotRemoveReasons()	Lists the reasons an object may not be removed.
protected Object	getColumnImpl(int i)
CyrusImapdBind	getCyrusImapdBind()
CyrusImapdServer	getCyrusImapdServerBySieveNetBind()
String	getDetails()
Set<FirewallZone.Name>	getFirewalldZoneNames()
List<FirewallZone>	getFirewalldZones()
Host	getHost()
HttpdBind	getHttpdBind()
Site	getHttpdJbossSiteByHypersonicPort()
Site	getHttpdJbossSiteByJmxPort()
Site	getHttpdJbossSiteByJnpPort()
Site	getHttpdJbossSiteByRmiPort()
Site	getHttpdJbossSiteByWebserverPort()
SharedTomcat	getHttpdSharedTomcatByShutdownPort()
PrivateTomcatSite	getHttpdTomcatStdSiteByShutdownPort()
Worker	getHttpdWorker()
int	getId()
IpAddress	getIpAddress()
int	getIpAddress_id()
URIParameters	getMonitoringParameters()	Gets the unmodifiable map of parameters for this bind.
Server	getMysqlServer()
List<BindFirewallZone>	getNetBindFirewalldZones()
TcpRedirect	getNetTcpRedirect()
Package	getPackage()
Account.Name	getPackage_name()
Port	getPort()
Server	getPostgresServer()
PrivateServer	getPrivateFtpServer()
SendmailBind	getSendmailBind()
int	getServer_pkey()
Table.TableId	getTableId()
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isDisabled()	A net_bind is disabled when all Disablable uses of it are disabled.
boolean	isMonitoringEnabled()
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	remove()	Removes this object, and all dependant objects, from the system.
void	setFirewalldZones(Set<FirewallZone.Name> firewalldZones)
void	setMonitoringEnabled(boolean monitoringEnabled)
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_SERVER_name

public static final String COLUMN_SERVER_name

See Also:

• Constant Field Values

COLUMN_IP_ADDRESS_name

public static final String COLUMN_IP_ADDRESS_name

See Also:

• Constant Field Values

COLUMN_PORT_name

public static final String COLUMN_PORT_name

See Also:

• Constant Field Values

Constructor Details

Bind

@Deprecated(forRemoval=true)
public Bind()

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

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,Bind>

getId

public int getId()

getPackage_name

public Account.Name getPackage_name()

getPackage

public Package getPackage()
                   throws IOException,
SQLException

Throws:

IOException

SQLException

getServer_pkey

public int getServer_pkey()

getHost

public Host getHost()
             throws SQLException,
IOException

Throws:

SQLException

IOException

getIpAddress_id

public int getIpAddress_id()

getIpAddress

public IpAddress getIpAddress()
                       throws SQLException,
IOException

Throws:

SQLException

IOException

getPort

public Port getPort()

getAppProtocol_protocol

public String getAppProtocol_protocol()

getAppProtocol

public AppProtocol getAppProtocol()
                           throws SQLException,
IOException

Throws:

SQLException

IOException

isMonitoringEnabled

public boolean isMonitoringEnabled()

getMonitoringParameters

public URIParameters getMonitoringParameters()

Gets the unmodifiable map of parameters for this bind.

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

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

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

Throws:

IOException

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,Bind>

toStringImpl

public String toStringImpl()
                    throws IOException,
SQLException

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

Throws:

IOException

SQLException

getDetails

public String getDetails()
                  throws SQLException,
IOException

Throws:

SQLException

IOException

isDisabled

public boolean isDisabled()
                   throws SQLException,
IOException

A net_bind is disabled when all Disablable uses of it are disabled. If there are no Disablable uses, it is considered enabled.

Throws:

SQLException

IOException

See Also:

• Disablable

getAoserverByDaemonNetBind

public Server getAoserverByDaemonNetBind()
                                  throws IOException,
SQLException

Throws:

IOException

SQLException

getAoserverByJilterNetBind

public Server getAoserverByJilterNetBind()
                                  throws IOException,
SQLException

Throws:

IOException

SQLException

getCyrusImapdBind

public CyrusImapdBind getCyrusImapdBind()
                                 throws IOException,
SQLException

Throws:

IOException

SQLException

getCyrusImapdServerBySieveNetBind

public CyrusImapdServer getCyrusImapdServerBySieveNetBind()
                                                   throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdBind

public HttpdBind getHttpdBind()
                       throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdJbossSiteByJnpPort

public Site getHttpdJbossSiteByJnpPort()
                                throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdJbossSiteByWebserverPort

public Site getHttpdJbossSiteByWebserverPort()
                                      throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdJbossSiteByRmiPort

public Site getHttpdJbossSiteByRmiPort()
                                throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdJbossSiteByHypersonicPort

public Site getHttpdJbossSiteByHypersonicPort()
                                       throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdJbossSiteByJmxPort

public Site getHttpdJbossSiteByJmxPort()
                                throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdWorker

public Worker getHttpdWorker()
                      throws IOException,
SQLException

Throws:

IOException

SQLException

getHttpdSharedTomcatByShutdownPort

public SharedTomcat getHttpdSharedTomcatByShutdownPort()
                                                throws SQLException,
IOException

Throws:

SQLException

IOException

getHttpdTomcatStdSiteByShutdownPort

public PrivateTomcatSite getHttpdTomcatStdSiteByShutdownPort()
                                                      throws IOException,
SQLException

Throws:

IOException

SQLException

getSendmailBind

public SendmailBind getSendmailBind()
                             throws IOException,
SQLException

Throws:

IOException

SQLException

getNetBindFirewalldZones

public List<BindFirewallZone> getNetBindFirewalldZones()
                                                throws IOException,
SQLException

Throws:

IOException

SQLException

getFirewalldZones

public List<FirewallZone> getFirewalldZones()
                                     throws IOException,
SQLException

Throws:

IOException

SQLException

getFirewalldZoneNames

public Set<FirewallZone.Name> getFirewalldZoneNames()
                                             throws IOException,
SQLException

Throws:

IOException

SQLException

getNetTcpRedirect

public TcpRedirect getNetTcpRedirect()
                              throws IOException,
SQLException

Throws:

IOException

SQLException

getMysqlServer

public Server getMysqlServer()
                      throws IOException,
SQLException

Throws:

IOException

SQLException

getPostgresServer

public Server getPostgresServer()
                         throws IOException,
SQLException

Throws:

IOException

SQLException

getPrivateFtpServer

public PrivateServer getPrivateFtpServer()
                                  throws IOException,
SQLException

Throws:

IOException

SQLException

encodeParameters

public static String encodeParameters(URIParameters monitoringParameters)

Encodes the parameters. Will not return null.

decodeParameters

public static URIParameters decodeParameters(String monitoringParameters)

Decodes the parameters.

getCannotRemoveReasons

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

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:

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

setMonitoringEnabled

public void setMonitoringEnabled(boolean monitoringEnabled)
                          throws IOException,
SQLException

Throws:

IOException

SQLException

setFirewalldZones

public void setFirewalldZones(Set<FirewallZone.Name> firewalldZones)
                       throws IOException,
SQLException

Throws:

IOException

SQLException