Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.net

Class Device

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.net.Device

All Implemented Interfaces:

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

public final class Device
extends CachedObjectIntegerKey<Device>

Each server has multiple network devices, each listening on different IP addresses.

Author:

AO Industries, Inc.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLUMN_DEVICE_ID_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
Device()	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
String	getBondingReport()	Gets the bonding report from /proc/net/bonding/[p]bond# or null if not a bonded device.
InetAddress	getBroadcast()
protected Object	getColumnImpl(int i)
String	getDeleteRoute()
String	getDescription()
DeviceId	getDeviceId()
String	getDeviceId_name()
InetAddress	getGateway()
Host	getHost()
int	getId()
IpAddress	getIpAddress(InetAddress inetAddress)
List<IpAddress>	getIpAddresses()
MacAddress	getMacAddress()
long	getMaxBitRate()	Gets the maximum bit rate this interface can support or -1 if unknown.
long	getMonitoringBitRateCritical()	Gets the 5-minute average that is considered a critical-priority alert or -1 if no alert allowed at this level.
long	getMonitoringBitRateHigh()	Gets the 5-minute average that is considered a high-priority alert or -1 if no alert allowed at this level.
long	getMonitoringBitRateLow()	Gets the 5-minute average that is considered a low-priority alert or -1 if no alert allowed at this level.
long	getMonitoringBitRateMedium()	Gets the 5-minute average that is considered a medium-priority alert or -1 if no alert allowed at this level.
InetAddress	getNetwork()
IpAddress	getPrimaryIpAddress()
int	getServer_pkey()
String	getStatisticsReport()	Gets the report from /sys/class/net/device/statistics/... or null if not a Server.
Table.TableId	getTableId()
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isMonitoringEnabled()	The monitoring of a net_devices may be enabled or disabled.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
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_DEVICE_ID_name

public static final String COLUMN_DEVICE_ID_name

See Also:

• Constant Field Values

Constructor Details

Device

@Deprecated(forRemoval=true)
public Device()

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

getId

public int getId()

getServer_pkey

public int getServer_pkey()

getHost

public Host getHost()
             throws SQLException,
IOException

Throws:

SQLException

IOException

getDeviceId_name

public String getDeviceId_name()

getDeviceId

public DeviceId getDeviceId()
                     throws SQLException,
IOException

Throws:

SQLException

IOException

getDescription

public String getDescription()

getDeleteRoute

public String getDeleteRoute()

getGateway

public InetAddress getGateway()

getNetwork

public InetAddress getNetwork()

getBroadcast

public InetAddress getBroadcast()

getMacAddress

public MacAddress getMacAddress()

getMaxBitRate

public long getMaxBitRate()

Gets the maximum bit rate this interface can support or -1 if unknown.

getMonitoringBitRateLow

public long getMonitoringBitRateLow()

Gets the 5-minute average that is considered a low-priority alert or -1 if no alert allowed at this level.

getMonitoringBitRateMedium

public long getMonitoringBitRateMedium()

Gets the 5-minute average that is considered a medium-priority alert or -1 if no alert allowed at this level.

getMonitoringBitRateHigh

public long getMonitoringBitRateHigh()

Gets the 5-minute average that is considered a high-priority alert or -1 if no alert allowed at this level.

getMonitoringBitRateCritical

public long getMonitoringBitRateCritical()

Gets the 5-minute average that is considered a critical-priority alert or -1 if no alert allowed at this level. This is the level that will alert people 24x7.

isMonitoringEnabled

public boolean isMonitoringEnabled()

The monitoring of a net_devices may be enabled or disabled.

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

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

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

Throws:

IOException

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,Device>

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

Throws:

SQLException

IOException

getIpAddress

public IpAddress getIpAddress(InetAddress inetAddress)
                       throws IOException,
SQLException

Throws:

IOException

SQLException

getIpAddresses

public List<IpAddress> getIpAddresses()
                               throws IOException,
SQLException

Throws:

IOException

SQLException

getPrimaryIpAddress

public IpAddress getPrimaryIpAddress()
                              throws SQLException,
IOException

Throws:

SQLException

IOException

getBondingReport

public String getBondingReport()
                        throws IOException,
SQLException

Gets the bonding report from /proc/net/bonding/[p]bond# or null if not a bonded device.

Throws:

IOException

SQLException

getStatisticsReport

public String getStatisticsReport()
                           throws IOException,
SQLException

Gets the report from /sys/class/net/device/statistics/... or null if not a Server.

Throws:

IOException

SQLException